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