github.com/netdata/go.d.plugin@v0.58.1/modules/dnsdist/metadata.yaml (about) 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.dns-and-dhcp-servers 13 keywords: 14 - dnsdist 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 DNSDist 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 DNSdist built-in Webserver 44 description: | 45 For collecting metrics via HTTP, you need to [enable the built-in webserver](https://dnsdist.org/guides/webserver.html). 46 configuration: 47 file: 48 name: go.d/dnsdist.conf 49 options: 50 description: | 51 The following options can be defined globally: update_every, autodetection_retry. 52 folding: 53 title: Config options 54 enabled: true 55 list: 56 - name: update_every 57 description: Data collection frequency. 58 default_value: 1 59 required: false 60 - name: autodetection_retry 61 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 62 default_value: 0 63 required: false 64 - name: url 65 description: Server URL. 66 default_value: http://127.0.0.1:8083 67 required: true 68 - name: username 69 description: Username for basic HTTP authentication. 70 default_value: "" 71 required: false 72 - name: password 73 description: Password for basic HTTP authentication. 74 default_value: "" 75 required: false 76 - name: proxy_url 77 description: Proxy URL. 78 default_value: "" 79 required: false 80 - name: proxy_username 81 description: Username for proxy basic HTTP authentication. 82 default_value: "" 83 required: false 84 - name: proxy_password 85 description: Password for proxy basic HTTP authentication. 86 default_value: "" 87 required: false 88 - name: timeout 89 description: HTTP request timeout. 90 default_value: 1 91 required: false 92 - name: method 93 description: HTTP request method. 94 default_value: GET 95 required: false 96 - name: body 97 description: HTTP request body. 98 default_value: "" 99 required: false 100 - name: headers 101 description: HTTP request headers. 102 default_value: "" 103 required: false 104 - name: not_follow_redirects 105 description: Redirect handling policy. Controls whether the client follows redirects. 106 default_value: false 107 required: false 108 - name: tls_skip_verify 109 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 110 default_value: false 111 required: false 112 - name: tls_ca 113 description: Certification authority that the client uses when verifying the server's certificates. 114 default_value: "" 115 required: false 116 - name: tls_cert 117 description: Client tls certificate. 118 default_value: "" 119 required: false 120 - name: tls_key 121 description: Client tls key. 122 default_value: "" 123 required: false 124 examples: 125 folding: 126 title: Config 127 enabled: true 128 list: 129 - name: Basic 130 description: An example configuration. 131 config: | 132 jobs: 133 - name: local 134 url: http://127.0.0.1:8083 135 headers: 136 X-API-Key: your-api-key # static pre-shared authentication key for access to the REST API (api-key). 137 - name: Multi-instance 138 description: | 139 > **Note**: When you define multiple jobs, their names must be unique. 140 141 Collecting metrics from local and remote instances. 142 config: | 143 jobs: 144 - name: local 145 url: http://127.0.0.1:8083 146 headers: 147 X-API-Key: 'your-api-key' # static pre-shared authentication key for access to the REST API (api-key). 148 149 - name: remote 150 url: http://203.0.113.0:8083 151 headers: 152 X-API-Key: 'your-api-key' 153 troubleshooting: 154 problems: 155 list: [] 156 alerts: [] 157 metrics: 158 folding: 159 title: Metrics 160 enabled: false 161 description: "" 162 availability: [] 163 scopes: 164 - name: global 165 description: These metrics refer to the entire monitored application. 166 labels: [] 167 metrics: 168 - name: dnsdist.queries 169 description: Client queries received 170 unit: queries/s 171 chart_type: line 172 dimensions: 173 - name: all 174 - name: recursive 175 - name: empty 176 - name: dnsdist.queries_dropped 177 description: Client queries dropped 178 unit: queries/s 179 chart_type: line 180 dimensions: 181 - name: rule_drop 182 - name: dynamic_blocked 183 - name: no_policy 184 - name: non_queries 185 - name: dnsdist.packets_dropped 186 description: Packets dropped 187 unit: packets/s 188 chart_type: line 189 dimensions: 190 - name: acl 191 - name: dnsdist.answers 192 description: Answers statistics 193 unit: answers/s 194 chart_type: line 195 dimensions: 196 - name: self_answered 197 - name: nxdomain 198 - name: refused 199 - name: trunc_failures 200 - name: dnsdist.backend_responses 201 description: Backend responses 202 unit: responses/s 203 chart_type: line 204 dimensions: 205 - name: responses 206 - name: dnsdist.backend_commerrors 207 description: Backend communication errors 208 unit: errors/s 209 chart_type: line 210 dimensions: 211 - name: send_errors 212 - name: dnsdist.backend_errors 213 description: Backend error responses 214 unit: responses/s 215 chart_type: line 216 dimensions: 217 - name: timeouts 218 - name: servfail 219 - name: non_compliant 220 - name: dnsdist.cache 221 description: Cache performance 222 unit: answers/s 223 chart_type: line 224 dimensions: 225 - name: hits 226 - name: misses 227 - name: dnsdist.servercpu 228 description: DNSdist server CPU utilization 229 unit: ms/s 230 chart_type: stacked 231 dimensions: 232 - name: system_state 233 - name: user_state 234 - name: dnsdist.servermem 235 description: DNSdist server memory utilization 236 unit: MiB 237 chart_type: area 238 dimensions: 239 - name: memory_usage 240 - name: dnsdist.query_latency 241 description: Query latency 242 unit: queries/s 243 chart_type: stacked 244 dimensions: 245 - name: 1ms 246 - name: 10ms 247 - name: 50ms 248 - name: 100ms 249 - name: 1sec 250 - name: slow 251 - name: dnsdist.query_latency_avg 252 description: Average latency for the last N queries 253 unit: microseconds 254 chart_type: line 255 dimensions: 256 - name: "100" 257 - name: 1k 258 - name: 10k 259 - name: 1000k