From 134db5bd8edbdc7f90958cfc4983ed658875a0b6 Mon Sep 17 00:00:00 2001 From: Netanel Bollag Date: Sun, 10 Dec 2023 16:19:32 +0100 Subject: [PATCH 1/3] Add errors telemetry --- docs/otterize-oss/errors-telemetry.mdx | 37 ++++++++++++++++++++++++++ docs/otterize-oss/usage-telemetry.mdx | 7 ++++- 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 docs/otterize-oss/errors-telemetry.mdx diff --git a/docs/otterize-oss/errors-telemetry.mdx b/docs/otterize-oss/errors-telemetry.mdx new file mode 100644 index 000000000..755989822 --- /dev/null +++ b/docs/otterize-oss/errors-telemetry.mdx @@ -0,0 +1,37 @@ +--- +title: Usage telemetry +--- + +Otterize OSS components report anonymous errors 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. For a comprehensive understanding of the schema used for Bugsnag error reporting, please refer to the following link: [Bugsnag Error Reporting API](https://bugsnagerrorreportingapi.docs.apiary.io/#reference/0/notify/send-error-reports). + + +### 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 errors information + +To configure whether to report errors 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 errors 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: errors information will be reported. + diff --git a/docs/otterize-oss/usage-telemetry.mdx b/docs/otterize-oss/usage-telemetry.mdx index c1e0a6f28..3eec83b7b 100644 --- a/docs/otterize-oss/usage-telemetry.mdx +++ b/docs/otterize-oss/usage-telemetry.mdx @@ -66,7 +66,12 @@ Most CLI commands are of the form `otterize ` where the `` is To configure whether to report usage information to the Otterize team, use the `telemetry` flag in the installation/configuration of Otterize OSS. By default, telemetry is enabled. -To **disable** sending usage information: +To **disable** only the sending of usage information: + - Via the Otterize OSS Helm chart: `--set global.telemetry.usage.enabled=false`. + - Via an environment variable: `OTTERIZE_TELEMETRY_USAGE_ENABLED=false`. + - If running an operator directly: `telemetry-usage-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`. From c28c3aeb16d9227cfa3e14719d3fc89255a35ec5 Mon Sep 17 00:00:00 2001 From: Netanel Bollag Date: Sun, 10 Dec 2023 16:22:46 +0100 Subject: [PATCH 2/3] Add errors telemetry documentation --- docs/otterize-oss/errors-telemetry.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/otterize-oss/errors-telemetry.mdx b/docs/otterize-oss/errors-telemetry.mdx index 755989822..db9a3e96e 100644 --- a/docs/otterize-oss/errors-telemetry.mdx +++ b/docs/otterize-oss/errors-telemetry.mdx @@ -1,5 +1,5 @@ --- -title: Usage telemetry +title: Errors telemetry --- Otterize OSS components report anonymous errors 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. From 4fea51803890fab0ab20d998128fbc621b070fe9 Mon Sep 17 00:00:00 2001 From: Netanel Bollag Date: Sun, 10 Dec 2023 16:43:05 +0100 Subject: [PATCH 3/3] fix cr --- docs/otterize-oss/errors-telemetry.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/otterize-oss/errors-telemetry.mdx b/docs/otterize-oss/errors-telemetry.mdx index db9a3e96e..142260106 100644 --- a/docs/otterize-oss/errors-telemetry.mdx +++ b/docs/otterize-oss/errors-telemetry.mdx @@ -6,7 +6,7 @@ Otterize OSS components report anonymous errors telemetry that allows us to proa ## 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. For a comprehensive understanding of the schema used for Bugsnag error reporting, please refer to the following link: [Bugsnag Error Reporting API](https://bugsnagerrorreportingapi.docs.apiary.io/#reference/0/notify/send-error-reports). +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 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](https://bugsnagerrorreportingapi.docs.apiary.io/#reference/0/notify/send-error-reports). ### Identifiers