dockerhub

README

Docker Hub repository monitoring with Netdata

Docker Hub is a service provided by Docker for finding and sharing container images with your team.

This module will collect Docker Hub repositories statistics.

Metrics

All metrics have "docker_engine." prefix.

Metric	Scope	Dimensions	Units
pulls_sum	global	sum	pulls
pulls	global	a dimension per repository	pulls
pulls_rate	global	a dimension per repository	pulls/s
stars	global	a dimension per repository	stars
status	global	a dimension per repository	status
last_updated	global	a dimension per repository	seconds

Configuration

Edit the go.d/dockerhub.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/dockerhub.conf

Needs only list of repositories. Here is an example:

jobs:
  - name: me
    repositories:
      - 'me/repo1'
      - 'me/repo2'
      - 'me/repo3' 

For all available options please see module configuration file.

Troubleshooting

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
  

Documentation

Index

• type Charts
• type Config
• type Dim
• type Dims
• type DockerHub
  • func New() *DockerHub
  • func (dh DockerHub) Charts() *Charts
  • func (dh DockerHub) Check() bool
  • func (DockerHub) Cleanup()
  • func (dh *DockerHub) Collect() map[string]int64
  • func (dh *DockerHub) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

type Config struct {
	web.HTTP     `yaml:",inline"`
	Repositories []string
}

Config is the DockerHub module configuration.

type Dim

type Dim = module.Dim

Dim is an alias for module.Dim

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type DockerHub

type DockerHub struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

DockerHub DockerHub module.

func New

func New() *DockerHub

New creates DockerHub with default values.

func (DockerHub) Charts

func (dh DockerHub) Charts() *Charts

Charts creates Charts.

func (DockerHub) Check

func (dh DockerHub) Check() bool

Check makes check.

func (DockerHub) Cleanup

func (DockerHub) Cleanup()

Cleanup makes cleanup.

func (*DockerHub) Collect

func (dh *DockerHub) Collect() map[string]int64

Collect collects metrics.

func (*DockerHub) Init

func (dh *DockerHub) Init() bool

Init makes initialization.