mirror of
https://github.com/langflow-ai/langflow.git
synced 2026-07-24 06:10:49 +08:00
71fbf5ff00
* version-1.9.0-docs * [autofix.ci] apply automated fixes * [autofix.ci] apply automated fixes (attempt 2/3) --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
93 lines
5.1 KiB
Plaintext
93 lines
5.1 KiB
Plaintext
---
|
|
title: Telemetry
|
|
slug: /contributing-telemetry
|
|
---
|
|
|
|
Langflow uses anonymous telemetry to collect statistics about feature usage and performance.
|
|
The Langflow team uses this data to identify popular features and areas that need improvement based on actual usage patterns.
|
|
This helps prioritize development efforts on the most impactful changes and popular features.
|
|
|
|
## Privacy
|
|
|
|
The Langflow team respects your privacy, and the team is committed to protecting your data.
|
|
|
|
Langflow telemetry doesn't collect any personal information or sensitive data.
|
|
All telemetry data is anonymized and used solely for improving Langflow.
|
|
|
|
## Opt out of telemetry
|
|
|
|
To opt out of telemetry, set `DO_NOT_TRACK=True` in your [Langflow environment variables](/environment-variables) before starting Langflow. This disables telemetry data collection.
|
|
|
|
## Data that Langflow collects
|
|
|
|
Langflow telemetry collects data on flow runs, your environment, and component usage.
|
|
|
|
### Run
|
|
|
|
This telemetry event is sent every time a flow is executed.
|
|
|
|
- **IsWebhook**: Indicates whether the operation was triggered with a webhook.
|
|
- **Seconds**: Duration in seconds for how long the operation lasted, providing insights into performance.
|
|
- **Success**: Boolean value indicating whether the operation was successful, helping identify potential errors or issues.
|
|
- **ErrorMessage**: Provides error message details if the operation was unsuccessful, aiding in troubleshooting and enhancements.
|
|
|
|
### Shutdown
|
|
|
|
This telemetry event captures information about application lifecycle and runtime duration.
|
|
|
|
- **TimeRunning**: Total runtime before shutdown, which is useful for understanding the application lifecycle and optimizing uptime.
|
|
|
|
### Version
|
|
|
|
This telemetry event is sent once when the telemetry service starts.
|
|
|
|
- **Version**: The specific version of Langflow used, which helps in tracking feature adoption and compatibility.
|
|
- **Platform**: Operating system of the host machine, which helps determine the most popular platforms for development and testing efforts.
|
|
- **Python**: The version of Python used, assisting in maintaining compatibility and support for various Python versions.
|
|
- **Arch**: Architecture of the system, such as x86 or ARM, which helps prioritize hardware optimization and testing in the Langflow codebase.
|
|
- **AutoLogin**: Indicates whether the auto-login feature is enabled, reflecting user preference settings.
|
|
- **CacheType**: Type of caching mechanism used, which impacts performance and efficiency.
|
|
- **BackendOnly**: Boolean indicating whether Langflow is running in backend-only mode, useful for understanding deployment configurations.
|
|
- **Desktop**: Indicates whether Langflow is running in desktop mode (Langflow Desktop), helping to understand usage patterns across different deployment types.
|
|
|
|
### Email
|
|
|
|
This telemetry event is sent to track registered email addresses for Langflow Desktop. The event is triggered in two cases:
|
|
|
|
* Every time a new email address is registered through the POST `/api/v2/registration/` endpoint.
|
|
* Each time you start Langflow Desktop _after_ an email address is registered.
|
|
|
|
The first time you start Langflow Desktop and register your email address, the event is reported by the call to the POST `/api/v2/registration/` endpoint.
|
|
|
|
This telemetry event includes the following information:
|
|
|
|
- **Email**: The registered email address, which helps track user registrations and facilitate an understanding of the Langflow Desktop user base.
|
|
- **ClientType**: Indicates the client type, which can be "desktop" or "oss".
|
|
|
|
If telemetry is disabled with the `DO_NOT_TRACK` environment variable in Langflow Desktop, you are still prompted to enter your email address, but the email address is stored in your local Langflow database only.
|
|
|
|
### Playground
|
|
|
|
This telemetry event monitors performance and usage patterns in the **Playground** environment.
|
|
|
|
- **Seconds**: Duration in seconds for **Playground** execution, offering insights into performance during testing or experimental stages.
|
|
- **ComponentCount**: Number of components used in the **Playground**, which helps understand complexity and usage patterns.
|
|
- **Success**: Success status of the **Playground** operation, aiding in identifying the stability of experimental features.
|
|
|
|
### Component
|
|
|
|
This telemetry event is sent for each component execution.
|
|
|
|
- **Name**: Identifies the component, providing data on which components are most utilized or prone to issues.
|
|
- **Seconds**: Time taken by the component to execute, offering performance metrics.
|
|
- **Success**: Whether the component operated successfully, which helps in quality control.
|
|
- **ErrorMessage**: Details of any errors encountered, crucial for debugging and improvement.
|
|
|
|
### Exception
|
|
|
|
This telemetry event is sent when an unhandled exception is captured by Langflow's lifecycle or global exception handler.
|
|
|
|
- **Type**: The exception class name, such as `ValueError`.
|
|
- **Message**: The exception message that was raised.
|
|
- **Context**: Additional contextual information related to where the exception occurred, such as route, component, or operation details, when available.
|
|
- **StackTraceHash**: A hash of the stack trace used to group similar exceptions for easier analysis. |