jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: refresh telemetry page (#9272)

Browse source 
* add-desktop-field-and-remove-notion-artifacts

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* stash

* populate-empty-headings

* clarity

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
Co-authored-by: April M <april.murphy@datastax.com>
This commit is contained in:
Mendon Kissling 2025-08-01 09:32:03 -04:00 • committed by GitHub
commit 212362f3e6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 33 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/docs/Contributing/contributing-telemetry.mdx
View file

@ -3,47 +3,66 @@ title: Telemetry
slug: /contributing-telemetry
---
Langflow uses anonymous telemetry to collect essential usage statistics to enhance functionality and the user experience. This data helps us identify popular features and areas that need improvement, and ensures development efforts align with what you need.
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.
We respect your privacy and are committed to protecting your data. We don't collect any personal information or sensitive data. All telemetry data is anonymized and used solely for improving Langflow.
## 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 the `LANGFLOW_DO_NOT_TRACK` or `DO_NOT_TRACK` environment variable to `true` before running Langflow. This disables telemetry data collection.
To opt out of telemetry, set the `LANGFLOW_DO_NOT_TRACK` or `DO_NOT_TRACK` environment variable to `true` before running Langflow. This disables telemetry data collection.
## Data that Langflow collects
### Run {#2d427dca4f0148ae867997f6789e8bfb}
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 {#081e4bd4faec430fb05b657026d1a69c}
### Shutdown
- **Time Running**: Total runtime before shutdown, useful for understanding application lifecycle and optimizing uptime.
This telemetry event captures information about application lifecycle and runtime duration.
### Version {#dc09f6aba6c64c7b8dad3d86a7cba6d6}
- **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 aids in focusing our support for popular platforms like Windows, macOS, and Linux.
- **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 (e.g., x86, ARM), which helps optimize our software for different hardware.
- **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 you are running Langflow in a backend-only mode, useful for understanding deployment configurations.
- **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.
### Playground {#ae6c3859f612441db3c15a7155e9f920}
### 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 {#630728d6654c40a6b8901459a4bc3a4e}
### 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.
- **ErrorMessage**: Details of any errors encountered, crucial for debugging and improvement.