From db6a04a22abdeb9ed180ac7897f4ad3fa2969e05 Mon Sep 17 00:00:00 2001 From: omris94 <46892443+omris94@users.noreply.github.com> Date: Thu, 4 May 2023 16:55:28 +0300 Subject: [PATCH] Add usage telemetry to README.md (#101) --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 53a51d91..fecd097a 100644 --- a/README.md +++ b/README.md @@ -138,3 +138,15 @@ Explore our [documentation](https://docs.otterize.com/) site to learn how to: To join the conversation, ask questions, and engage with other users, join the Otterize Slack! [![button](https://i.ibb.co/vwRP6xK/Group-3090-2.png)](https://joinslack.otterize.com) + +## Usage telemetry +The mapper 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: +- Via the Otterize OSS Helm chart: `--set global.telemetry.enabled=false`. +- Via an environment variable: `OTTERIZE_TELEMETRY_ENABLED=false`. +- If running a mapper directly: `--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)