Skip to content

Commit

Permalink
Clarify data collection in Grafana Agent (#5656)
Browse files Browse the repository at this point in the history
* Clarify data collection

* Clarify data collection done onlly in Static mode

* Update links and add missing data collection

* Fix broken link
  • Loading branch information
clayton-cornell authored Oct 30, 2023
1 parent 81c4b05 commit e08bcbb
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 2 deletions.
48 changes: 48 additions & 0 deletions docs/sources/data-collection.md
Original file line number Diff line number Diff line change
@@ -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/<AGENT_VERSION>/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/<AGENT_VERSION>/flow/concepts/components.md"
[components]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow/concepts/components.md"
[Static]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/static"
[Static]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/static
[Flow]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow"
[Flow]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/flow"
{{% /docs/reference %}}
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/cli/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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
Expand Down
10 changes: 10 additions & 0 deletions docs/sources/flow/setup/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<AGENT_VERSION>/data-collection.md"
[data collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/data-collection.md"
{{% /docs/reference %}}
10 changes: 10 additions & 0 deletions docs/sources/static/set-up/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<AGENT_VERSION>/data-collection.md"
[data collection]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/monitor-infrastructure/agent/data-collection.md"
{{% /docs/reference %}}

0 comments on commit e08bcbb

Please sign in to comment.