Skip to content

Commit

Permalink
docs: document usage stats reported
Browse files Browse the repository at this point in the history
  • Loading branch information
theSuess committed Oct 24, 2024
1 parent 0510544 commit bf77415
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,12 @@ menu:
- name: Hidden Elements
url: /hidden-elements/
weight: 11
- name: Usage statistics
url: /usage-statistics/
weight: 12
- name: GitHub
url: https://github.com/grafana/grizzly/
weight: 12
weight: 13

markup:
defaultMarkdownHandler: goldmark
Expand Down
25 changes: 25 additions & 0 deletions docs/content/usage-statistics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
date: "2024-10-24T00:00:00+00:00"
title: "Usage statistics"
---

By default, Grizzly sends anonymous, but uniquely identifiable usage information to Grafana Labs. These statistics are sent to stats.grafana.org.

Statistics help Grafana better understand how Grizzly is used. This helps us prioritize features and documentation.

The usage information includes the following details:

* A hash of your config file
* Timestamp of when the report was created
* The version of Grizzly.
* The operating system Grizzly is running on.
* The system architecture Grizzly is running on.
* The operation performed (`pull`/`apply`)
* The number of resources affected

This list may change over time.
For auditing, the code performing this reporting can be found at the end of the [events.go](https://github.com/grafana/grizzly/blob/main/pkg/grizzly/events.go) file.

## 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.

0 comments on commit bf77415

Please sign in to comment.