github.com/netdata/go.d.plugin@v0.58.1/modules/docker_engine/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-docker_engine 5 plugin_name: go.d.plugin 6 module_name: docker_engine 7 alternative_monitored_instances: [] 8 monitored_instance: 9 name: Docker Engine 10 link: https://docs.docker.com/engine/ 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 - docker 21 - container 22 most_popular: false 23 overview: 24 data_collection: 25 metrics_description: | 26 This collector monitors the activity and health of Docker Engine and Docker Swarm. 27 method_description: | 28 The [built-in](https://docs.docker.com/config/daemon/prometheus/) Prometheus exporter is used to get the metrics. 29 supported_platforms: 30 include: [] 31 exclude: [] 32 multi_instance: true 33 additional_permissions: 34 description: "" 35 default_behavior: 36 auto_detection: 37 description: | 38 It discovers instances running on localhost by attempting to connect to a known Docker TCP socket: `http://127.0.0.1:9323/metrics`. 39 limits: 40 description: "" 41 performance_impact: 42 description: "" 43 setup: 44 prerequisites: 45 list: 46 - title: Enable built-in Prometheus exporter 47 description: | 48 To enable built-in Prometheus exporter, follow the [official documentation](https://docs.docker.com/config/daemon/prometheus/#configure-docker). 49 configuration: 50 file: 51 name: go.d/docker_engine.conf 52 options: 53 description: | 54 The following options can be defined globally: update_every, autodetection_retry. 55 folding: 56 title: Config options 57 enabled: true 58 list: 59 - name: update_every 60 description: Data collection frequency. 61 default_value: 1 62 required: false 63 - name: autodetection_retry 64 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 65 default_value: 0 66 required: false 67 - name: url 68 description: Server URL. 69 default_value: http://127.0.0.1:9323/metrics 70 required: true 71 - name: username 72 description: Username for basic HTTP authentication. 73 default_value: "" 74 required: false 75 - name: password 76 description: Password for basic HTTP authentication. 77 default_value: "" 78 required: false 79 - name: proxy_url 80 description: Proxy URL. 81 default_value: "" 82 required: false 83 - name: proxy_username 84 description: Username for proxy basic HTTP authentication. 85 default_value: "" 86 required: false 87 - name: proxy_password 88 description: Password for proxy basic HTTP authentication. 89 default_value: "" 90 required: false 91 - name: timeout 92 description: HTTP request timeout. 93 default_value: 1 94 required: false 95 - name: method 96 description: HTTP request method. 97 default_value: GET 98 required: false 99 - name: body 100 description: HTTP request body. 101 default_value: "" 102 required: false 103 - name: headers 104 description: HTTP request headers. 105 default_value: "" 106 required: false 107 - name: not_follow_redirects 108 description: Redirect handling policy. Controls whether the client follows redirects. 109 default_value: "no" 110 required: false 111 - name: tls_skip_verify 112 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 113 default_value: "no" 114 required: false 115 - name: tls_ca 116 description: Certification authority that the client uses when verifying the server's certificates. 117 default_value: "" 118 required: false 119 - name: tls_cert 120 description: Client TLS certificate. 121 default_value: "" 122 required: false 123 - name: tls_key 124 description: Client TLS key. 125 default_value: "" 126 required: false 127 examples: 128 folding: 129 title: Config 130 enabled: true 131 list: 132 - name: Basic 133 description: A basic example configuration. 134 folding: 135 enabled: false 136 config: | 137 jobs: 138 - name: local 139 url: http://127.0.0.1:9323/metrics 140 - name: HTTP authentication 141 description: Basic HTTP authentication. 142 config: | 143 jobs: 144 - name: local 145 url: http://127.0.0.1:9323/metrics 146 username: username 147 password: password 148 - name: HTTPS with self-signed certificate 149 description: Configuration with enabled HTTPS and self-signed certificate. 150 config: | 151 jobs: 152 - name: local 153 url: http://127.0.0.1:9323/metrics 154 tls_skip_verify: yes 155 - name: Multi-instance 156 description: | 157 > **Note**: When you define multiple jobs, their names must be unique. 158 159 Collecting metrics from local and remote instances. 160 config: | 161 jobs: 162 - name: local 163 url: http://127.0.0.1:9323/metrics 164 165 - name: remote 166 url: http://192.0.2.1:9323/metrics 167 troubleshooting: 168 problems: 169 list: [] 170 alerts: [] 171 metrics: 172 folding: 173 title: Metrics 174 enabled: false 175 description: "" 176 availability: [] 177 scopes: 178 - name: global 179 description: These metrics refer to the entire monitored application. 180 labels: [] 181 metrics: 182 - name: docker_engine.engine_daemon_container_actions 183 description: Container Actions 184 unit: actions/s 185 chart_type: stacked 186 dimensions: 187 - name: changes 188 - name: commit 189 - name: create 190 - name: delete 191 - name: start 192 - name: docker_engine.engine_daemon_container_states_containers 193 description: Containers In Various States 194 unit: containers 195 chart_type: stacked 196 dimensions: 197 - name: running 198 - name: paused 199 - name: stopped 200 - name: docker_engine.builder_builds_failed_total 201 description: Builder Builds Fails By Reason 202 unit: fails/s 203 chart_type: stacked 204 dimensions: 205 - name: build_canceled 206 - name: build_target_not_reachable_error 207 - name: command_not_supported_error 208 - name: dockerfile_empty_error 209 - name: dockerfile_syntax_error 210 - name: error_processing_commands_error 211 - name: missing_onbuild_arguments_error 212 - name: unknown_instruction_error 213 - name: docker_engine.engine_daemon_health_checks_failed_total 214 description: Health Checks 215 unit: events/s 216 chart_type: line 217 dimensions: 218 - name: fails 219 - name: docker_engine.swarm_manager_leader 220 description: Swarm Manager Leader 221 unit: bool 222 chart_type: line 223 dimensions: 224 - name: is_leader 225 - name: docker_engine.swarm_manager_object_store 226 description: Swarm Manager Object Store 227 unit: objects 228 chart_type: stacked 229 dimensions: 230 - name: nodes 231 - name: services 232 - name: tasks 233 - name: networks 234 - name: secrets 235 - name: configs 236 - name: docker_engine.swarm_manager_nodes_per_state 237 description: Swarm Manager Nodes Per State 238 unit: nodes 239 chart_type: stacked 240 dimensions: 241 - name: ready 242 - name: down 243 - name: unknown 244 - name: disconnected 245 - name: docker_engine.swarm_manager_tasks_per_state 246 description: Swarm Manager Tasks Per State 247 unit: tasks 248 chart_type: stacked 249 dimensions: 250 - name: running 251 - name: failed 252 - name: ready 253 - name: rejected 254 - name: starting 255 - name: shutdown 256 - name: new 257 - name: orphaned 258 - name: preparing 259 - name: pending 260 - name: complete 261 - name: remove 262 - name: accepted 263 - name: assigned