Tweaks to the CLI usage metrics doc updates.

otterize · May 23, 2023 · b4d56c0 · b4d56c0
1 parent 5aef432
commit b4d56c0
Showing 1 changed file with 7 additions and 5 deletions.
diff --git 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 <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 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`)                                             |
+| `<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