From 5aef43254a936cf042ee832e5184f846f4b8d9e7 Mon Sep 17 00:00:00 2001 From: "omri.s" Date: Tue, 23 May 2023 19:38:16 +0300 Subject: [PATCH 1/3] CLI telemetry docs --- docs/otterize-oss/usage-telemetry.mdx | 12 +++++++++++- docs/reference/cli/README.mdx | 16 ++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/otterize-oss/usage-telemetry.mdx b/docs/otterize-oss/usage-telemetry.mdx index 657c50177..a0e519b0e 100644 --- a/docs/otterize-oss/usage-telemetry.mdx +++ b/docs/otterize-oss/usage-telemetry.mdx @@ -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? @@ -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. diff --git a/docs/reference/cli/README.mdx b/docs/reference/cli/README.mdx index 89b57ddda..27efdd5eb 100644 --- a/docs/reference/cli/README.mdx +++ b/docs/reference/cli/README.mdx @@ -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. @@ -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 From b4d56c08d3eb3b25acc268d2d1fdf761905a7f48 Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Tue, 23 May 2023 14:38:04 -0700 Subject: [PATCH 2/3] Tweaks to the CLI usage metrics doc updates. --- docs/otterize-oss/usage-telemetry.mdx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/otterize-oss/usage-telemetry.mdx b/docs/otterize-oss/usage-telemetry.mdx index a0e519b0e..d3e9a8c77 100644 --- a/docs/otterize-oss/usage-telemetry.mdx +++ b/docs/otterize-oss/usage-telemetry.mdx @@ -41,15 +41,17 @@ 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 +### CLI Commands -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. +For the CLI, the reported events correspond simply to the commands invoked. + +Most CLI commands are of the form `otterize ` where the `` is the type of object (e.g. `intents`, `clusters`) and the `` is the operation being performed. Otterize OSS telemetry for CLI commands only reports what `` and `` were used, never what specific identifier was used in the command, nor what was the response. For example, `otterize clusters get ` would report that `clusters` and `get` were used, without reporting `` 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 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`) | +| `` | The type of object on which the operation (``) is being performed. | +| `` | The operation performed on ``. | +| `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 From 723b12fab9d714d9fac9ef0cf4689b0b3cd0bfdc Mon Sep 17 00:00:00 2001 From: Uri Sarid Date: Tue, 23 May 2023 14:43:55 -0700 Subject: [PATCH 3/3] More tweaks to the CLI usage metrics doc updates, including fixing something in the documentation of the default state. --- docs/reference/cli/README.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/cli/README.mdx b/docs/reference/cli/README.mdx index 27efdd5eb..9c2661bf1 100644 --- a/docs/reference/cli/README.mdx +++ b/docs/reference/cli/README.mdx @@ -38,7 +38,7 @@ To **disable** sending usage information: 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) +For more information see the [Usage telemetry Documentation](https://docs.otterize.com/otterize-oss/usage-telemetry) ## Global options @@ -58,7 +58,7 @@ 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) | +| `--telemetry-enabled` | true | Whether to enable sending of anonymous usage telemetry to Otterize or not. | ## Network mapper