github.com/netdata/go.d.plugin@v0.58.1/modules/unbound/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-unbound 5 plugin_name: go.d.plugin 6 module_name: unbound 7 monitored_instance: 8 name: Unbound 9 link: https://nlnetlabs.nl/projects/unbound/about/ 10 icon_filename: unbound.png 11 categories: 12 - data-collection.dns-and-dhcp-servers 13 keywords: 14 - unbound 15 - dns 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: false 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors Unbound servers. 26 method_description: "" 27 supported_platforms: 28 include: [] 29 exclude: [] 30 multi_instance: true 31 additional_permissions: 32 description: "" 33 default_behavior: 34 auto_detection: 35 description: "" 36 limits: 37 description: "" 38 performance_impact: 39 description: "" 40 setup: 41 prerequisites: 42 list: 43 - title: Enable remote control interface 44 description: | 45 Set `control-enable` to yes in [unbound.conf](https://nlnetlabs.nl/documentation/unbound/unbound.conf). 46 - title: Check permissions and adjust if necessary 47 description: | 48 If using unix socket: 49 50 - socket should be readable and writeable by `netdata` user 51 52 If using ip socket and TLS is disabled: 53 54 - socket should be accessible via network 55 56 If TLS is enabled, in addition: 57 58 - `control-key-file` should be readable by `netdata` user 59 - `control-cert-file` should be readable by `netdata` user 60 61 For auto-detection parameters from `unbound.conf`: 62 63 - `unbound.conf` should be readable by `netdata` user 64 - if you have several configuration files (include feature) all of them should be readable by `netdata` user 65 configuration: 66 file: 67 name: go.d/unbound.conf 68 options: 69 description: | 70 The following options can be defined globally: update_every, autodetection_retry. 71 folding: 72 title: Config options 73 enabled: true 74 list: 75 - name: update_every 76 description: Data collection frequency. 77 default_value: 5 78 required: false 79 - name: autodetection_retry 80 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 81 default_value: 0 82 required: false 83 - name: address 84 description: Server address in IP:PORT format. 85 default_value: 127.0.0.1:8953 86 required: true 87 - name: timeout 88 description: Connection/read/write/ssl handshake timeout. 89 default_value: 1 90 required: false 91 - name: conf_path 92 description: Absolute path to the unbound configuration file. 93 default_value: /etc/unbound/unbound.conf 94 required: false 95 - name: cumulative_stats 96 description: Statistics collection mode. Should have the same value as the `statistics-cumulative` parameter in the unbound configuration file. 97 default_value: /etc/unbound/unbound.conf 98 required: false 99 - name: use_tls 100 description: Whether to use TLS or not. 101 default_value: true 102 required: false 103 - name: tls_skip_verify 104 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 105 default_value: true 106 required: false 107 - name: tls_ca 108 description: Certificate authority that client use when verifying server certificates. 109 default_value: "" 110 required: false 111 - name: tls_cert 112 description: Client tls certificate. 113 default_value: /etc/unbound/unbound_control.pem 114 required: false 115 - name: tls_key 116 description: Client tls key. 117 default_value: /etc/unbound/unbound_control.key 118 required: false 119 examples: 120 folding: 121 title: Config 122 enabled: true 123 list: 124 - name: Basic 125 description: An example configuration. 126 config: | 127 jobs: 128 - name: local 129 address: 127.0.0.1:8953 130 - name: Unix socket 131 description: Connecting through Unix socket. 132 config: | 133 jobs: 134 - name: socket 135 address: /var/run/unbound.sock 136 - name: Multi-instance 137 description: | 138 > **Note**: When you define multiple jobs, their names must be unique. 139 140 Local and remote instances. 141 config: | 142 jobs: 143 - name: local 144 address: 127.0.0.1:8953 145 146 - name: remote 147 address: 203.0.113.11:8953 148 troubleshooting: 149 problems: 150 list: [] 151 alerts: [] 152 metrics: 153 folding: 154 title: Metrics 155 enabled: false 156 description: "" 157 availability: [] 158 scopes: 159 - name: global 160 description: These metrics refer to the entire monitored application. 161 labels: [] 162 metrics: 163 - name: unbound.queries 164 description: Received Queries 165 unit: queries 166 chart_type: line 167 dimensions: 168 - name: queries 169 - name: unbound.queries_ip_ratelimited 170 description: Rate Limited Queries 171 unit: queries 172 chart_type: line 173 dimensions: 174 - name: ratelimited 175 - name: unbound.dnscrypt_queries 176 description: DNSCrypt Queries 177 unit: queries 178 chart_type: line 179 dimensions: 180 - name: crypted 181 - name: cert 182 - name: cleartext 183 - name: malformed 184 - name: unbound.cache 185 description: Cache Statistics 186 unit: events 187 chart_type: stacked 188 dimensions: 189 - name: hits 190 - name: miss 191 - name: unbound.cache_percentage 192 description: Cache Statistics Percentage 193 unit: percentage 194 chart_type: stacked 195 dimensions: 196 - name: hits 197 - name: miss 198 - name: unbound.prefetch 199 description: Cache Prefetches 200 unit: prefetches 201 chart_type: line 202 dimensions: 203 - name: prefetches 204 - name: unbound.expired 205 description: Replies Served From Expired Cache 206 unit: replies 207 chart_type: line 208 dimensions: 209 - name: expired 210 - name: unbound.zero_ttl_replies 211 description: Replies Served From Expired Cache 212 unit: replies 213 chart_type: line 214 dimensions: 215 - name: zero_ttl 216 - name: unbound.recursive_replies 217 description: Replies That Needed Recursive Processing 218 unit: replies 219 chart_type: line 220 dimensions: 221 - name: recursive 222 - name: unbound.recursion_time 223 description: Time Spent On Recursive Processing 224 unit: milliseconds 225 chart_type: line 226 dimensions: 227 - name: avg 228 - name: median 229 - name: unbound.request_list_usage 230 description: Request List Usage 231 unit: queries 232 chart_type: line 233 dimensions: 234 - name: avg 235 - name: max 236 - name: unbound.current_request_list_usage 237 description: Current Request List Usage 238 unit: queries 239 chart_type: area 240 dimensions: 241 - name: all 242 - name: users 243 - name: unbound.request_list_jostle_list 244 description: Request List Jostle List Events 245 unit: queries 246 chart_type: line 247 dimensions: 248 - name: overwritten 249 - name: dropped 250 - name: unbound.tcpusage 251 description: TCP Handler Buffers 252 unit: buffers 253 chart_type: line 254 dimensions: 255 - name: usage 256 - name: unbound.uptime 257 description: Uptime 258 unit: seconds 259 chart_type: line 260 dimensions: 261 - name: time 262 - name: unbound.cache_memory 263 description: Cache Memory 264 unit: KB 265 chart_type: stacked 266 dimensions: 267 - name: message 268 - name: rrset 269 - name: dnscrypt_nonce 270 - name: dnscrypt_shared_secret 271 - name: unbound.mod_memory 272 description: Module Memory 273 unit: KB 274 chart_type: stacked 275 dimensions: 276 - name: iterator 277 - name: respip 278 - name: validator 279 - name: subnet 280 - name: ipsec 281 - name: unbound.mem_streamwait 282 description: TCP and TLS Stream Waif Buffer Memory 283 unit: KB 284 chart_type: line 285 dimensions: 286 - name: streamwait 287 - name: unbound.cache_count 288 description: Cache Items Count 289 unit: items 290 chart_type: stacked 291 dimensions: 292 - name: infra 293 - name: key 294 - name: msg 295 - name: rrset 296 - name: dnscrypt_nonce 297 - name: shared_secret 298 - name: unbound.type_queries 299 description: Queries By Type 300 unit: queries 301 chart_type: stacked 302 dimensions: 303 - name: a dimension per query type 304 - name: unbound.class_queries 305 description: Queries By Class 306 unit: queries 307 chart_type: stacked 308 dimensions: 309 - name: a dimension per query class 310 - name: unbound.opcode_queries 311 description: Queries By OpCode 312 unit: queries 313 chart_type: stacked 314 dimensions: 315 - name: a dimension per query opcode 316 - name: unbound.flag_queries 317 description: Queries By Flag 318 unit: queries 319 chart_type: stacked 320 dimensions: 321 - name: qr 322 - name: aa 323 - name: tc 324 - name: rd 325 - name: ra 326 - name: z 327 - name: ad 328 - name: cd 329 - name: unbound.rcode_answers 330 description: Replies By RCode 331 unit: replies 332 chart_type: stacked 333 dimensions: 334 - name: a dimension per reply rcode 335 - name: thread 336 description: These metrics refer to threads. 337 labels: [] 338 metrics: 339 - name: unbound.thread_queries 340 description: Thread Received Queries 341 unit: queries 342 chart_type: line 343 dimensions: 344 - name: queries 345 - name: unbound.thread_queries_ip_ratelimited 346 description: Thread Rate Limited Queries 347 unit: queries 348 chart_type: line 349 dimensions: 350 - name: ratelimited 351 - name: unbound.thread_dnscrypt_queries 352 description: Thread DNSCrypt Queries 353 unit: queries 354 chart_type: line 355 dimensions: 356 - name: crypted 357 - name: cert 358 - name: cleartext 359 - name: malformed 360 - name: unbound.thread_cache 361 description: Cache Statistics 362 unit: events 363 chart_type: line 364 dimensions: 365 - name: hits 366 - name: miss 367 - name: unbound.thread_cache_percentage 368 description: Cache Statistics Percentage 369 unit: percentage 370 chart_type: line 371 dimensions: 372 - name: hits 373 - name: miss 374 - name: unbound.thread_prefetch 375 description: Cache Prefetches 376 unit: prefetches 377 chart_type: line 378 dimensions: 379 - name: prefetches 380 - name: unbound.thread_expired 381 description: Replies Served From Expired Cache 382 unit: replies 383 chart_type: line 384 dimensions: 385 - name: expired 386 - name: unbound.thread_zero_ttl_replies 387 description: Replies Served From Expired Cache 388 unit: replies 389 chart_type: line 390 dimensions: 391 - name: zero_ttl 392 - name: unbound.thread_recursive_replies 393 description: Replies That Needed Recursive Processing 394 unit: replies 395 chart_type: line 396 dimensions: 397 - name: recursive 398 - name: unbound.thread_recursion_time 399 description: Time Spent On Recursive Processing 400 unit: milliseconds 401 chart_type: line 402 dimensions: 403 - name: avg 404 - name: median 405 - name: unbound.thread_request_list_usage 406 description: Time Spent On Recursive Processing 407 unit: queries 408 chart_type: line 409 dimensions: 410 - name: avg 411 - name: max 412 - name: unbound.thread_current_request_list_usage 413 description: Current Request List Usage 414 unit: queries 415 chart_type: line 416 dimensions: 417 - name: all 418 - name: users 419 - name: unbound.thread_request_list_jostle_list 420 description: Request List Jostle List Events 421 unit: queries 422 chart_type: line 423 dimensions: 424 - name: overwritten 425 - name: dropped 426 - name: unbound.thread_tcpusage 427 description: TCP Handler Buffers 428 unit: buffers 429 chart_type: line 430 dimensions: 431 - name: usage