Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add errors telemetry to docs #178

Merged
merged 3 commits into from
Dec 10, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/otterize-oss/errors-telemetry.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
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.

## 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).
NetanelBollag marked this conversation as resolved.
Show resolved Hide resolved


### 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.

7 changes: 6 additions & 1 deletion docs/otterize-oss/usage-telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,12 @@ Most CLI commands are of the form `otterize <noun> <verb>` where the `<noun>` 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`.
Expand Down
Loading