monit-docker user documentation

Monitor Docker containers and optionally execute rules when conditions match. Both modes use the same selectors and rule syntax.

• Simple mode: run a check, read statistics or execute a rule, then exit. Optionally schedule it with cron. No HTTP server or monitoring stack is needed.

• Serve mode: keep monitoring and expose cached status and metrics over HTTP. Optionally add Prometheus for history and Grafana for charts.

For installation and the command reference, see the project README.

Simple mode

• Simple mode: one command, then exit
  • 1. Read statistics
  • 2. Check a status in a script
  • 3. Preview a rule, then enable its action
  • 4. Optionally repeat with cron
  • Run a single command in Docker
  • When to use serve instead
  • Defaults for direct stats and monit commands
• Named scenarios (since 0.0.70)
  • Define once, run by name
  • Modes and settings
  • Selection and reuse
  • State and audit
• One-shot monitoring from cron
  • Try a rule safely
  • Schedule the job
  • Locking and persistent state
  • Exit codes and limits
  • Defaults for the direct cron command
• Wait for a sustained condition before acting
  • Cron example
  • Serve example
  • Reset and retry behavior
  • Output, preview and storage
• Disk space, inode and mount mode checks
  • Read measurements
  • Read-only and read-write mounts
  • Evaluate rules
  • Continuous monitoring and notifications
  • Requirements and errors
• File and directory access checks (since 0.0.69)
  • Explicit identity, no implicit root probe
  • ACL semantics
  • Rules and metrics
• Docker healthchecks
  • Read or act on health
  • API, UI and Prometheus
• OOM, repeated starts and PID checks
  • Read checks
  • Rules and actions
  • Bounded history and unavailable data
  • Alerts, notifications and journal
• Bounded automatic restarts
  • Rearm after intervention
  • Observe the limit
• Temporary maintenance (since 0.0.69)
  • CLI: finite pause and early resume
  • Optional interface controls
  • Persistence and resumption

Serve mode

• Install with Docker Compose
  • Default filtered Docker socket
  • Migrate an existing agent
  • Guided installation
  • Prerequisites
  • Start the agent
  • Add the web UI
  • Customize or update
  • Existing root cron installations
  • Try a reproducible incident
  • Add history later
• Installer avec Docker Compose
  • Socket Docker filtré par défaut
  • Migrer un agent existant
  • Installation guidée
  • Préparer la machine
  • Lancer seulement l’agent
  • Ajouter l’interface web
  • Régler les ports et mettre à jour
  • Remplacer l’ancien exemple cron
  • Continuer avec une démonstration
  • Réglages de cron, stats et monit
• Reproduce a memory incident with Compose
  • Start the lab
  • Observe and preview
  • Read the YAML and enable the guard
  • Read the journal and terminal interface
  • Stop, repeat or return to the minimal installation
• Continuous monitoring and HTTP endpoints
  • Start a local monitor
  • Run serve in Docker
  • Add history and charts
  • Optional remediation
  • Cache, freshness and lifecycle
  • HTTP contract
  • Optional manual action API
• HTTP API and metrics compatibility contract
  • Scope and transport
  • Cached status
  • Manual actions
  • Journal pages and exports
  • Notification receipts
  • Prometheus contract
  • curl examples
  • Evolution after the beta cleanup
• Optional lightweight interface
  • Try the published release in an isolated test
  • Start with read-only access
  • Enable manual actions
  • Protect a container from manual actions
  • Authentication and network boundaries
  • Prometheus
  • Updates and validation
  • Public demo
  • Persistent journal page (since 0.0.66)
• Serve, Prometheus and Grafana with Docker Compose
  • Start
  • What runs and where data lives
  • Check the first measurements
  • Ports, credentials and the Docker socket
  • Stop, restart and remove data
  • Customize
  • Optional authentication for metrics
• Prometheus metrics reference
  • Compatibility baseline
  • Agent metrics
  • Container metrics
  • Filesystem metrics
  • Access permission metrics
  • Maintenance indicators
  • Optional runtime checks
  • Prometheus configuration
• Prometheus alerts for serve mode
  • Defaults
  • Optional runtime alerts
  • View alerts
  • Agent unreachable
  • Collection not ready
  • Container memory high
  • Customize and reload
  • Regression tests
• Email and Slack notifications
  • Choose an example
  • Email: SMTP credentials
  • Slack: incoming webhook
  • Validate and start
  • Message behavior
  • Change settings and diagnose delivery
  • Redis Streams
  • Custom HTTP APIs with DWho
  • Tests
  • Event journal
• Action and notification journal
  • What is recorded
  • Text encoding shared by all outputs
  • Storage and recovery
  • Who performed a manual action?
  • Export or forward retained events
  • Include Alertmanager notifications
  • Private journal page (since 0.0.66)
• Journal schema compatibility
  • Supported schemas
  • Event and text rules
  • Reads and exports
  • Upgrade and rollback procedure
  • Rules for future changes
• Convert a retained journal to schema 2
  • Preview, then create the bundle
  • Bundle and verification
  • Errors and interruption
  • Optional activation and rollback
• Send Alertmanager notifications to Redis
  • Start the example
  • Read notifications
  • Retention and persistence
  • Delivery and operation
  • Regression coverage
  • Event journal
• HTTP notifications with DWho
  • Configure and send
  • Adapt the payload
  • Delivery contract and tests
  • Event journal
• Grafana example dashboard
  • Preview
  • Prerequisites and import
  • Panels
  • Regenerate the screenshots

Reference, upgrades and troubleshooting

• Validate configuration before running
• Configuration validation
• Textual terminal interface
• monit-docker 1.3.3
• monit-docker 1.3.2
• monit-docker 1.3.1
• monit-docker 1.3.0
• monit-docker 1.2.0
• monit-docker 1.1.4
• monit-docker 1.1.3
• monit-docker 1.1.2
• monit-docker 1.1.1
• monit-docker 1.1.0
• Configuration and CLI compatibility contract
• Read-only terminal interface
• Supported environments and check prerequisites
• Installation, upgrade and rollback rehearsals
• Deprecation and migration policy
• Troubleshooting
• monit-docker 1.0.1
• monit-docker 1.0.0

Contributor documentation

Changing the project? Use the separate Contributor documentation guide.

For contributors

• Contributor documentation