github.com/netdata/go.d.plugin@v0.58.1/modules/docker/metadata.yaml (about)

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-docker
     5        plugin_name: go.d.plugin
     6        module_name: docker
     7        alternative_monitored_instances: []
     8        monitored_instance:
     9          name: Docker
    10          link: https://www.docker.com/
    11          categories:
    12            - data-collection.containers-and-vms
    13          icon_filename: docker.svg
    14        related_resources:
    15          integrations:
    16            list: []
    17        info_provided_to_referring_integrations:
    18          description: ""
    19        keywords:
    20          - container
    21        most_popular: true
    22      overview:
    23        data_collection:
    24          metrics_description: |
    25            This collector monitors Docker containers state, health status and more.
    26          method_description: |
    27            It connects to the Docker instance via a TCP or UNIX socket and executes the following commands:
    28            
    29            - [System info](https://docs.docker.com/engine/api/v1.43/#tag/System/operation/SystemInfo).
    30            - [List images](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageList).
    31            - [List containers](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList).
    32        supported_platforms:
    33          include: []
    34          exclude: []
    35        multi_instance: true
    36        additional_permissions:
    37          description: Requires netdata user to be in the docker group.
    38        default_behavior:
    39          auto_detection:
    40            description: |
    41              It discovers instances running on localhost by attempting to connect to a known Docker UNIX socket: `/var/run/docker.sock`.
    42          limits:
    43            description: ""
    44          performance_impact:
    45            description: |
    46              Enabling `collect_container_size` may result in high CPU usage depending on the version of Docker Engine.
    47      setup:
    48        prerequisites:
    49          list: []
    50        configuration:
    51          file:
    52            name: go.d/docker.conf
    53          options:
    54            description: |
    55              The following options can be defined globally: update_every, autodetection_retry.
    56            folding:
    57              title: Config options
    58              enabled: true
    59            list:
    60              - name: update_every
    61                description: Data collection frequency.
    62                default_value: 1
    63                required: false
    64              - name: autodetection_retry
    65                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    66                default_value: 0
    67                required: false
    68              - name: address
    69                description: 'Docker daemon''s listening address. When using a TCP socket, the format is: tcp://[ip]:[port]'
    70                default_value: unix:///var/run/docker.sock
    71                required: true
    72              - name: timeout
    73                description: Request timeout in seconds.
    74                default_value: 1
    75                required: false
    76              - name: collect_container_size
    77                description: Whether to collect container writable layer size.
    78                default_value: "no"
    79                required: false
    80          examples:
    81            folding:
    82              enabled: true
    83              title: Config
    84            list:
    85              - name: Basic
    86                description: An example configuration.
    87                folding:
    88                  enabled: false
    89                config: |
    90                  jobs:
    91                    - name: local
    92                      address: 'unix:///var/run/docker.sock'
    93              - name: Multi-instance
    94                description: |
    95                  > **Note**: When you define multiple jobs, their names must be unique.
    96                  
    97                  Collecting metrics from local and remote instances.
    98                config: |
    99                  jobs:
   100                    - name: local
   101                      address: 'unix:///var/run/docker.sock'
   102                  
   103                    - name: remote
   104                      address: 'tcp://203.0.113.10:2375'
   105      troubleshooting:
   106        problems:
   107          list: []
   108      alerts:
   109        - name: docker_container_unhealthy
   110          metric: docker.container_health_status
   111          info: ${label:container_name} docker container health status is unhealthy
   112          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/docker.conf
   113      metrics:
   114        folding:
   115          title: Metrics
   116          enabled: false
   117        description: ""
   118        availability: []
   119        scopes:
   120          - name: global
   121            description: These metrics refer to the entire monitored application.
   122            labels: []
   123            metrics:
   124              - name: docker.containers_state
   125                description: Total number of Docker containers in various states
   126                unit: containers
   127                chart_type: stacked
   128                dimensions:
   129                  - name: running
   130                  - name: paused
   131                  - name: stopped
   132              - name: docker.containers_health_status
   133                description: Total number of Docker containers in various health states
   134                unit: containers
   135                chart_type: line
   136                dimensions:
   137                  - name: healthy
   138                  - name: unhealthy
   139                  - name: not_running_unhealthy
   140                  - name: starting
   141                  - name: no_healthcheck
   142              - name: docker.images
   143                description: Total number of Docker images in various states
   144                unit: images
   145                chart_type: stacked
   146                dimensions:
   147                  - name: active
   148                  - name: dangling
   149              - name: docker.images_size
   150                description: Total size of all Docker images
   151                unit: bytes
   152                chart_type: line
   153                dimensions:
   154                  - name: size
   155          - name: container
   156            description: Metrics related to containers. Each container provides its own set of the following metrics.
   157            labels:
   158              - name: container_name
   159                description: The container's name
   160              - name: image
   161                description: The image name the container uses
   162            metrics:
   163              - name: docker.container_state
   164                description: Docker container state
   165                unit: state
   166                chart_type: line
   167                dimensions:
   168                  - name: running
   169                  - name: paused
   170                  - name: exited
   171                  - name: created
   172                  - name: restarting
   173                  - name: removing
   174                  - name: dead
   175              - name: docker.container_health_status
   176                description: Docker container health status
   177                unit: status
   178                chart_type: line
   179                dimensions:
   180                  - name: healthy
   181                  - name: unhealthy
   182                  - name: not_running_unhealthy
   183                  - name: starting
   184                  - name: no_healthcheck
   185              - name: docker.container_writeable_layer_size
   186                description: Docker container writable layer size
   187                unit: size
   188                chart_type: line
   189                dimensions:
   190                  - name: writeable_layer