From e08bcbbe7e23ee9297e60d24589494c8ae66ab15 Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Mon, 30 Oct 2023 15:23:41 -0700 Subject: [PATCH] Clarify data collection in Grafana Agent (#5656) * Clarify data collection * Clarify data collection done onlly in Static mode * Update links and add missing data collection * Fix broken link --- docs/sources/data-collection.md | 48 ++++++++++++++++++++ docs/sources/flow/reference/cli/run.md | 4 +- docs/sources/flow/setup/install/_index.md | 10 ++++ docs/sources/static/set-up/install/_index.md | 10 ++++ 4 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 docs/sources/data-collection.md diff --git a/docs/sources/data-collection.md b/docs/sources/data-collection.md new file mode 100644 index 000000000000..47b901696db4 --- /dev/null +++ b/docs/sources/data-collection.md @@ -0,0 +1,48 @@ +--- +aliases: +- ./data-collection/ +- /docs/grafana-cloud/agent/data-collection/ +- /docs/grafana-cloud/monitor-infrastructure/agent/data-collection/ +- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/data-collection/ +canonical: https://grafana.com/docs/agent/latest/data-collection/ +menuTitle: Data collection +title: Grafana Agent data collection +description: Grafana Agent data collection +weight: 500 +--- + +# Data collection + +By default, Grafana Agent sends anonymous but uniquely identifiable usage information from +your Grafana Agent instance to Grafana Labs. These statistics are sent to `stats.grafana.org`. + +Statistics help us better understand how Grafana Agent is used. This helps us prioritize features and documentation. + +The usage information includes the following details: + +* A randomly generated, anonymous unique ID (UUID). +* Timestamp of when the UID was first generated. +* Timestamp of when the report was created (by default, every four hours). +* Version of running Grafana Agent. +* Operating system Grafana Agent is running on. +* System architecture Grafana Agent is running on. +* List of enabled feature flags ([Static] mode only). +* List of enabled integrations ([Static] mode only). +* List of enabled [components][] ([Flow] mode only). + +This list may change over time. All newly reported data is documented in the CHANGELOG. + +## Opt-out of data collection + +You can use the `-disable-reporting` [command line flag][] to disable the reporting and opt-out of the data collection. + +{{% docs/reference %}} +[command line flag]: "/docs/agent/ -> /docs/agent//flow/reference/cli/run.md" +[command line flag]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/cli/run.md" +[components]: "/docs/agent/ -> /docs/agent//flow/concepts/components.md" +[components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/concepts/components.md" +[Static]: "/docs/agent/ -> /docs/agent//static" +[Static]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static +[Flow]: "/docs/agent/ -> /docs/agent//flow" +[Flow]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow" +{{% /docs/reference %}} \ No newline at end of file diff --git a/docs/sources/flow/reference/cli/run.md b/docs/sources/flow/reference/cli/run.md index 715d97af25c0..8b068b78ac3e 100644 --- a/docs/sources/flow/reference/cli/run.md +++ b/docs/sources/flow/reference/cli/run.md @@ -53,7 +53,7 @@ The following flags are supported: * `--server.http.listen-addr`: Address to listen for HTTP traffic on (default `127.0.0.1:12345`). * `--server.http.ui-path-prefix`: Base path where the UI is exposed (default `/`). * `--storage.path`: Base directory where components can store data (default `data-agent/`). -* `--disable-reporting`: Disable [usage reporting][] of enabled [components][] to Grafana (default `false`). +* `--disable-reporting`: Disable [data collection][] (default `false`). * `--cluster.enabled`: Start the Agent in clustered mode (default `false`). * `--cluster.node-name`: The name to use for this node (defaults to the environment's hostname). * `--cluster.join-addresses`: Comma-separated list of addresses to join the cluster at (default `""`). Mutually exclusive with `--cluster.discover-peers`. @@ -67,7 +67,7 @@ The following flags are supported: * `--config.bypass-conversion-errors`: Enable bypassing errors when converting (default `false`). [in-memory HTTP traffic]: {{< relref "../../concepts/component_controller.md#in-memory-traffic" >}} -[usage reporting]: {{< relref "../../../static/configuration/flags.md#report-information-usage" >}} +[data collection]: {{< relref "../../../data-collection" >}} [components]: {{< relref "../../concepts/components.md" >}} ## Update the configuration file diff --git a/docs/sources/flow/setup/install/_index.md b/docs/sources/flow/setup/install/_index.md index fb61a3b173f5..b711666e84cc 100644 --- a/docs/sources/flow/setup/install/_index.md +++ b/docs/sources/flow/setup/install/_index.md @@ -27,3 +27,13 @@ Installing Grafana Agent on other operating systems is possible, but is not reco {{% /admonition %}} {{< section >}} + +## Data collection + +By default, Grafana Agent sends anonymous usage information to Grafana Labs. Refer to [data collection][] for more information +about what data is collected and how you can opt-out. + +{{% docs/reference %}} +[data collection]: "/docs/agent/ -> /docs/agent//data-collection.md" +[data collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/data-collection.md" +{{% /docs/reference %}} diff --git a/docs/sources/static/set-up/install/_index.md b/docs/sources/static/set-up/install/_index.md index 88e09c1b5d57..1df90ef26319 100644 --- a/docs/sources/static/set-up/install/_index.md +++ b/docs/sources/static/set-up/install/_index.md @@ -37,3 +37,13 @@ Use the Grafana Agent [Kubernetes configuration](/docs/grafana-cloud/monitor-inf ## Tanka For more information, refer to the [Tanka](https://tanka.dev) configurations in the Grafana Agent [production](https://github.com/grafana/agent/tree/main/production/tanka/grafana-agent) directory on GitHub. + +## Data collection + +By default, Grafana Agent sends anonymous usage information to Grafana Labs. Refer to [data collection][] for more information +about what data is collected and how you can opt-out. + +{{% docs/reference %}} +[data collection]: "/docs/agent/ -> /docs/agent//data-collection.md" +[data collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/data-collection.md" +{{% /docs/reference %}} \ No newline at end of file