usage_statistics.md 3.28 KB
Newer Older
1
---
Craig Norris's avatar
Craig Norris committed
2 3
stage: none
group: unassigned
4
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
5 6 7
type: reference
---

8
# Usage statistics **(FREE SELF)**
9

10
GitLab Inc. periodically collects information about your instance in order
11 12
to perform various actions.

13 14
All statistics are opt-out. You can enable/disable them in the
**Admin Area > Settings > Metrics and profiling** section **Usage statistics**.
15

16 17
## Network configuration

18 19
Allow network traffic from your GitLab instance to IP address `104.196.17.203:443`, to send
usage statistics to GitLab Inc.
20

21 22
If your GitLab instance is behind a proxy, set the appropriate [proxy configuration variables](https://docs.gitlab.com/omnibus/settings/environment-variables.html).

23
## Version Check **(FREE SELF)**
24

25
If enabled, version check informs you if a new version is available and the
26 27
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:
28

29 30 31
- 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
32
  the latest version with security fixes as soon as possible.
33

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

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

39
This information is used, among other things, to identify to which versions
40
patches must be backported, making sure active GitLab instances remain
41 42
secure.

43
If you disable version check, this information isn't collected. Enable or
44
disable the version check in **Admin Area > Settings > Metrics and profiling > Usage statistics**.
45

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
### Request flow example

The following example shows a basic request/response flow between the self-managed GitLab instance
and the GitLab Version Application:

```mermaid
sequenceDiagram
    participant GitLab instance
    participant Version Application
    GitLab instance->>Version Application: Is there a version update?
    loop Version Check
        Version Application->>Version Application: Record version info
    end
    Version Application->>GitLab instance: Response (PNG/SVG)
```

62
## Usage Ping **(FREE SELF)**
63

64
See [Usage Ping guide](../../../development/usage_ping/index.md).
65

66
## Instance-level analytics availability
Luke Bennett's avatar
Luke Bennett committed
67

68
After usage ping is enabled, GitLab gathers data from other instances and
69
enables certain [instance-level analytics features](../analytics/index.md) that are dependent on usage ping.
Luke Bennett's avatar
Luke Bennett committed
70

71 72 73 74 75 76 77 78 79 80 81
<!-- ## Troubleshooting

Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.

Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->