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.

Sign up for GitHub

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

Jump to bottom

CLI telemetry docs #88

Merged
merged 3 commits into from
May 24, 2023
Merged

CLI telemetry docs #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5aef432
CLI telemetry docs
omris94 May 23, 2023
b4d56c0
Tweaks to the CLI usage metrics doc updates.
usarid May 23, 2023
723b12f
More tweaks to the CLI usage metrics doc updates, including fixing so…
usarid May 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/otterize-oss/usage-telemetry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Usage telemetry
---

Operators in Otterize OSS report anonymous usage information back to the Otterize team, to help the team understand how the software is used in the community and what aspects users find useful. No personal or organizational identifying information is transmitted in these metrics: they only reflect patterns of usage. You may opt out at any time through a single configuration flag.
Otterize OSS components report anonymous usage information back to the Otterize team, to help the team understand how the software is used in the community and what aspects users find useful. No personal or organizational identifying information is transmitted in these metrics: they only reflect patterns of usage. You may opt out at any time through a single configuration flag.

## What information is collected?

Expand Down Expand Up @@ -41,6 +41,18 @@ The information reported by Otterize OSS is defined in the [GraphQL schema of th
| `ISTIO_POLICIES_DELETED` | How many Istio authorization policies were deleted by the intents operator. |
| `STARTED` | The operator was started. |

### CLI Commands

For the CLI, the reported events correspond simply to the commands invoked.

Most CLI commands are of the form `otterize <noun> <verb>` where the `<noun>` is the type of object (e.g. `intents`, `clusters`) and the `<verb>` is the operation being performed. Otterize OSS telemetry for CLI commands only reports what `<noun>` and `<verb>` were used, never what specific identifier was used in the command, nor what was the response. For example, `otterize clusters get <cluster-id>` would report that `clusters` and `get` were used, without reporting `<cluster-id>` nor the response about that cluster. In some cases, modifiers are also reported, to clarify which specific action was taken.

| Field | Meaning |
|:----------------------------------|:-----------------------------------------------------------------------------------------------------|
| `<noun>` | The type of object on which the operation (`<verb>`) is being performed. |
| `<verb>` | The operation performed on `<noun>`. |
| `MODIFIERS` | If applicable, a list of modifiers to clarify the specific operation. For example, `otterize env update add-labels` would report `add-labels` as the modifier. |

## Configuring whether to report usage information

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.
Expand Down
16 changes: 16 additions & 0 deletions docs/reference/cli/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,20 @@ easy to access on the fly.

`otterize completion` offers instruction for generating command completions in various shells.


## Usage Telemetry

The CLI reports anonymous usage information back to the Otterize team, to help the team understand how the software is used in the community and what aspects users find useful. No personal or organizational identifying information is transmitted in these metrics: they only reflect patterns of usage. You may opt out at any time through a single configuration flag.

To **disable** sending usage information:
- Using a flag: `--telemetry-enabled=false`.
- Via an environment variable: `OTTERIZE_TELEMETRY_ENABLED=false`.

If the `telemetry` flag is omitted or set to `true`, telemetry will be enabled: usage information will be reported.

For more information see the [Usage telemetry Documentation](https://docs.otterize.com/otterize-oss/usage-telemetry)


## Global options

The following options apply to all CLI commands.
Expand All @@ -44,6 +58,8 @@ The following options apply to all CLI commands.
| `--output` | text | Output the results of the command as text (`text`) or JSON (`json`). |
| `-q` or `--quiet` | | Suppress printing the results of the command. |
| `--token` | | The token to use in authenticating API calls. |
| `--telemetry-enabled` | true | Whether to enable sending of anonymous usage telemetry to Otterize or not. |


## Network mapper

Expand Down