Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
jangaraj committed Mar 21, 2015
1 parent 89b831a commit ae6b1f5
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Zabbix Docker Monitoring - beta version
========================================

This is beta version. I've started it, because Zabbix doesn't support container monitoring.
Project is developed with Zabbix 2.4 and Docker 1.4. It should works also with another Zabbix/Docker versions.
Please feel free to test and provide feedback.
This is beta version. Project is developed with Zabbix 2.4 and Docker 1.4. It should works also with another Zabbix/Docker versions.
Please feel free to test and provide feedback. Systemd and LXC execution driver is also supported.

Build
=====
Expand All @@ -18,19 +17,24 @@ Note: fci - full container ID

| Key | Description | Comments |
| --- | ----------- | -------- |
| **docker.discovery** | LLD discovering | Only running containers are discovered.<br>Additional Docker permissions are needed, when you want to see container name (human name) in metrics/graphs instead of short container ID |
| **docker.mem[fci,mmetric]** | Memory metrics | mmetric - any available memory metric in the pseudo-file memory.stat, e.g.: *cache, rss, mapped_file, pgpgin, pgpgout, swap, pgfault, pgmajfault, inactive_anon, active_anon, inactive_file, active_file, unevictable, hierarchical_memory_limit, hierarchical_memsw_limit, total_cache, total_rss, total_mapped_file, total_pgpgin, total_pgpgout, total_swap, total_pgfault, total_pgmajfault, total_inactive_anon, total_active_anon, total_inactive_file, total_active_file, total_unevictable* |
| **docker.cpu[fci,cmetric]** | CPU metrics | cmetric - any available CPU metric in the pseudo-file cpuacct.stat, e.g.: *system, user*<br>Jiffy CPU counter is recalculated to % value by Zabbix |
| **docker.dev[fci,cfile,cmetric]** | IO metrics | cfile - container blkio pseudo-file, e.g.:*blkio.io_merged, blkio.io_queued, blkio.io_service_bytes, blkio.io_serviced, blkio.io_service_time, blkio.io_wait_time, blkio.sectors, blkio.time, blkio.avg_queue_size, blkio.idle_time, blkio.dequeue, ...* Some pseudo metric files are available only if kernel config *CONFIG_DEBUG_BLK_CGROUP=y*.<br>, cmetric - any available blkio metric in selected pseudo-file, e.g.: *Total*, option only for selected block device is also available e.g. *'8:0 Sync'* (quotes must be used in key parameter in this case) |
| **docker.discovery** | LLD discovering | Only running containers are discovered.<br>Additional Docker permissions are needed, when you want to see container name (human name) in metrics/graphs instead of short container ID. |
| **docker.mem[fci,mmetric]** | Memory metrics | **mmetric** - any available memory metric in the pseudo-file memory.stat, e.g.: *cache, rss, mapped_file, pgpgin, pgpgout, swap, pgfault, pgmajfault, inactive_anon, active_anon, inactive_file, active_file, unevictable, hierarchical_memory_limit, hierarchical_memsw_limit, total_cache, total_rss, total_mapped_file, total_pgpgin, total_pgpgout, total_swap, total_pgfault, total_pgmajfault, total_inactive_anon, total_active_anon, total_inactive_file, total_active_file, total_unevictable* |
| **docker.cpu[fci,cmetric]** | CPU metrics | **cmetric** - any available CPU metric in the pseudo-file cpuacct.stat, e.g.: *system, user*<br>Jiffy CPU counter is recalculated to % value by Zabbix. |
| **docker.dev[fci,cfile,cmetric]** | IO metrics | **cfile** - container blkio pseudo-file, e.g.:*blkio.io_merged, blkio.io_queued, blkio.io_service_bytes, blkio.io_serviced, blkio.io_service_time, blkio.io_wait_time, blkio.sectors, blkio.time, blkio.avg_queue_size, blkio.idle_time, blkio.dequeue, ...*<br>**cmetric** - any available blkio metric in selected pseudo-file, e.g.: *Total*. Option for selected block device only is also available e.g. *'8:0 Sync'* (quotes must be used in key parameter in this case)<br>\*Note: Some pseudo blkio files are available only if kernel config *CONFIG_DEBUG_BLK_CGROUP=y*, see recommended docs. |
| **docker.up[fci]** | Running state check | 1 if container is running, otherwise 0 |
Doc: https://docs.docker.com/articles/runmetrics/

Not available at the moment, probably in the (near) future:

* docker.net - tricky metrics
* docker.dev - blkio metrics
* docker.stat - stat about number of available images, running/crashed/stopped containers
* Docker API metrics/details queries (when zabbix-agent has root permission)
* Docker API metrics/details queries (when zabbix-agent has root or docker permissions)

Recommended docs:

- https://docs.docker.com/articles/runmetrics/
- https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt
- https://www.kernel.org/doc/Documentation/cgroups/memory.txt
- https://www.kernel.org/doc/Documentation/cgroups/cpuacct.txt

Additional Docker permissions
=============================
Expand Down

0 comments on commit ae6b1f5

Please sign in to comment.