README.md

Docker Swarm monitor

Docker image to monitor a Docker Swarm.

Supported monitoring systems:

• PRTG Network Monitor

Information

Service	Stats
Docker
GitHub

General

Topic	Description
Image	See Docker Hub.
Source	See GitHub.

Installation

docker pull bbtsoftwareag/swarm-monitor

Tags

Tag	Description	Size
latest	Latest master build
1.4.0	Release 1.4.0
1.3.0	Release 1.3.0
1.2.0	Release 1.2.0
1.1.0	Release 1.1.0
1.0.0	Release 1.0.0

Volumes

Directory	Description
/var/run/docker.sock	docker.sock needs to be mounted to be able to check the services.

Ports

Port	Protocol	Description
80	TCP	Web-UI which provides status.json.

Configuration

These environment variables are supported:

ENV field	Example values	Description
TZ	Europe/Zurich	Timezone to set.
CHK_DOCKER_API_VERSION	v1.38	Docker API version to use. Default is v1.38.
CHK_INTERVAL	60	Interval for check in seconds. Default is 60.
CHK_MONITOR	prtg	Used monitoring. Defines the format of the status.json. Currently supported is prtg.
CHK_SERVICES	proxy_app.3	Services to monitor. Format is stack_service.expected-amount-of-instances. Multiple services can be defined separated by space.

Samples

docker-compose

version: '3.7'

services:
  app:
    image: bbtsoftwareag/swarm-monitor:latest
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - 80:80
    environment:
      - TZ=Europe/Zurich
      - CHK_DOCKER_API_VERSION=v1.38
      - CHK_INTERVAL=60
      - CHK_MONITOR=prtg
      - "CHK_SERVICES=
          monitor_app.1
          proxy_app.3"
    networks:
      - default

docker run

docker run -d \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -p 80:80 \
  -e TZ=Europe/Zurich \
  -e CHK_DOCKER_API_VERSION=v1.38 \
  -e CHK_INTERVAL=60 \
  -e CHK_MONITOR=prtg \
  -e "CHK_SERVICES=monitor_app.1 proxy_app.3" \
  bbtsoftwareag/swarm-monitor:latest