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