github.com/mackerelio/mackerel-agent-plugins@v0.89.3/mackerel-plugin-docker/README.md (about)

     1  mackerel-plugin-docker
     2  =========================
     3  
     4  Docker (https://www.docker.com/) custom metrics plugin for mackerel.io agent.
     5  
     6  ## Synopsis
     7  
     8  ```shell
     9  mackerel-plugin-docker [-host=<host>] [-tempfile=<tempfile>] [-name-format=<format>] [-label=<key>]
    10  ```
    11  
    12  - `-host` Socket path. This option is same as `--host` option of docker command. The default value is `unix:///var/run/docker.sock`.
    13  - `-tempfile` Temporary file stored metric values for calculating differentials.
    14  - `-name-format` Set the name format from name, name_id, id, image, image_id, image_name or label (default "name_id")
    15  - `-label` Use the value of the key as name in case that name-format is label.
    16  
    17  ## Current Status
    18  
    19  * x: works
    20  
    21  |Metric name                           |cgroup v1| cgroup v2|
    22  |--------------------------------------|---------|----------|
    23  |docker.cpuacct_percentage.#.user      | x       | x        |
    24  |docker.cpuacct_percentage.#.system    | x       | x        |
    25  |docker.cpuacct.#.user                 | x       | x        |
    26  |docker.cpuacct.#.system               | x       | x        |
    27  |docker.memory.#.cache                 | x       | x        |
    28  |docker.memory.#.rss                   | x       | x        |
    29  |docker.blkio.io_queued.#.read         | x       |          |
    30  |docker.blkio.io_queued.#.write        | x       |          |
    31  |docker.blkio.io_queued.#.sync         | x       |          |
    32  |docker.blkio.io_queued.#.async        | x       |          |
    33  |docker.blkio.io_serviced.#.read       | x       |          |
    34  |docker.blkio.io_serviced.#.write      | x       |          |
    35  |docker.blkio.io_serviced.#.sync       | x       |          |
    36  |docker.blkio.io_serviced.#.async      | x       |          |
    37  |docker.blkio.io_service_bytes.#.read  | x       |          |
    38  |docker.blkio.io_service_bytes.#.write | x       |          |
    39  |docker.blkio.io_service_bytes.#.sync  | x       |          |
    40  |docker.blkio.io_service_bytes.#.async | x       |          |
    41  
    42  ## Example of mackerel-agent.conf
    43  
    44  ```
    45  [plugin.metrics.docker]
    46  command = "/path/to/mackerel-plugin-docker"
    47  ```