docker_engine

README

docker_engine

This module will monitor one or more Docker engines.

Requirements:

• docker with enabled metric-address

It produces the following charts:

1. Container Actions in actions/s

• changes
• commits
• create
• delete
• start

1. Container States in number of containers in state

• running
• paused
• stopped

1. Builder Builds Fails By Reason in fails/s

• build_canceled
• build_target_not_reachable_error
• command_not_supported_error
• dockerfile_empty_error
• dockerfile_syntax_error
• error_processing_commands_error
• missing_onbuild_arguments_error
• unknown_instruction_error

1. Health Checks in events/s

• fails

If docker in swarm mode and the instance is swarm manager additional charts will be added:

1. Swarm Manager Leader in bool

• is_leader

1. Swarm Manager Object Store in count

• nodes
• services
• tasks
• networks
• secrets
• configs

1. Swarm Manager Nodes Per State in count

• ready
• down
• unknown
• disconnected

1. Swarm Manager Tasks Per State in count

• running
• failed
• ready
• rejected
• starting
• shutdown
• new
• orphaned
• preparing
• pending
• complete
• remove
• accepted
• assigned

configuration

For all available options please see module configuration file.

---

Needs only url to docker metric-address.

Here is an example for 2 docker instances:

jobs:
  - name: local
    url : http://127.0.0.1:9323/metrics
      
  - name: remote
    url : http://100.64.0.1:9323/metrics

Without configuration, module attempts to connect to http://127.0.0.1:9323/metrics

---

Documentation

Index

• type Charts
• type Config
• type Dims
• type DockerEngine
  • func New() *DockerEngine
  • func (de DockerEngine) Charts() *Charts
  • func (de *DockerEngine) Check() bool
  • func (DockerEngine) Cleanup()
  • func (de *DockerEngine) Collect() map[string]int64
  • func (de *DockerEngine) 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"`
}

Config is the DockerEngine module configuration.

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type DockerEngine

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

DockerEngine DockerEngine module.

func New

func New() *DockerEngine

New creates DockerEngine with default values.

func (DockerEngine) Charts

func (de DockerEngine) Charts() *Charts

Charts creates Charts.

func (*DockerEngine) Check

func (de *DockerEngine) Check() bool

Check makes check.

func (DockerEngine) Cleanup

func (DockerEngine) Cleanup()

Cleanup makes cleanup.

func (*DockerEngine) Collect

func (de *DockerEngine) Collect() map[string]int64

Collect collects metrics.

func (*DockerEngine) Init

func (de *DockerEngine) Init() bool

Init makes initialization.