Skip to main content

Docker Hub repository

Plugin: go.d.plugin Module: dockerhub

Overview

This collector keeps track of DockerHub repositories statistics such as the number of stars, pulls, current status, and more.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Docker Hub repository instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
dockerhub.pulls_sumsumpulls
dockerhub.pullsa dimension per repositorypulls
dockerhub.pulls_ratea dimension per repositorypulls/s
dockerhub.starsa dimension per repositorystars
dockerhub.statusa dimension per repositorystatus
dockerhub.last_updateda dimension per repositoryseconds

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/dockerhub.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/dockerhub.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.False
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.False
urlDockerHub URL.True
repositoriesList of repositories to monitor.True
timeoutHTTP request timeout.False
usernameUsername for basic HTTP authentication.False
passwordPassword for basic HTTP authentication.False
proxy_urlProxy URL.False
proxy_usernameUsername for proxy basic HTTP authentication.False
proxy_passwordPassword for proxy basic HTTP authentication.False
methodHTTP request method.False
bodyHTTP request body.False
headersHTTP request headers.False
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.False
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.False
tls_caCertification authority that the client uses when verifying the server's certificates.False
tls_certClient TLS certificate.False
tls_keyClient TLS key.False

Examples

Basic

A basic example configuration.

jobs:
- name: dockerhub
repositories:
- 'user1/name1'
- 'user2/name2'
- 'user3/name3'

Troubleshooting

Debug Mode

To troubleshoot issues with the dockerhub collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m dockerhub

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.