| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-dnsdist |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: dnsdist |
| 7 | monitored_instance: |
| 8 | name: DNSdist |
| 9 | link: https://dnsdist.org/ |
| 10 | icon_filename: network-wired.svg |
| 11 | categories: |
| 12 | - data-collection.networking |
| 13 | keywords: |
| 14 | - dnsdist |
| 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 DNSDist 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 DNSdist built-in Webserver |
| 43 | description: | |
| 44 | For collecting metrics via HTTP, you need to [enable the built-in webserver](https://dnsdist.org/guides/webserver.html). |
| 45 | configuration: |
| 46 | file: |
| 47 | name: go.d/dnsdist.conf |
| 48 | options: |
| 49 | description: | |
| 50 | The following options can be defined globally: update_every, autodetection_retry. |
| 51 | folding: |
| 52 | title: Config options |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update_every |
| 56 | description: Data collection interval (seconds). |
| 57 | default_value: 1 |
| 58 | required: false |
| 59 | group: Collection |
| 60 | - name: autodetection_retry |
| 61 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 62 | default_value: 0 |
| 63 | required: false |
| 64 | group: Collection |
| 65 | |
| 66 | - name: url |
| 67 | description: Target endpoint URL. |
| 68 | default_value: http://127.0.0.1:8083 |
| 69 | required: true |
| 70 | group: Target |
| 71 | - name: timeout |
| 72 | description: HTTP request timeout (seconds). |
| 73 | default_value: 1 |
| 74 | required: false |
| 75 | group: Target |
| 76 | |
| 77 | - name: username |
| 78 | description: Username for Basic HTTP authentication. |
| 79 | default_value: "" |
| 80 | required: false |
| 81 | group: HTTP Auth |
| 82 | - name: password |
| 83 | description: Password for Basic HTTP authentication. |
| 84 | default_value: "" |
| 85 | required: false |
| 86 | group: HTTP Auth |
| 87 | - name: bearer_token_file |
| 88 | description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)." |
| 89 | default_value: "" |
| 90 | required: false |
| 91 | group: HTTP Auth |
| 92 | |
| 93 | - name: tls_skip_verify |
| 94 | description: Skip TLS certificate and hostname verification (insecure). |
| 95 | default_value: no |
| 96 | required: false |
| 97 | group: TLS |
| 98 | - name: tls_ca |
| 99 | description: Path to CA bundle used to validate the server certificate. |
| 100 | default_value: "" |
| 101 | required: false |
| 102 | group: TLS |
| 103 | - name: tls_cert |
| 104 | description: Path to client TLS certificate (for mTLS). |
| 105 | default_value: "" |
| 106 | required: false |
| 107 | group: TLS |
| 108 | - name: tls_key |
| 109 | description: Path to client TLS private key (for mTLS). |
| 110 | default_value: "" |
| 111 | required: false |
| 112 | group: TLS |
| 113 | |
| 114 | - name: proxy_url |
| 115 | description: HTTP proxy URL. |
| 116 | default_value: "" |
| 117 | required: false |
| 118 | group: Proxy |
| 119 | - name: proxy_username |
| 120 | description: Username for proxy Basic HTTP authentication. |
| 121 | default_value: "" |
| 122 | required: false |
| 123 | group: Proxy |
| 124 | - name: proxy_password |
| 125 | description: Password for proxy Basic HTTP authentication. |
| 126 | default_value: "" |
| 127 | required: false |
| 128 | group: Proxy |
| 129 | |
| 130 | - name: method |
| 131 | description: HTTP method to use. |
| 132 | default_value: "GET" |
| 133 | required: false |
| 134 | group: Request |
| 135 | - name: body |
| 136 | description: Request body (e.g., for POST/PUT). |
| 137 | default_value: "" |
| 138 | required: false |
| 139 | group: Request |
| 140 | - name: headers |
| 141 | description: "Additional HTTP headers (one per line as key: value)." |
| 142 | default_value: "" |
| 143 | required: false |
| 144 | group: Request |
| 145 | - name: not_follow_redirects |
| 146 | description: Do not follow HTTP redirects. |
| 147 | default_value: no |
| 148 | required: false |
| 149 | group: Request |
| 150 | - name: force_http2 |
| 151 | description: Force HTTP/2 (including h2c over TCP). |
| 152 | default_value: no |
| 153 | required: false |
| 154 | group: Request |
| 155 | |
| 156 | - name: vnode |
| 157 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 158 | default_value: "" |
| 159 | required: false |
| 160 | group: Virtual Node |
| 161 | examples: |
| 162 | folding: |
| 163 | title: Config |
| 164 | enabled: true |
| 165 | list: |
| 166 | - name: Basic |
| 167 | description: An example configuration. |
| 168 | config: | |
| 169 | jobs: |
| 170 | - name: local |
| 171 | url: http://127.0.0.1:8083 |
| 172 | headers: |
| 173 | X-API-Key: your-api-key # static pre-shared authentication key for access to the REST API (api-key). |
| 174 | - name: Multi-instance |
| 175 | description: | |
| 176 | > **Note**: When you define multiple jobs, their names must be unique. |
| 177 | |
| 178 | Collecting metrics from local and remote instances. |
| 179 | config: | |
| 180 | jobs: |
| 181 | - name: local |
| 182 | url: http://127.0.0.1:8083 |
| 183 | headers: |
| 184 | X-API-Key: 'your-api-key' # static pre-shared authentication key for access to the REST API (api-key). |
| 185 | |
| 186 | - name: remote |
| 187 | url: http://203.0.113.0:8083 |
| 188 | headers: |
| 189 | X-API-Key: 'your-api-key' |
| 190 | troubleshooting: |
| 191 | problems: |
| 192 | list: [] |
| 193 | alerts: [] |
| 194 | metrics: |
| 195 | folding: |
| 196 | title: Metrics |
| 197 | enabled: false |
| 198 | description: "" |
| 199 | availability: [] |
| 200 | scopes: |
| 201 | - name: global |
| 202 | description: These metrics refer to the entire monitored application. |
| 203 | labels: [] |
| 204 | metrics: |
| 205 | - name: dnsdist.queries |
| 206 | description: Client queries received |
| 207 | unit: queries/s |
| 208 | chart_type: line |
| 209 | dimensions: |
| 210 | - name: all |
| 211 | - name: recursive |
| 212 | - name: empty |
| 213 | - name: dnsdist.queries_dropped |
| 214 | description: Client queries dropped |
| 215 | unit: queries/s |
| 216 | chart_type: line |
| 217 | dimensions: |
| 218 | - name: rule_drop |
| 219 | - name: dynamic_blocked |
| 220 | - name: no_policy |
| 221 | - name: non_queries |
| 222 | - name: dnsdist.packets_dropped |
| 223 | description: Packets dropped |
| 224 | unit: packets/s |
| 225 | chart_type: line |
| 226 | dimensions: |
| 227 | - name: acl |
| 228 | - name: dnsdist.answers |
| 229 | description: Answers statistics |
| 230 | unit: answers/s |
| 231 | chart_type: line |
| 232 | dimensions: |
| 233 | - name: self_answered |
| 234 | - name: nxdomain |
| 235 | - name: refused |
| 236 | - name: trunc_failures |
| 237 | - name: dnsdist.backend_responses |
| 238 | description: Backend responses |
| 239 | unit: responses/s |
| 240 | chart_type: line |
| 241 | dimensions: |
| 242 | - name: responses |
| 243 | - name: dnsdist.backend_commerrors |
| 244 | description: Backend communication errors |
| 245 | unit: errors/s |
| 246 | chart_type: line |
| 247 | dimensions: |
| 248 | - name: send_errors |
| 249 | - name: dnsdist.backend_errors |
| 250 | description: Backend error responses |
| 251 | unit: responses/s |
| 252 | chart_type: line |
| 253 | dimensions: |
| 254 | - name: timeouts |
| 255 | - name: servfail |
| 256 | - name: non_compliant |
| 257 | - name: dnsdist.cache |
| 258 | description: Cache performance |
| 259 | unit: answers/s |
| 260 | chart_type: line |
| 261 | dimensions: |
| 262 | - name: hits |
| 263 | - name: misses |
| 264 | - name: dnsdist.servercpu |
| 265 | description: DNSdist server CPU utilization |
| 266 | unit: ms/s |
| 267 | chart_type: stacked |
| 268 | dimensions: |
| 269 | - name: system_state |
| 270 | - name: user_state |
| 271 | - name: dnsdist.servermem |
| 272 | description: DNSdist server memory utilization |
| 273 | unit: MiB |
| 274 | chart_type: area |
| 275 | dimensions: |
| 276 | - name: memory_usage |
| 277 | - name: dnsdist.query_latency |
| 278 | description: Query latency |
| 279 | unit: queries/s |
| 280 | chart_type: stacked |
| 281 | dimensions: |
| 282 | - name: 1ms |
| 283 | - name: 10ms |
| 284 | - name: 50ms |
| 285 | - name: 100ms |
| 286 | - name: 1sec |
| 287 | - name: slow |
| 288 | - name: dnsdist.query_latency_avg |
| 289 | description: Average latency for the last N queries |
| 290 | unit: microseconds |
| 291 | chart_type: line |
| 292 | dimensions: |
| 293 | - name: "100" |
| 294 | - name: 1k |
| 295 | - name: 10k |
| 296 | - name: 1000k |