Source: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/app/docker?at=release/6.0
Docker by Zabbix agent 2
Overview
For Zabbix version: 6.0 and higher
The template to monitor Docker engine by Zabbix that work without any external scripts.
Most of the metrics are collected in one go, thanks to Zabbix bulk data collection.
Template Docker by Zabbix agent 2
— collects metrics by polling zabbix-agent2.
This template was tested on:
- Docker, version 19.03.5
Setup
See Zabbix template operation for basic instructions.
Setup and configure zabbix-agent2 compiled with the Docker monitoring plugin.
Test availability: zabbix_get -s docker-host -k docker.info
Zabbix configuration
No specific Zabbix configuration is required.
Macros used
Name | Description | Default |
---|---|---|
{$DOCKER.LLD.FILTER.CONTAINER.MATCHES} | Filter of discoverable containers |
.* |
{$DOCKER.LLD.FILTER.CONTAINER.NOT_MATCHES} | Filter to exclude discovered containers |
CHANGE_IF_NEEDED |
{$DOCKER.LLD.FILTER.IMAGE.MATCHES} | Filter of discoverable images |
.* |
{$DOCKER.LLD.FILTER.IMAGE.NOT_MATCHES} | Filter to exclude discovered images |
CHANGE_IF_NEEDED |
Template links
There are no template links in this template.
Discovery rules
Name | Description | Type | Key and additional info |
---|---|---|---|
Containers discovery | Discovery for containers metrics Parameter: true - Returns all containers false - Returns only running containers |
ZABBIX_PASSIVE | docker.containers.discovery[false] Filter: AND- {#NAME} MATCHES_REGEX - {#NAME} NOT_MATCHES_REGEX |
Images discovery | Discovery for images metrics |
ZABBIX_PASSIVE | docker.images.discovery Filter: AND- {#NAME} MATCHES_REGEX - {#NAME} NOT_MATCHES_REGEX |
Items collected
Group | Name | Description | Type | Key and additional info |
---|---|---|---|---|
Docker | Docker: Ping | ZABBIX_PASSIVE | docker.ping Preprocessing: - DISCARD_UNCHANGED_HEARTBEAT: |
|
Docker | Docker: Containers total | Total number of containers on this host |
DEPENDENT | docker.containers.total Preprocessing: - JSONPATH: |
Docker | Docker: Containers running | Total number of containers running on this host |
DEPENDENT | docker.containers.running Preprocessing: - JSONPATH: |
Docker | Docker: Containers stopped | Total number of containers stopped on this host |
DEPENDENT | docker.containers.stopped Preprocessing: - JSONPATH: |
Docker | Docker: Containers paused | Total number of containers paused on this host |
DEPENDENT | docker.containers.paused Preprocessing: - JSONPATH: |
Docker | Docker: Images total | Number of images with intermediate image layers |
DEPENDENT | docker.images.total Preprocessing: - JSONPATH: |
Docker | Docker: Storage driver | Docker storage driver |
DEPENDENT | docker.driver Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Memory limit enabled | - |
DEPENDENT | docker.mem_limit.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Swap limit enabled | - |
DEPENDENT | docker.swap_limit.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Kernel memory enabled | - |
DEPENDENT | docker.kernel_mem.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Kernel memory TCP enabled | - |
DEPENDENT | docker.kernel_mem_tcp.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: CPU CFS Period enabled | https://docs.docker.com/config/containers/resource_constraints/#configure-the-default-cfs-scheduler |
DEPENDENT | docker.cpu_cfs_period.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: CPU CFS Quota enabled | https://docs.docker.com/config/containers/resource_constraints/#configure-the-default-cfs-scheduler |
DEPENDENT | docker.cpu_cfs_quota.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: CPU Shares enabled | https://docs.docker.com/config/containers/resource_constraints/#configure-the-default-cfs-scheduler |
DEPENDENT | docker.cpu_shares.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: CPU Set enabled | https://docs.docker.com/config/containers/resource_constraints/#configure-the-default-cfs-scheduler |
DEPENDENT | docker.cpu_set.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Pids limit enabled | - |
DEPENDENT | docker.pids_limit.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: IPv4 Forwarding enabled | - |
DEPENDENT | docker.ipv4_forwarding.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Debug enabled | - |
DEPENDENT | docker.debug.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Nfd | Number of used File Descriptors |
DEPENDENT | docker.nfd Preprocessing: - JSONPATH: |
Docker | Docker: OomKill disabled | - |
DEPENDENT | docker.oomkill.disabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Goroutines | Number of goroutines |
DEPENDENT | docker.goroutines Preprocessing: - JSONPATH: |
Docker | Docker: Logging driver | - |
DEPENDENT | docker.logging_driver Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Cgroup driver | - |
DEPENDENT | docker.cgroup_driver Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: NEvents listener | - |
DEPENDENT | docker.nevents_listener Preprocessing: - JSONPATH: |
Docker | Docker: Kernel version | - |
DEPENDENT | docker.kernel_version Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Operating system | - |
DEPENDENT | docker.operating_system Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: OS type | - |
DEPENDENT | docker.os_type Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Architecture | - |
DEPENDENT | docker.architecture Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: NCPU | - |
DEPENDENT | docker.ncpu Preprocessing: - JSONPATH: |
Docker | Docker: Memory total | - |
DEPENDENT | docker.mem.total Preprocessing: - JSONPATH: |
Docker | Docker: Docker root dir | - |
DEPENDENT | docker.root_dir Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Name | - |
DEPENDENT | docker.name Preprocessing: - JSONPATH: |
Docker | Docker: Server version | - |
DEPENDENT | docker.server_version Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Default runtime | - |
DEPENDENT | docker.default_runtime Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Live restore enabled | - |
DEPENDENT | docker.live_restore.enabled Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Docker: Layers size | - |
DEPENDENT | docker.layers_size Preprocessing: - JSONPATH: |
Docker | Docker: Images size | - |
DEPENDENT | docker.images_size Preprocessing: - JSONPATH: |
Docker | Docker: Containers size | - |
DEPENDENT | docker.containers_size Preprocessing: - JSONPATH: |
Docker | Docker: Volumes size | - |
DEPENDENT | docker.volumes_size Preprocessing: - JSONPATH: |
Docker | Docker: Images available | Number of top-level images |
DEPENDENT | docker.images.top_level Preprocessing: - JSONPATH: |
Docker | Image {#NAME}: Created | - |
DEPENDENT | docker.image.created["{#ID}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Image {#NAME}: Size | - |
DEPENDENT | docker.image.size["{#ID}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Get stats | Get container stats based on resource usage |
ZABBIX_PASSIVE | docker.container_stats["{#NAME}"] |
Docker | Container {#NAME}: CPU total usage per second | - |
DEPENDENT | docker.container_stats.cpu_usage.total.rate["{#NAME}"] Preprocessing: - JSONPATH: - CHANGE_PER_SECOND - MULTIPLIER: |
Docker | Container {#NAME}: CPU percent usage | - |
DEPENDENT | docker.container_stats.cpu_pct_usage["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: CPU kernelmode usage per second | - |
DEPENDENT | docker.container_stats.cpu_usage.kernel.rate["{#NAME}"] Preprocessing: - JSONPATH: - CHANGE_PER_SECOND - MULTIPLIER: |
Docker | Container {#NAME}: CPU usermode usage per second | - |
DEPENDENT | docker.container_stats.cpu_usage.user.rate["{#NAME}"] Preprocessing: - JSONPATH: - CHANGE_PER_SECOND - MULTIPLIER: |
Docker | Container {#NAME}: Online CPUs | - |
DEPENDENT | docker.container_stats.online_cpus["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Throttling periods | Number of periods with throttling active |
DEPENDENT | docker.container_stats.cpu_usage.throttling_periods["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Throttled periods | Number of periods when the container hits its throttling limit |
DEPENDENT | docker.container_stats.cpu_usage.throttled_periods["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Throttled time | Aggregate time the container was throttled for in nanoseconds |
DEPENDENT | docker.container_stats.cpu_usage.throttled_time["{#NAME}"] Preprocessing: - JSONPATH: - MULTIPLIER: |
Docker | Container {#NAME}: Memory usage | - |
DEPENDENT | docker.container_stats.memory.usage["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Memory maximum usage | - |
DEPENDENT | docker.container_stats.memory.max_usage["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Memory commit bytes | - |
DEPENDENT | docker.container_stats.memory.commit_bytes["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Memory commit peak bytes | - |
DEPENDENT | docker.container_stats.memory.commit_peak_bytes["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Memory private working set | - |
DEPENDENT | docker.container_stats.memory.private_working_set["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Networks bytes received per second | - |
DEPENDENT | docker.networks.rx_bytes["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Networks packets received per second | - |
DEPENDENT | docker.networks.rx_packets["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Networks errors received per second | - |
DEPENDENT | docker.networks.rx_errors["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Networks incoming packets dropped per second | - |
DEPENDENT | docker.networks.rx_dropped["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Networks bytes sent per second | - |
DEPENDENT | docker.networks.tx_bytes["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Networks packets sent per second | - |
DEPENDENT | docker.networks.tx_packets["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Networks errors sent per second | - |
DEPENDENT | docker.networks.tx_errors["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Networks outgoing packets dropped per second | - |
DEPENDENT | docker.networks.tx_dropped["{#NAME}"] Preprocessing: - JSONPATH: ⛔️ON_FAIL: - CHANGE_PER_SECOND |
Docker | Container {#NAME}: Get info | Return low-level information about a container |
ZABBIX_PASSIVE | docker.container_info["{#NAME}"] |
Docker | Container {#NAME}: Created | - |
DEPENDENT | docker.container_info.created["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Container {#NAME}: Image | - |
DEPENDENT | docker.container_info.image["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Container {#NAME}: Restart count | - |
DEPENDENT | docker.container_info.restart_count["{#NAME}"] Preprocessing: - JSONPATH: |
Docker | Container {#NAME}: Status | - |
DEPENDENT | docker.container_info.state.status["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Container {#NAME}: Running | - |
DEPENDENT | docker.container_info.state.running["{#NAME}"] Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL |
Docker | Container {#NAME}: Paused | - |
DEPENDENT | docker.container_info.state.paused["{#NAME}"] Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL |
Docker | Container {#NAME}: Restarting | - |
DEPENDENT | docker.container_info.state.restarting["{#NAME}"] Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL |
Docker | Container {#NAME}: OOMKilled | - |
DEPENDENT | docker.container_info.state.oomkilled["{#NAME}"] Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL |
Docker | Container {#NAME}: Dead | - |
DEPENDENT | docker.container_info.state.dead["{#NAME}"] Preprocessing: - JSONPATH: - BOOL_TO_DECIMAL |
Docker | Container {#NAME}: Pid | - |
DEPENDENT | docker.container_info.state.pid["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Container {#NAME}: Exit code | - |
DEPENDENT | docker.container_info.state.exitcode["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Container {#NAME}: Error | - |
DEPENDENT | docker.container_info.state.error["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Container {#NAME}: Started at | - |
DEPENDENT | docker.container_info.started["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Docker | Container {#NAME}: Finished at | - |
DEPENDENT | docker.container_info.finished["{#NAME}"] Preprocessing: - JSONPATH: - DISCARD_UNCHANGED_HEARTBEAT: |
Zabbix raw items | Docker: Get info | ZABBIX_PASSIVE | docker.info | |
Zabbix raw items | Docker: Get containers | ZABBIX_PASSIVE | docker.containers | |
Zabbix raw items | Docker: Get images | ZABBIX_PASSIVE | docker.images | |
Zabbix raw items | Docker: Get data_usage | ZABBIX_PASSIVE | docker.data_usage |
Triggers
Name | Description | Expression | Severity | Dependencies and additional info |
---|---|---|---|---|
Docker: Service is down | - |
last(/Docker by Zabbix agent 2/docker.ping)=0 |
AVERAGE | Manual close: YES |
Docker: Failed to fetch info data | Zabbix has not received data for items for the last 30 minutes |
nodata(/Docker by Zabbix agent 2/docker.name,30m)=1 |
WARNING | Manual close: YES Depends on: - Docker: Service is down |
Docker: Version has changed | Docker version has changed. Ack to close. |
last(/Docker by Zabbix agent 2/docker.server_version,#1)<>last(/Docker by Zabbix agent 2/docker.server_version,#2) and length(last(/Docker by Zabbix agent 2/docker.server_version))>0 |
INFO | Manual close: YES |
Container {#NAME}: Container has been stopped with error code | - |
last(/Docker by Zabbix agent 2/docker.container_info.state.exitcode["{#NAME}"])>0 and last(/Docker by Zabbix agent 2/docker.container_info.state.running["{#NAME}"])=0 |
AVERAGE | Manual close: YES |
Container {#NAME}: An error has occurred in the container | Container {#NAME} has an error. Ack to close. |
last(/Docker by Zabbix agent 2/docker.container_info.state.error["{#NAME}"],#1)<>last(/Docker by Zabbix agent 2/docker.container_info.state.error["{#NAME}"],#2) and length(last(/Docker by Zabbix agent 2/docker.container_info.state.error["{#NAME}"]))>0 |
WARNING | Manual close: YES |
Feedback
Please report any issues with the template at https://support.zabbix.com
You can also provide feedback, discuss the template or ask for help with it at ZABBIX forums.