From ac70b0878b4658877aaca13d1497ac76a6ec5774 Mon Sep 17 00:00:00 2001 From: James Brooks Date: Mon, 2 Jul 2018 12:33:27 +0100 Subject: [PATCH] Add beacon docs --- docs/beacon.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/beacon.md diff --git a/docs/beacon.md b/docs/beacon.md new file mode 100644 index 00000000..c4439e5f --- /dev/null +++ b/docs/beacon.md @@ -0,0 +1,19 @@ +# About Beacon and the information we collect + +To help us understand how Cachet is used, we collect anonymous usage data. + +If you'd prefer not to provide us with this anonymous usage data, please set `CACHET_BEACON` to `false` in your `.env` file. + +## Data collected by Beacon + +- `install_id` - a unique, anonymous installation ID +- `version` - the version of Cachet being used +- `docker` - whether Cachet is being ran from a Docker container +- `database` - the database driver being used +- `data.components` - the amount of configured Components +- `data.incidents` - the amount of reported Incidents +- `data.metrics` - the amount of configured Metrics +- `data.users` - the amount of users +- `data.actions` - the amount of actions performed +- `data.tags` - the amount of Tags created +- `data.schedules` - the amount of reported Schedules