Skip to content

Commit d1eb8a3

Browse files
committed
docs-add-telemetry-for-deployments-endpoints
1 parent 3f2d2fc commit d1eb8a3

2 files changed

Lines changed: 46 additions & 2 deletions

File tree

docs/docs/Develop/contributing-telemetry.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,26 @@ This telemetry event is sent when an unhandled exception is captured by Langflow
9090
- **Type**: The exception class name, such as `ValueError`.
9191
- **Message**: The exception message that was raised.
9292
- **Context**: Additional contextual information related to where the exception occurred, such as route, component, or operation details, when available.
93-
- **StackTraceHash**: A hash of the stack trace used to group similar exceptions for easier analysis.
93+
- **StackTraceHash**: A hash of the stack trace used to group similar exceptions for easier analysis.
94+
95+
### Deployment provider
96+
97+
This telemetry event is sent when a deployment provider account is created or deleted.
98+
99+
- **DeploymentAction**: The specific action performed, such as `provider.create` or `provider.delete`.
100+
- **DeploymentProvider**: The deployment provider used, such as `watsonx-orchestrate`.
101+
- **DeploymentSeconds**: Duration in seconds for the operation, providing performance insights.
102+
- **DeploymentSuccess**: Boolean value indicating whether the operation was successful.
103+
- **DeploymentErrorMessage**: Error message details if the operation was unsuccessful.
104+
- **WxoTenantId**: An anonymized identifier for the tenant, used to understand multi-tenant usage patterns without collecting personal information.
105+
106+
### Deployment
107+
108+
This telemetry event is sent when a deployment is created.
109+
110+
- **DeploymentAction**: The specific action performed, such as `deployment.create`.
111+
- **DeploymentProvider**: The deployment provider used, such as `watsonx-orchestrate`.
112+
- **DeploymentSeconds**: Duration in seconds for the operation, providing performance insights.
113+
- **DeploymentSuccess**: Boolean value indicating whether the operation was successful.
114+
- **DeploymentErrorMessage**: Error message details if the operation was unsuccessful.
115+
- **WxoTenantId**: An anonymized identifier for the tenant, used to understand multi-tenant usage patterns without collecting personal information.

docs/versioned_docs/version-1.9.0/Develop/contributing-telemetry.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,26 @@ This telemetry event is sent when an unhandled exception is captured by Langflow
9090
- **Type**: The exception class name, such as `ValueError`.
9191
- **Message**: The exception message that was raised.
9292
- **Context**: Additional contextual information related to where the exception occurred, such as route, component, or operation details, when available.
93-
- **StackTraceHash**: A hash of the stack trace used to group similar exceptions for easier analysis.
93+
- **StackTraceHash**: A hash of the stack trace used to group similar exceptions for easier analysis.
94+
95+
### Deployment provider
96+
97+
This telemetry event is sent when a deployment provider account is created or deleted.
98+
99+
- **DeploymentAction**: The specific action performed, such as `provider.create` or `provider.delete`.
100+
- **DeploymentProvider**: The deployment provider used, such as `watsonx-orchestrate`.
101+
- **DeploymentSeconds**: Duration in seconds for the operation, providing performance insights.
102+
- **DeploymentSuccess**: Boolean value indicating whether the operation was successful.
103+
- **DeploymentErrorMessage**: Error message details if the operation was unsuccessful.
104+
- **WxoTenantId**: An anonymized identifier for the tenant, used to understand multi-tenant usage patterns without collecting personal information.
105+
106+
### Deployment
107+
108+
This telemetry event is sent when a deployment is created.
109+
110+
- **DeploymentAction**: The specific action performed, such as `deployment.create`.
111+
- **DeploymentProvider**: The deployment provider used, such as `watsonx-orchestrate`.
112+
- **DeploymentSeconds**: Duration in seconds for the operation, providing performance insights.
113+
- **DeploymentSuccess**: Boolean value indicating whether the operation was successful.
114+
- **DeploymentErrorMessage**: Error message details if the operation was unsuccessful.
115+
- **WxoTenantId**: An anonymized identifier for the tenant, used to understand multi-tenant usage patterns without collecting personal information.

0 commit comments

Comments
 (0)