debian-mirror-gitlab/doc/user/admin_area/settings/usage_statistics.md

93 lines
3.6 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2021-01-29 00:20:46 +05:30
stage: none
group: unassigned
2021-02-22 17:27:13 +05:30
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
2019-09-04 21:01:54 +05:30
type: reference
---
2021-03-11 19:13:27 +05:30
# Usage statistics **(FREE SELF)**
2017-08-17 22:00:37 +05:30
2021-02-22 17:27:13 +05:30
GitLab Inc. periodically collects information about your instance in order
2017-08-17 22:00:37 +05:30
to perform various actions.
2021-10-27 15:23:28 +05:30
All usage statistics are [opt-out](#enable-or-disable-usage-statistics).
2021-09-04 01:27:46 +05:30
2021-11-18 22:05:49 +05:30
## Service Ping
2017-08-17 22:00:37 +05:30
2021-10-27 15:23:28 +05:30
Service Ping is a process that collects and sends a weekly payload to GitLab Inc.
For more information, see the [Service Ping guide](../../../development/service_ping/index.md).
2020-04-22 19:07:51 +05:30
2021-10-27 15:23:28 +05:30
### Instance-level analytics availability
2020-04-08 14:13:33 +05:30
2021-10-27 15:23:28 +05:30
When Service Ping is enabled, GitLab gathers data from other instances and
enables certain [instance-level analytics features](../analytics/index.md)
that are dependent on Service Ping.
2020-04-22 19:07:51 +05:30
2021-11-18 22:05:49 +05:30
## Version check
2017-08-17 22:00:37 +05:30
2021-02-22 17:27:13 +05:30
If enabled, version check informs you if a new version is available and the
2021-10-27 15:23:28 +05:30
importance of it through a status. The status displays on the help pages (`/help`)
for all signed-in users, and on the Admin Area pages. The statuses are:
2017-08-17 22:00:37 +05:30
2019-03-02 22:35:43 +05:30
- 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
2018-03-27 19:54:05 +05:30
the latest version with security fixes as soon as possible.
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
![Orange version check example](img/update-available.png)
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
GitLab Inc. collects your instance's version and hostname (through the HTTP
referer) as part of the version check. No other information is collected.
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
This information is used, among other things, to identify to which versions
2021-02-22 17:27:13 +05:30
patches must be backported, making sure active GitLab instances remain
2018-03-27 19:54:05 +05:30
secure.
2021-10-27 15:23:28 +05:30
If you [disable version check](#enable-or-disable-usage-statistics), this information isn't collected.
2017-08-17 22:00:37 +05:30
2020-03-13 15:44:24 +05:30
### Request flow example
2021-10-27 15:23:28 +05:30
The following example shows a basic request/response flow between a
self-managed GitLab instance and the GitLab Version Application:
2020-03-13 15:44:24 +05:30
```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)
```
2021-10-27 15:23:28 +05:30
## Configure your network
To send usage statistics to GitLab Inc., you must allow network traffic from your
GitLab instance to the IP address `104.196.17.203:443`.
If your GitLab instance is behind a proxy, set the appropriate
[proxy configuration variables](https://docs.gitlab.com/omnibus/settings/environment-variables.html).
2017-08-17 22:00:37 +05:30
2021-10-27 15:23:28 +05:30
## Enable or disable usage statistics
2017-08-17 22:00:37 +05:30
2021-10-27 15:23:28 +05:30
To enable or disable Service Ping and version check:
2018-11-18 11:00:15 +05:30
2021-11-11 11:23:49 +05:30
1. On the top bar, select **Menu > Admin**.
1. On the left sidebar, select **Settings > Metrics and profiling**.
1. Expand **Usage statistics**.
2021-11-18 22:05:49 +05:30
1. Select or clear the **Enable version check** and **Enable Service Ping** checkboxes.
2021-10-27 15:23:28 +05:30
1. Select **Save changes**.
2018-11-18 11:00:15 +05:30
2019-09-04 21:01:54 +05:30
<!-- ## 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. -->