Skip to content

Commit

Permalink
CLI telemetry docs
Browse files Browse the repository at this point in the history
  • Loading branch information
omris94 committed May 23, 2023
1 parent 0471848 commit 5aef432
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/otterize-oss/usage-telemetry.mdx
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,16 @@ 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 Command

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.

| Field | Meaning |
|:----------------------------------|:-----------------------------------------------------------------------------------------------------|
| `noun` | The type of object on which the operation (`verb`) is being performed. |
| `verb` | The operation is being performed on `noun` |
| `modifiers` | A list of command modifiers for commands that won't break down nicely to `otterize NOUN VERB`. (e.g. `otterize env update add-labels`) |

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

Read more about it in 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` | | Whether to enable sending of anonymous usage telemetry to Otterize or not (default true) |


## Network mapper

Expand Down

0 comments on commit 5aef432

Please sign in to comment.