usage_statistics.md 3.13 KB
Newer Older
1 2 3 4 5
# Usage statistics

GitLab Inc. will periodically collect information about your instance in order
to perform various actions.

6 7
All statistics are opt-out, you can enable/disable them from the admin panel
under **Admin area > Settings > Usage statistics**.
8

Luke Bennett's avatar
Luke Bennett committed
9
## Version check **[CORE ONLY]**
10

11 12 13
If enabled, version check will inform you if a new version is available and the
importance of it through a status. This is shown on the help page (i.e. `/help`)
for all signed in users, and on the admin pages. The statuses are:
14

15 16 17 18
* Green: You are running the latest version of GitLab.
* Orange: An updated version of GitLab is available.
* Red: The version of GitLab you are running is vulnerable. You should install
  the latest version with security fixes as soon as possible.
19

20
![Orange version check example](img/update-available.png)
21

22 23
GitLab Inc. collects your instance's version and hostname (through the HTTP
referer) as part of the version check. No other information is collected.
24

25
This information is used, among other things, to identify to which versions
James Komara's avatar
James Komara committed
26
patches will need to be backported, making sure active GitLab instances remain
27 28 29 30
secure.

If you disable version check, this information will not be collected.  Enable or
disable the version check at **Admin area > Settings > Usage statistics**.
31

Luke Bennett's avatar
Luke Bennett committed
32
## Usage ping **[CORE ONLY]**
33 34

> [Introduced][ee-557] in GitLab Enterprise Edition 8.10. More statistics
35
[were added][ee-735] in GitLab Enterprise Edition
James Komara's avatar
James Komara committed
36 37
8.12. [Moved to GitLab Core][ce-23361] in 9.1. More statistics
[were added][ee-6602] in GitLab Ultimate 11.2.
38

39 40 41 42 43 44 45
GitLab sends a weekly payload containing usage data to GitLab Inc. The usage
ping uses high-level data to help our product, support, and sales teams. It does
not send any project names, usernames, or any other specific data. The
information from the usage ping is not anonymous, it is linked to the hostname
of the instance.

You can view the exact JSON payload in the administration panel.
46 47 48

### Deactivate the usage ping

49
The usage ping is opt-out. If you want to deactivate this feature, go to
50 51 52
the Settings page of your administration panel and uncheck the Usage ping
checkbox.

53 54
To disable the usage ping and prevent it from being configured in future through
the administration panel, Omnibus installs can set the following in
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
[`gitlab.rb`](https://docs.gitlab.com/omnibus/settings/configuration.html#configuration-options):

```ruby
gitlab_rails['usage_ping_enabled'] = false
```

And source installs can set the following in `gitlab.yml`:

```yaml
production: &base
  # ...
  gitlab:
    # ...
    usage_ping_enabled: false
```

Luke Bennett's avatar
Luke Bennett committed
71 72 73 74 75 76 77 78 79
## Instance statistics visibility **[CORE ONLY]**

Once usage ping is enabled, GitLab will gather data from other instances and
will be able to show [usage statistics](../../instance_statistics/index.md)
of your instance to your users.

This can be restricted to admins by selecting "Only admins" in the Instance
Statistics visibility section under **Admin area > Settings > Usage statistics**.

80 81
[ee-557]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/557
[ee-735]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/735
82
[ce-23361]: https://gitlab.com/gitlab-org/gitlab-ce/issues/23361