Commit 61eaf4fe authored by Régis Freyd (GitLab)'s avatar Régis Freyd (GitLab) Committed by Rémy Coutable

Move documentation as per Axil comment

parent 9fa00d69
......@@ -22,26 +22,26 @@ 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
## Usage ping
> [Introduced][ee-557] in GitLab Enterprise Edition 8.10. More statistics
[were added][ee-735] in GitLab Enterprise Edition 8.12.
[were added][ee-735] in GitLab Enterprise Edition 8.12. [Moved to CE][ce-23361]
in GitLab 9.1.
GitLab Inc. can collect non-sensitive information about how Enterprise Edition
customers use their GitLab instance upon the activation of a ping feature
GitLab Inc. can collect non-sensitive information about how GitLab users
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.
You can see the **exact** JSON payload that your instance sends to GitLab
in the "Usage statistics" section of the admin panel.
Nothing qualitative is collected. Only quantitative. Meaning, no project name,
Nothing qualitative is collected. Only quantitative. That means no project name,
author name, nature of comments, name of labels, etc.
This is done mainly for the following reasons:
The usage ping is sent 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.
- to have a better understanding on how our users use our product,
- to be more data driven when creating or changing features.
The total number of the following is sent back to GitLab Inc.:
......@@ -79,6 +79,16 @@ The total number of the following is sent back to GitLab Inc.:
Also, we track if you've installed Mattermost with GitLab.
For example: `"mattermost_enabled":true"`.
More data will be added over time. The goal of this ping is to be as light as
possible, so it won't have any performance impact on your installation when
calculation is made.
### Deactivate the usage ping
By default, usage ping is opt-out. If you want to deactivate this feature, go to
the Settings page of your administration panel and uncheck the Usage ping
checkbox.
## Privacy policy
GitLab Inc. does **not** collect any sensitive information, like project names
......@@ -89,3 +99,4 @@ 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
[ce-23361]: https://gitlab.com/gitlab-org/gitlab-ce/issues/23361
# Usage ping and cohorts
# Cohorts
> **Notes:**
- [Introduced][ee-380] in GitLab EE 8.10 and [added to CE][ce-23361] in GitLab 9.1.
- [Introduced][ce-23361] in GitLab 9.1.
## Usage ping
In order for GitLab to become a data-driven company, where deciding what to
build next is driven by how users are using the product, GitLab needs to collect
usage data. This is done via a feature called usage ping.
Usage ping is a weekly, anonymous JSON sent to GitLab, containing several
metrics on how people use specific features.
You can see at any given point in time the content of the JSON file that will be
sent in the Administration panel of your GitLab installation. This feature can
also be deactivated at any given time.
The information that is sent contains the total number of:
* 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
More will be added over time. The goal of this ping is to be as light as
possible, so it won't have any performance impact on your installation when
calculation is made.
### Deactivate the usage ping
By default, usage ping is opt-out. If you want to deactivate, go to the Settings
page of your administration panel and uncheck the Usage ping checkbox.
[IMAGE]
## Cohorts
As a benefit of having the usage ping active, GitLab lets you analyze the user's
activities of your GitLab installation. Under [LINK], when the usage ping is
active, GitLab will show the monthly cohorts of new users and their activities
over time.
As a benefit of having the [usage ping active](settings/usage_statistics.md),
GitLab lets you analyze the user's activities of your GitLab installation.
Under [LINK], when the usage ping is active, GitLab will show the monthly
cohorts of new users and their activities over time.
How do we read the user cohorts table? Let's take an example with the following
user cohorts.
......@@ -84,5 +27,4 @@ How do we measure the activity of users? GitLab considers a user active if:
1. Activate the usage ping as defined in [LINK]
2. Go to [LINK] to see the user cohorts of the server
[ee-380]: https://gitlab.com/gitlab-org/gitlab-ee/issues/380
[ce-23361]: https://gitlab.com/gitlab-org/gitlab-ce/issues/23361
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment