docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding basic information about extension insights and analytics (#19254) 

* Adding basic information about extension insights and analytics

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

* suggestion fro review

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Fix Unique users column name

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

---------

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
This commit is contained in:
Guillaume Tardif 2024-02-07 11:09:28 +01:00 committed by GitHub
parent ca143e00d0
commit 520939f04e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 46 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
content/trusted-content/insights-analytics.md
View File

@ -8,7 +8,7 @@ aliases:
--- ---
Insights and analytics provides usage analytics for Docker Verified Insights and analytics provides usage analytics for Docker Verified
Publisher (DVP) and Docker-Sponsored Open Source (DSOS) images on Docker Hub. This includes self-serve access to metrics as both raw data and summary data for a desired time span. You can view the number of image pulls by tag or by digest, and get breakdowns by geolocation, cloud provider, client, and more. Publisher (DVP) and Docker-Sponsored Open Source (DSOS) images on Docker Hub. This includes self-serve access to image and extension usage metrics for a desired time span. You can also display the number of image pulls by tag or by digest, and get breakdowns by geolocation, cloud provider, client, and more.
<!-- prettier-ignore --> <!-- prettier-ignore -->
> **Tip** > **Tip**
@ -18,11 +18,11 @@ Publisher (DVP) and Docker-Sponsored Open Source (DSOS) images on Docker Hub. Th
to learn more about the programs. to learn more about the programs.
{ .tip } { .tip }
## View the analytics data ## View the image's analytics data
You can find analytics data for your repositories on the **Insights and You can find analytics data for your repositories on the **Insights and
analytics** dashboard at the following URL: analytics** dashboard at the following URL:
`https://hub.docker.com/orgs/{namespace}/insights`. The dashboard contains a `https://hub.docker.com/orgs/{namespace}/insights/images`. The dashboard contains a
visualization of the usage data and a table where you can download visualization of the usage data and a table where you can download
the data as CSV files. the data as CSV files.
@ -53,6 +53,12 @@ preserves the display selections you made. When someone follows the link, the
**Insights and analytics** page opens and displays the chart with the same **Insights and analytics** page opens and displays the chart with the same
configuration as you had set up when creating the link. configuration as you had set up when creating the link.
## Extension analytics data
If you have published Docker Extensions in the Extension marketplace, you can also get analytics about your extension usage, available as CSV files.
You can download extension CSV reports from the **Insights and analytics** dashboard at the following URL:
`https://hub.docker.com/orgs/{namespace}/insights/extensions`. If your Docker namespace contains extensions known in the marketplace, you will see an **Extensions** tab listing CSV files for your extension(s).
## Exporting analytics data ## Exporting analytics data
You can export the analytics data either from the web dashboard, or using the You can export the analytics data either from the web dashboard, or using the
@ -94,7 +100,7 @@ points and with different structure.
The following sections describe the available data points for each format. The The following sections describe the available data points for each format. The
**Date added** column shows when the field was first introduced. **Date added** column shows when the field was first introduced.
### Raw data ### Image pulls raw data
The raw data format contains the following data points. Each row in the CSV file The raw data format contains the following data points. Each row in the CSV file
represents an image pull. represents an image pull.
@ -118,12 +124,12 @@ represents an image pull.
| Domain | Request origin domain, see [Privacy](#privacy). | October 11, 2022 | | Domain | Request origin domain, see [Privacy](#privacy). | October 11, 2022 |
| Owner | The name of the organization that owns the repository. | December 19, 2022 | | Owner | The name of the organization that owns the repository. | December 19, 2022 |
[1]: #action-classification-rules [1]: #image-pulls-action-classification-rules
[2]: /registry/spec/api/ [2]: /registry/spec/api/
[3]: /admin/organization/orgs/ [3]: /admin/organization/orgs/
[4]: /docker-hub/repos/ [4]: /docker-hub/repos/
### Summary data ### Image pulls summary data
There are two levels of summary data available: There are two levels of summary data available:
@ -142,7 +148,7 @@ span:
| Version check | HEAD by tag, not followed by a GET | January 1, 2022 | | Version check | HEAD by tag, not followed by a GET | January 1, 2022 |
| Owner | The name of the organization that owns the repository. | December 19, 2022 | | Owner | The name of the organization that owns the repository. | December 19, 2022 |
### Action classification rules ### Image pulls action classification rules
An action represents the multiple request events associated with a An action represents the multiple request events associated with a
`docker pull`. Pulls are grouped by category to make the data more meaningful `docker pull`. Pulls are grouped by category to make the data more meaningful
@ -174,6 +180,37 @@ pulls. To provide feedback or ask questions about these rules,
| HEAD | digest | GET by same digest | Pull by digest | Image is single-arch and/or image is multi-arch but some part of the image already exists on the local machine | | | HEAD | digest | GET by same digest | Pull by digest | Image is single-arch and/or image is multi-arch but some part of the image already exists on the local machine | |
| HEAD | digest | GET by same digest, then a second GET by different digest | Pull by Digest | Image is multi-arch | | | HEAD | digest | GET by same digest, then a second GET by different digest | Pull by Digest | Image is multi-arch | |
### Extension Summary data
There are two levels of extension summary data available:
- Core summary, with basic extension usage information: number of extension installs, uninstalls, and total install all times
The core-summary-data file contains the following data points for the selected time
span:
| Data point | Description | Date added |
| ----------------- | ------------------------------------------------------- | ----------------- |
| Installs | Number of installs for the extension | Feb 1, 2024 |
| TotalInstalls | Number of installs for the extension all times | Feb 1, 2024 |
| Uninstalls | Number of uninstalls for the extension | Feb 1, 2024 |
| TotalUninstalls | Number of uninstalls for the extension all times | Feb 1, 2024 |
| Updates | Number of updates for the extension | Feb 1, 2024 |
- Premium summary, with advanced extension usage information: installs, uninstalls by unique users, extension opening by unique users.
The core-summary-data file contains the following data points for the selected time
span:
| Data point | Description | Date added |
| ----------------- | ------------------------------------------------------- | ----------------- |
| Installs | Number of installs for the extension | Feb 1, 2024 |
| UniqueInstalls | Number of unique users installing the extension | Feb 1, 2024 |
| Uninstalls | Number of uninstalls for the extension | Feb 1, 2024 |
| UniqueUninstalls | Number of unique users uninstalling the extension | Feb 1, 2024 |
| Usage | Number of openings of the extension tab | Feb 1, 2024 |
| UniqueUsers | Number of unique users openings the extension tab | Feb 1, 2024 |
## Changes in data over time ## Changes in data over time
The insights and analytics service is continuously improved to increase the The insights and analytics service is continuously improved to increase the
@ -198,11 +235,11 @@ consumers of content on Docker Hub remain completely anonymous.
> analytics data. > analytics data.
{ .important } { .important }
The summary dataset includes unique IP address count. This data point only The image pulls summary dataset includes unique IP address count. This data point only
includes the number of distinct unique IP addresses that request an image. includes the number of distinct unique IP addresses that request an image.
Individual IP addresses are never shared. Individual IP addresses are never shared.
The raw dataset includes user IP domains as a data point. This is the domain name The image pulls raw dataset includes user IP domains as a data point. This is the domain name
associated with the IP address used to pull an image. If the IP type is associated with the IP address used to pull an image. If the IP type is
`business`, the domain represents the company or organization associated with `business`, the domain represents the company or organization associated with
that IP address (for example, `docker.com`). For any other IP type that's not that IP address (for example, `docker.com`). For any other IP type that's not