github.com/netdata/go.d.plugin@v0.58.1/modules/coredns/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-coredns 5 plugin_name: go.d.plugin 6 module_name: coredns 7 monitored_instance: 8 name: CoreDNS 9 link: https://coredns.io/ 10 icon_filename: coredns.svg 11 categories: 12 - data-collection.dns-and-dhcp-servers 13 keywords: 14 - coredns 15 - dns 16 - kubernetes 17 related_resources: 18 integrations: 19 list: [] 20 info_provided_to_referring_integrations: 21 description: "" 22 most_popular: false 23 overview: 24 data_collection: 25 metrics_description: | 26 This collector monitors CoreDNS instances. 27 method_description: "" 28 supported_platforms: 29 include: [] 30 exclude: [] 31 multi_instance: true 32 additional_permissions: 33 description: "" 34 default_behavior: 35 auto_detection: 36 description: "" 37 limits: 38 description: "" 39 performance_impact: 40 description: "" 41 setup: 42 prerequisites: 43 list: [] 44 configuration: 45 file: 46 name: go.d/coredns.conf 47 options: 48 description: | 49 The following options can be defined globally: update_every, autodetection_retry. 50 folding: 51 title: All options 52 enabled: true 53 list: 54 - name: update_every 55 description: Data collection frequency. 56 default_value: 1 57 required: false 58 - name: autodetection_retry 59 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 60 default_value: 0 61 required: false 62 - name: url 63 description: Server URL. 64 default_value: http://127.0.0.1:9153/metrics 65 required: true 66 - name: per_server_stats 67 description: Server filter. 68 default_value: "" 69 required: false 70 detailed_description: | 71 Metrics of servers matching the selector will be collected. 72 - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4) 73 - Pattern syntax: [matcher](https://github.com/netdata/go.d.plugin/tree/master/pkg/matcher#supported-format). 74 - Syntax: 75 76 ```yaml 77 per_server_stats: 78 includes: 79 - pattern1 80 - pattern2 81 excludes: 82 - pattern3 83 - pattern4 84 ``` 85 - name: per_zone_stats 86 description: Zone filter. 87 default_value: "" 88 required: false 89 detailed_description: | 90 Metrics of zones matching the selector will be collected. 91 - Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4) 92 - Pattern syntax: [matcher](https://github.com/netdata/go.d.plugin/tree/master/pkg/matcher#supported-format). 93 - Syntax: 94 95 ```yaml 96 per_zone_stats: 97 includes: 98 - pattern1 99 - pattern2 100 excludes: 101 - pattern3 102 - pattern4 103 ``` 104 - name: username 105 description: Username for basic HTTP authentication. 106 default_value: "" 107 required: false 108 - name: password 109 description: Password for basic HTTP authentication. 110 default_value: "" 111 required: false 112 - name: proxy_url 113 description: Proxy URL. 114 default_value: "" 115 required: false 116 - name: proxy_username 117 description: Username for proxy basic HTTP authentication. 118 default_value: "" 119 required: false 120 - name: proxy_password 121 description: Password for proxy basic HTTP authentication. 122 default_value: "" 123 required: false 124 - name: timeout 125 description: HTTP request timeout. 126 default_value: 2 127 required: false 128 - name: method 129 description: HTTP request method. 130 default_value: GET 131 required: false 132 - name: body 133 description: HTTP request body. 134 default_value: "" 135 required: false 136 - name: headers 137 description: HTTP request headers. 138 default_value: "" 139 required: false 140 - name: not_follow_redirects 141 description: Redirect handling policy. Controls whether the client follows redirects. 142 default_value: false 143 required: false 144 - name: tls_skip_verify 145 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 146 default_value: false 147 required: false 148 - name: tls_ca 149 description: Certification authority that the client uses when verifying the server's certificates. 150 default_value: "" 151 required: false 152 - name: tls_cert 153 description: Client tls certificate. 154 default_value: "" 155 required: false 156 - name: tls_key 157 description: Client tls key. 158 default_value: "" 159 required: false 160 examples: 161 folding: 162 title: Config 163 enabled: true 164 list: 165 - name: Basic 166 description: An example configuration. 167 config: | 168 jobs: 169 - name: local 170 url: http://127.0.0.1:9153/metrics 171 - name: Basic HTTP auth 172 description: Local server with basic HTTP authentication. 173 config: | 174 jobs: 175 - name: local 176 url: http://127.0.0.1:9153/metrics 177 username: foo 178 password: bar 179 - name: Multi-instance 180 description: | 181 > **Note**: When you define multiple jobs, their names must be unique. 182 183 Collecting metrics from local and remote instances. 184 config: | 185 jobs: 186 - name: local 187 url: http://127.0.0.1:9153/metrics 188 189 - name: remote 190 url: http://203.0.113.10:9153/metrics 191 troubleshooting: 192 problems: 193 list: [] 194 alerts: [] 195 metrics: 196 folding: 197 title: Metrics 198 enabled: false 199 description: "" 200 availability: [] 201 scopes: 202 - name: global 203 description: These metrics refer to the entire monitored application. 204 labels: [] 205 metrics: 206 - name: coredns.dns_request_count_total 207 description: Number Of DNS Requests 208 unit: requests/s 209 chart_type: line 210 dimensions: 211 - name: requests 212 - name: coredns.dns_responses_count_total 213 description: Number Of DNS Responses 214 unit: responses/s 215 chart_type: line 216 dimensions: 217 - name: responses 218 - name: coredns.dns_request_count_total_per_status 219 description: Number Of Processed And Dropped DNS Requests 220 unit: requests/s 221 chart_type: stacked 222 dimensions: 223 - name: processed 224 - name: dropped 225 - name: coredns.dns_no_matching_zone_dropped_total 226 description: Number Of Dropped DNS Requests Because Of No Matching Zone 227 unit: requests/s 228 chart_type: line 229 dimensions: 230 - name: dropped 231 - name: coredns.dns_panic_count_total 232 description: Number Of Panics 233 unit: panics/s 234 chart_type: line 235 dimensions: 236 - name: panics 237 - name: coredns.dns_requests_count_total_per_proto 238 description: Number Of DNS Requests Per Transport Protocol 239 unit: requests/s 240 chart_type: stacked 241 dimensions: 242 - name: udp 243 - name: tcp 244 - name: coredns.dns_requests_count_total_per_ip_family 245 description: Number Of DNS Requests Per IP Family 246 unit: requests/s 247 chart_type: stacked 248 dimensions: 249 - name: v4 250 - name: v6 251 - name: coredns.dns_requests_count_total_per_per_type 252 description: Number Of DNS Requests Per Type 253 unit: requests/s 254 chart_type: stacked 255 dimensions: 256 - name: a 257 - name: aaaa 258 - name: mx 259 - name: soa 260 - name: cname 261 - name: ptr 262 - name: txt 263 - name: ns 264 - name: ds 265 - name: dnskey 266 - name: rrsig 267 - name: nsec 268 - name: nsec3 269 - name: ixfr 270 - name: any 271 - name: other 272 - name: coredns.dns_responses_count_total_per_rcode 273 description: Number Of DNS Responses Per Rcode 274 unit: responses/s 275 chart_type: stacked 276 dimensions: 277 - name: noerror 278 - name: formerr 279 - name: servfail 280 - name: nxdomain 281 - name: notimp 282 - name: refused 283 - name: yxdomain 284 - name: yxrrset 285 - name: nxrrset 286 - name: notauth 287 - name: notzone 288 - name: badsig 289 - name: badkey 290 - name: badtime 291 - name: badmode 292 - name: badname 293 - name: badalg 294 - name: badtrunc 295 - name: badcookie 296 - name: other 297 - name: server 298 description: These metrics refer to the DNS server. 299 labels: 300 - name: server_name 301 description: Server name. 302 metrics: 303 - name: coredns.server_dns_request_count_total 304 description: Number Of DNS Requests 305 unit: requests/s 306 chart_type: line 307 dimensions: 308 - name: requests 309 - name: coredns.server_dns_responses_count_total 310 description: Number Of DNS Responses 311 unit: responses/s 312 chart_type: line 313 dimensions: 314 - name: responses 315 - name: coredns.server_request_count_total_per_status 316 description: Number Of Processed And Dropped DNS Requests 317 unit: requests/s 318 chart_type: stacked 319 dimensions: 320 - name: processed 321 - name: dropped 322 - name: coredns.server_requests_count_total_per_proto 323 description: Number Of DNS Requests Per Transport Protocol 324 unit: requests/s 325 chart_type: stacked 326 dimensions: 327 - name: udp 328 - name: tcp 329 - name: coredns.server_requests_count_total_per_ip_family 330 description: Number Of DNS Requests Per IP Family 331 unit: requests/s 332 chart_type: stacked 333 dimensions: 334 - name: v4 335 - name: v6 336 - name: coredns.server_requests_count_total_per_per_type 337 description: Number Of DNS Requests Per Type 338 unit: requests/s 339 chart_type: stacked 340 dimensions: 341 - name: a 342 - name: aaaa 343 - name: mx 344 - name: soa 345 - name: cname 346 - name: ptr 347 - name: txt 348 - name: ns 349 - name: ds 350 - name: dnskey 351 - name: rrsig 352 - name: nsec 353 - name: nsec3 354 - name: ixfr 355 - name: any 356 - name: other 357 - name: coredns.server_responses_count_total_per_rcode 358 description: Number Of DNS Responses Per Rcode 359 unit: responses/s 360 chart_type: stacked 361 dimensions: 362 - name: noerror 363 - name: formerr 364 - name: servfail 365 - name: nxdomain 366 - name: notimp 367 - name: refused 368 - name: yxdomain 369 - name: yxrrset 370 - name: nxrrset 371 - name: notauth 372 - name: notzone 373 - name: badsig 374 - name: badkey 375 - name: badtime 376 - name: badmode 377 - name: badname 378 - name: badalg 379 - name: badtrunc 380 - name: badcookie 381 - name: other 382 - name: zone 383 description: These metrics refer to the DNS zone. 384 labels: 385 - name: zone_name 386 description: Zone name. 387 metrics: 388 - name: coredns.zone_dns_request_count_total 389 description: Number Of DNS Requests 390 unit: requests/s 391 chart_type: line 392 dimensions: 393 - name: requests 394 - name: coredns.zone_dns_responses_count_total 395 description: Number Of DNS Responses 396 unit: responses/s 397 chart_type: line 398 dimensions: 399 - name: responses 400 - name: coredns.zone_requests_count_total_per_proto 401 description: Number Of DNS Requests Per Transport Protocol 402 unit: requests/s 403 chart_type: stacked 404 dimensions: 405 - name: udp 406 - name: tcp 407 - name: coredns.zone_requests_count_total_per_ip_family 408 description: Number Of DNS Requests Per IP Family 409 unit: requests/s 410 chart_type: stacked 411 dimensions: 412 - name: v4 413 - name: v6 414 - name: coredns.zone_requests_count_total_per_per_type 415 description: Number Of DNS Requests Per Type 416 unit: requests/s 417 chart_type: stacked 418 dimensions: 419 - name: a 420 - name: aaaa 421 - name: mx 422 - name: soa 423 - name: cname 424 - name: ptr 425 - name: txt 426 - name: ns 427 - name: ds 428 - name: dnskey 429 - name: rrsig 430 - name: nsec 431 - name: nsec3 432 - name: ixfr 433 - name: any 434 - name: other 435 - name: coredns.zone_responses_count_total_per_rcode 436 description: Number Of DNS Responses Per Rcode 437 unit: responses/s 438 chart_type: stacked 439 dimensions: 440 - name: noerror 441 - name: formerr 442 - name: servfail 443 - name: nxdomain 444 - name: notimp 445 - name: refused 446 - name: yxdomain 447 - name: yxrrset 448 - name: nxrrset 449 - name: notauth 450 - name: notzone 451 - name: badsig 452 - name: badkey 453 - name: badtime 454 - name: badmode 455 - name: badname 456 - name: badalg 457 - name: badtrunc 458 - name: badcookie 459 - name: other