From a19dd9ad25d460e87c3640096efe59f3680712ab Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 21 Sep 2016 20:24:23 +0300 Subject: Add documentation on Usage statistics and link from the admin area --- doc/user/admin_area/settings/usage_statistics.md | 87 ++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 doc/user/admin_area/settings/usage_statistics.md (limited to 'doc/user/admin_area/settings/usage_statistics.md') diff --git a/doc/user/admin_area/settings/usage_statistics.md b/doc/user/admin_area/settings/usage_statistics.md new file mode 100644 index 00000000000..70dea71d3c7 --- /dev/null +++ b/doc/user/admin_area/settings/usage_statistics.md @@ -0,0 +1,87 @@ +# Usage statistics + +GitLab Inc. will periodically collect information about your instance in order +to perform various actions. + +All statistics are opt-in and you can always disable them from the admin panel. + +## Version check + +GitLab can inform you when an update is available and the importance of it. + +No information other than the GitLab version and the instance's domain name +are collected. + +In the **Overview** tab you can see if your GitLab version is up to date. There +are three cases: 1) you are up to date (green), 2) there is an update available +(yellow) and 3) your version is vulnerable and a security fix is released (red). + +In any case, you will see a message informing you of the state and the +importance of the update. + +If enabled, the version status will also be shown in the help page (`/help`) +for all signed in users. + +## Usage data + +> [Introduced][ee-557] in GitLab Enterprise Edition 8.10. More statistics +[were added][ee-735] in GitLab Enterprise Edition 8.12. + +GitLab Inc. can collect non-sensitive information about how Enterprise Edition +customers use their GitLab instance upon the activation of a ping feature +located in the admin panel (`/admin/application_settings`). + +You can see the **exact** JSON payload that your instance sends to GitLab Inc. +in the "Usage statistics" section of the admin panel. + +Nothing qualitative is collected. Only quantitative. Meaning, no project name, +author name, nature of comments, name of labels, etc. + +This is done mainly for the following reasons: + +- to have a better understanding on how our users use our product +- to provide more tools for the customer success team to help customers onboard + better. + +The total number of the following is sent back to GitLab Inc.: + +- Comments +- Groups +- Users +- Projects +- Issues +- Labels +- CI builds +- Snippets +- Milestones +- Todos +- Pushes +- Merge requests +- Environments +- Triggers +- Deploy keys +- Pages +- Project Services +- Issue Boards +- CI Runners +- Deployments +- Geo Nodes +- LDAP Groups +- LDAP Keys +- LDAP Users +- LFS objects +- Protected branches +- Releases +- Remote mirrors +- Web hooks + +## Privacy policy + +GitLab Inc. does **not** collect any sensitive information, like project names +or the content of the comments. GitLab Inc. does not disclose or otherwise make +available any of the data collected on a customer specific basis. + +Read more in about the [Privacy policy](https://about.gitlab.com/privacy). + +[ee-557]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/557 +[ee-735]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/735 -- cgit v1.2.1