Error telemetry
Otterize OSS components report anonymous error telemetry that allows us to proactively identify and address issues. No personal or organizational identifying information is transmitted in these metrics: The information reported is limited to essential details necessary for effective issue resolution. You may opt out at any time through a single configuration flag.
What information is collected?
Each error event includes error type, relevant code lines from the stack trace, and metadata on the OSS component instance identifiers, detailed in the table below. The error reporting is implemented using the Bugsnag error handling SDK. For a comprehensive understanding of the schema used for Bugsnag error reporting, please refer to the following link: Bugsnag Error Reporting API.
Identifiers
| Identifier | Value |
|---|---|
componentType | Which Otterize OSS component sent the event: one of INTENTS_OPERATOR, CREDENTIALS_OPERATOR, NETWORK_MAPPER or CLI. |
componentInstanceId | A randomly-generated UUID identifying the installed instance of the component, to allow correlating its events. |
contextId | A hash (for anonymity) of an identifier of the context in which the component is installed. For example, for components running in a Kubernetes cluster, this is a hash of the UUID of the kube-system namespace in the cluster. |
version | The version of the Otterize OSS component. |
cloudClientId | If connected to Otterize Cloud: the client id used to connect with Otterize Cloud, to allow correlating events with Cloud usage info. |
Configuring whether to report error information
To configure whether to report error information to the Otterize team, use the telemetry.errors flag in the installation/configuration of Otterize OSS. By default, telemetry is enabled.
To disable only the sending of error information:
- Via the Otterize OSS Helm chart:
--set global.telemetry.errors.enabled=false. - Via an environment variable:
OTTERIZE_TELEMETRY_ERRORS_ENABLED=false. - If running an operator directly:
telemetry-errors-enabled=false.
To disable sending any telemetry information, including both usage information and error information:
- Via the Otterize OSS Helm chart:
--set global.telemetry.enabled=false. - Via an environment variable:
OTTERIZE_TELEMETRY_ENABLED=false. - If running an operator directly:
telemetry-enabled=false.
If the telemetry flag is omitted or set to true, telemetry will be enabled: error information will be reported.