From c9ee6977c5e63d65a0f6feff95aa6a936be52aa3 Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Tue, 16 Aug 2022 12:12:17 +0200 Subject: [PATCH 1/5] Docs: document how usage statistics tracking work Signed-off-by: Marco Pracucci --- ...ut-anonymous-usage-statistics-reporting.md | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md diff --git a/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md new file mode 100644 index 00000000000..18d826c911c --- /dev/null +++ b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md @@ -0,0 +1,62 @@ +--- +description: Learn about Grafana Mimir anonymous usage statistics reporting +menuTitle: About anonymous usage statistics reporting +title: About Grafana Mimir anonymous usage statistics reporting +weight: 30 +--- + +# About Grafana Mimir anonymous usage statistics reporting + +Grafana Mimir includes a system to anonymously report non-sensitive and non-personal identifiable information about the running Mimir cluster to a remote statistics server. +Mimir maintainers use these anonymous information to learn more about how the opensource community runs Mimir and what the Mimir team should focus on when working on the next features and documentation improvements. + +The anonymous usage statistics reporting is **disabled by default**. +If possible, we ask you to enable the usage statistics. + +## The statistics server + +When the usage statistics reporting is enabled, the information is collected by a server run by Grafana Labs and exposed at `https://stats.grafana.org`. + +## Which information is collected + +When the usage statistics reporting is enabled, Grafana Mimir collects the following information: + +- Information about the **Mimir cluster and version** + - Unique randomly-generated Mimir cluster identifier (e.g. `3749b5e2-b727-4107-95ae-172abac27496`). + - Timestamp when the anonymous usage statistics reporting was enabled the first time and the cluster identifier was created. + - The Mimir version (e.g. `2.3.0`). + - The Mimir branch, revision and golang version used to build the binary. +- Information about the **environment** where Mimir is running + - The operating system (e.g. `linux`) and architecture (e.g. `amd64`) where Mimir is running. + - The Mimir memory utilization and number of goroutines. + - The number of logical CPU cores available to the Mimir process. +- Information about the Mimir **configuration** + - The `-target` parameter value (e.g. `all` when running Mimir in monolithic mode). + - The `-blocks-storage.backend` value (e.g. `s3`). + - The `-ingester.ring.replication-factor` value (e.g. `3`). +- Information about the Mimir **cluster scale** + - Ingester: + - The number of inmemory series. + - The number of tenants having inmemory series. + - The number of samples and exemplars ingested. + - Querier: + - The number of requests to queriers, split by API endpoint type (no information is tracked about the actual request or query). The following endpoints are tracked: + - Remote read. + - Instant query. + - Range query. + - Exemplars query. + - Labels query. + - Series query. + - Metadata query. + - Cardinality analysis query. + +> **Note**: Mimir maintainers commit to keep the list of tracked information updated over time and report any change both in the CHANGELOG and release notes. + +## How to enable the anonymous usage statistics reporting + +If you would like to participate in usage statistics reporting, the feature can be enabled setting the CLI flag `-usage-stats.enabled=true` or the following YAML configuration: + +```yaml +usage_stats: + enabled: true +``` From 8715250bb4987dece61cf248ff689930b020cff1 Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Tue, 16 Aug 2022 12:13:24 +0200 Subject: [PATCH 2/5] Add PR number to CHANGELOG Signed-off-by: Marco Pracucci --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1cb0b66ec50..7b1e4618cf1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ * [CHANGE] Distributor: if forwarding rules are used to forward samples, exemplars are now removed from the request. #2710 #2725 * [CHANGE] Limits: change the default value of `max_global_series_per_metric` limit to `0` (disabled). Setting this limit by default does not provide much benefit because series are sharded by all labels. #2714 -* [FEATURE] Introduced an experimental anonymous usage statistics tracking (disabled by default), to help Mimir maintainers driving better decisions to support the opensource community. The tracking system anonymously collects non-sensitive and non-personal identifiable information about the running Mimir cluster, and is disabled by default. #2643 #2662 #2685 #2732 +* [FEATURE] Introduced an experimental anonymous usage statistics tracking (disabled by default), to help Mimir maintainers driving better decisions to support the opensource community. The tracking system anonymously collects non-sensitive and non-personal identifiable information about the running Mimir cluster, and is disabled by default. #2643 #2662 #2685 #2732 #2733 * [ENHANCEMENT] Distributor: Add `cortex_distributor_query_ingester_chunks_deduped_total` and `cortex_distributor_query_ingester_chunks_total` metrics for determining how effective ingester chunk deduplication at query time is. #2713 * [ENHANCEMENT] Upgrade Docker base images to `alpine:3.16.2`. #2729 * [BUGFIX] Fix reporting of tracing spans from PromQL engine. #2707 From 8ae9610fe442470b303ac2b79dafe280a94bfd4c Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Fri, 26 Aug 2022 09:28:59 +0200 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Ursula Kallio --- CHANGELOG.md | 2 +- ...ut-anonymous-usage-statistics-reporting.md | 35 ++++++++++--------- 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b1e4618cf1..bb4a06c62e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ * [CHANGE] Distributor: if forwarding rules are used to forward samples, exemplars are now removed from the request. #2710 #2725 * [CHANGE] Limits: change the default value of `max_global_series_per_metric` limit to `0` (disabled). Setting this limit by default does not provide much benefit because series are sharded by all labels. #2714 -* [FEATURE] Introduced an experimental anonymous usage statistics tracking (disabled by default), to help Mimir maintainers driving better decisions to support the opensource community. The tracking system anonymously collects non-sensitive and non-personal identifiable information about the running Mimir cluster, and is disabled by default. #2643 #2662 #2685 #2732 #2733 +* [FEATURE] Introduced an experimental anonymous usage statistics tracking (disabled by default), to help Mimir maintainers make better decisions to support the open source community. The tracking system anonymously collects non-sensitive, non-personally identifiable information about the running Mimir cluster, and is disabled by default. #2643 #2662 #2685 #2732 #2733 * [ENHANCEMENT] Distributor: Add `cortex_distributor_query_ingester_chunks_deduped_total` and `cortex_distributor_query_ingester_chunks_total` metrics for determining how effective ingester chunk deduplication at query time is. #2713 * [ENHANCEMENT] Upgrade Docker base images to `alpine:3.16.2`. #2729 * [BUGFIX] Fix reporting of tracing spans from PromQL engine. #2707 diff --git a/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md index 18d826c911c..e58f15ed03f 100644 --- a/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md +++ b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md @@ -7,11 +7,11 @@ weight: 30 # About Grafana Mimir anonymous usage statistics reporting -Grafana Mimir includes a system to anonymously report non-sensitive and non-personal identifiable information about the running Mimir cluster to a remote statistics server. -Mimir maintainers use these anonymous information to learn more about how the opensource community runs Mimir and what the Mimir team should focus on when working on the next features and documentation improvements. +Grafana Mimir includes a system that optionally and anonymously reports non-sensitive, non-personally identifiable information about the running Mimir cluster to a remote statistics server. +Mimir maintainers use this anonymous information to learn more about how the open source community runs Mimir and what the Mimir team should focus on when working on the next features and documentation improvements. The anonymous usage statistics reporting is **disabled by default**. -If possible, we ask you to enable the usage statistics. +If you agree to anonymous collection of usage statistics, you can enable this feature. ## The statistics server @@ -26,21 +26,22 @@ When the usage statistics reporting is enabled, Grafana Mimir collects the follo - Timestamp when the anonymous usage statistics reporting was enabled the first time and the cluster identifier was created. - The Mimir version (e.g. `2.3.0`). - The Mimir branch, revision and golang version used to build the binary. -- Information about the **environment** where Mimir is running - - The operating system (e.g. `linux`) and architecture (e.g. `amd64`) where Mimir is running. +- Information about the **environment** where Mimir is running: + - The operating system, such as `linux`. + - The architecture, such as `amd64`. - The Mimir memory utilization and number of goroutines. - The number of logical CPU cores available to the Mimir process. -- Information about the Mimir **configuration** - - The `-target` parameter value (e.g. `all` when running Mimir in monolithic mode). - - The `-blocks-storage.backend` value (e.g. `s3`). - - The `-ingester.ring.replication-factor` value (e.g. `3`). -- Information about the Mimir **cluster scale** +- Information about the Mimir **configuration**: + - The `-target` parameter value, such as `all` when running Mimir in monolithic mode. + - The `-blocks-storage.backend` value, such as `s3`. + - The `-ingester.ring.replication-factor` value, such as `3`. +- Information about the Mimir **cluster scale**: - Ingester: - - The number of inmemory series. - - The number of tenants having inmemory series. + - The number of in-memory series. + - The number of tenants that have in-memory series. - The number of samples and exemplars ingested. - - Querier: - - The number of requests to queriers, split by API endpoint type (no information is tracked about the actual request or query). The following endpoints are tracked: + - Querier, *where no information is tracked about the actual request or query*: + - The number of requests to queriers that are split by API endpoint type: - Remote read. - Instant query. - Range query. @@ -50,11 +51,11 @@ When the usage statistics reporting is enabled, Grafana Mimir collects the follo - Metadata query. - Cardinality analysis query. -> **Note**: Mimir maintainers commit to keep the list of tracked information updated over time and report any change both in the CHANGELOG and release notes. +> **Note**: Mimir maintainers commit to keeping the list of tracked information updated over time, and reporting any change both via the CHANGELOG and the release notes. -## How to enable the anonymous usage statistics reporting +## Enable the anonymous usage statistics reporting -If you would like to participate in usage statistics reporting, the feature can be enabled setting the CLI flag `-usage-stats.enabled=true` or the following YAML configuration: +If you would like to participate in usage statistics reporting, set the CLI flag `-usage-stats.enabled=true` or change the following YAML configuration: ```yaml usage_stats: From 1ad8a6470f90009c66f4ca382490aaebed84e9cf Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Fri, 26 Aug 2022 09:30:51 +0200 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Ursula Kallio --- .../about-anonymous-usage-statistics-reporting.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md index e58f15ed03f..35f5c99e917 100644 --- a/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md +++ b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md @@ -15,17 +15,17 @@ If you agree to anonymous collection of usage statistics, you can enable this fe ## The statistics server -When the usage statistics reporting is enabled, the information is collected by a server run by Grafana Labs and exposed at `https://stats.grafana.org`. +When usage statistics reporting is enabled, information is collected by a server that Grafana Labs runs. Statistics are collected at `https://stats.grafana.org`. ## Which information is collected When the usage statistics reporting is enabled, Grafana Mimir collects the following information: -- Information about the **Mimir cluster and version** - - Unique randomly-generated Mimir cluster identifier (e.g. `3749b5e2-b727-4107-95ae-172abac27496`). - - Timestamp when the anonymous usage statistics reporting was enabled the first time and the cluster identifier was created. - - The Mimir version (e.g. `2.3.0`). - - The Mimir branch, revision and golang version used to build the binary. +- Information about the **Mimir cluster and version**: + - A unique, randomly-generated Mimir cluster identifier, such as `3749b5e2-b727-4107-95ae-172abac27496`. + - The timestamp when the anonymous usage statistics reporting was enabled for the first time, and the cluster identifier was created. + - The Mimir version, such as `2.3.0`. + - The Mimir branch, revision, and Golang version that was used to build the binary. - Information about the **environment** where Mimir is running: - The operating system, such as `linux`. - The architecture, such as `amd64`. From a9078f16d96735471283969c757dc3403249951e Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Fri, 26 Aug 2022 09:42:48 +0200 Subject: [PATCH 5/5] Update docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md --- .../configure/about-anonymous-usage-statistics-reporting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md index 35f5c99e917..1e564af816c 100644 --- a/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md +++ b/docs/sources/operators-guide/configure/about-anonymous-usage-statistics-reporting.md @@ -40,7 +40,7 @@ When the usage statistics reporting is enabled, Grafana Mimir collects the follo - The number of in-memory series. - The number of tenants that have in-memory series. - The number of samples and exemplars ingested. - - Querier, *where no information is tracked about the actual request or query*: + - Querier, _where no information is tracked about the actual request or query_: - The number of requests to queriers that are split by API endpoint type: - Remote read. - Instant query.