|
1 | 1 | ---
|
2 | 2 | name: Manage usage data collection
|
3 | 3 | title: Manage usage data collection
|
4 |
| -description: Understand and manage usage data collected by Docker EE and sent to Docker. |
| 4 | +description: | |
| 5 | + Understand and manage usage data collected by Docker EE and sent to Docker. |
| 6 | +ui_tabs: |
| 7 | +- version: ucp-3.0 |
| 8 | + orhigher: true |
| 9 | +cli_tabs: |
| 10 | +- version: docker-cli-linux |
5 | 11 | keywords: enterprise, telemetry, data collection
|
6 | 12 | ---
|
| 13 | +{% if include.ui %} |
7 | 14 |
|
8 |
| -Docker EE version 17.06 and later includes a telemetry plugin. The plugin is enabled by default on Ubuntu starting with Docker EE 17.06.0 and on the rest of the EE-supported Linux distributions starting with version 17.06.2-ee-5. The telemetry plugin is not part of Docker EE for Windows Server. |
| 15 | +{% if include.version=="ucp-3.0" %} |
9 | 16 |
|
10 |
| -The telemetry plugin sends system information to Docker Inc. Docker uses this information to improve Docker EE. For details about the telemetry plugin and the types of data it collects, see the |
| 17 | +Docker EE Engine version 17.06 and later includes a telemetry plugin. |
| 18 | +The plugin is enabled by default on Ubuntu starting with Docker EE 17.06.0 |
| 19 | +and on the rest of the EE-supported Linux distributions starting with version |
| 20 | +17.06.2-ee-5. The telemetry plugin is not part of Docker EE for Windows Server. |
| 21 | + |
| 22 | +The telemetry plugin sends system information to Docker Inc. Docker uses this |
| 23 | +information to improve Docker EE. For details about the telemetry plugin and |
| 24 | +the types of data it collects, see the |
11 | 25 | [`telemetry` plugin documentation](https://store.docker.com/community/images/docker/telemetry).
|
12 | 26 |
|
13 | 27 | If your Docker instance runs in an environment with no internet connectivity,
|
14 |
| -the telemetry plugin does not collect or attempt to send any information to Docker Inc. |
| 28 | +the telemetry plugin does not collect or attempt to send any information to |
| 29 | +Docker Inc. |
15 | 30 |
|
16 | 31 | ## Manage data collection
|
17 | 32 |
|
18 |
| -If you do not wish to send any usage data to Docker Inc., you can disable the plugin, |
19 |
| -either using the Docker CLI or using Universal Control Plane. |
| 33 | +If you don't wish to send any usage data to Docker Inc., you can disable the |
| 34 | +plugin, either using the Docker CLI or using Universal Control Plane. |
| 35 | + |
| 36 | +> UCP and CLI |
| 37 | +> |
| 38 | +> If you're using Docker EE Standard or Advanced with Universal Control Plane |
| 39 | +> (UCP), use UCP to enable and disable metrics. Use the CLI only if you don't |
| 40 | +> have UCP. UCP re-enables the telemetry plugin for hosts where it was |
| 41 | +> disabled with the CLI. |
| 42 | +{: .warning} |
| 43 | + |
| 44 | +### Use Universal Control Plane |
| 45 | + |
| 46 | +If you use Universal Control Plane with Docker EE, do not use the Docker CLI to |
| 47 | +disable the telemetry plugin. Instead, you can manage the information sent to |
| 48 | +Docker by going to **Admin Settings** and choosing **Usage**. |
| 49 | + |
| 50 | +{: .with-border} |
| 51 | + |
| 52 | +To disable the telemetry plugin, disable all three options and click **Save**. |
| 53 | +Enabling either or both of the top two options will enable the telemetry plugin. |
| 54 | +You can find out more about an individual option by clicking the **?** icon. |
| 55 | + |
| 56 | +> API usage metrics |
| 57 | +> |
| 58 | +> If API usage statistics are enabled, Docker gathers only aggregate stats |
| 59 | +> about what API endpoints are used. API payload contents aren't collected. |
| 60 | +{: .important} |
| 61 | + |
| 62 | + |
| 63 | + {% endif %} |
| 64 | + {% endif %} |
20 | 65 |
|
21 |
| - > **Note**: If you're using Docker EE Standard or Advanced with Universal Control Plane, use Universal Control Plane (UCP) to enable and disable metrics. Only use the CLI if you do not have UCP. UCP re-enables the telemetry plugin for hosts where it was disabled with the CLI. |
| 66 | +{% if include.cli %} |
22 | 67 |
|
23 |
| -### Use the Docker CLI |
| 68 | +{% if include.version=="docker-cli-linux" %} |
24 | 69 |
|
25 | 70 | To disable the telemetry plugin, use the `docker plugin disable` with either the plugin NAME or ID:
|
26 | 71 |
|
@@ -56,5 +101,8 @@ To disable the telemetry plugin, disable all three options and click **Save**.
|
56 | 101 | Enabling either or both of the top two options enable the telemetry plugin.
|
57 | 102 | You can find out more about an individual option by clicking the **?** icon.
|
58 | 103 |
|
59 |
| -> **Note**: If API usage statistics are enabled, Docker only gathers aggregate stats about what API endpoints are used. API payload contents are not collected. |
| 104 | +> **Note**: If API usage statistics are enabled, Docker only gathers aggregate |
| 105 | +stats about what API endpoints are used. API payload contents are not collected. |
60 | 106 |
|
| 107 | +{% endif %} |
| 108 | +{% endif %} |
0 commit comments