summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/dnsquery/metadata.yaml
blob: 8c199550fc86f66e071852adf5c7f8b6866ad1db (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
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-dns_query
      plugin_name: go.d.plugin
      module_name: dns_query
      monitored_instance:
        name: DNS query
        link: ""
        icon_filename: network-wired.svg
        categories:
          - data-collection.dns-and-dhcp-servers
      keywords:
        - dns
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This module monitors DNS query round-trip time (RTT).
        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: []
      configuration:
        file:
          name: go.d/dns_query.conf
        options:
          description: |
            The following options can be defined globally: update_every, autodetection_retry.
          folding:
            title: All 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: domains
              description: Domain or subdomains to query. The collector will choose a random domain from the list on every iteration.
              default_value: ""
              required: true
            - name: servers
              description: Servers to query.
              default_value: ""
              required: true
            - name: port
              description: DNS server port.
              default_value: 53
              required: false
            - name: network
              description: "Network protocol name. Available options: udp, tcp, tcp-tls."
              default_value: udp
              required: false
            - name: record_types
              description: "Query record type. Available options: A, AAAA, CNAME, MX, NS, PTR, TXT, SOA, SPF, TXT, SRV."
              default_value: A
              required: false
            - name: timeout
              description: Query read timeout.
              default_value: 2
              required: false
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Basic
              description: An example configuration.
              config: |
                jobs:
                  - name: job1
                    record_types:
                      - A
                      - AAAA
                    domains:
                      - google.com
                      - github.com
                      - reddit.com
                    servers:
                      - 8.8.8.8
                      - 8.8.4.4
    troubleshooting:
      problems:
        list: []
    alerts:
      - name: dns_query_query_status
        metric: dns_query.query_status
        info: "DNS request type ${label:record_type} to server ${label:server} is unsuccessful"
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/dns_query.conf
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: server
          description: These metrics refer to the DNS server.
          labels:
            - name: server
              description: DNS server address.
            - name: network
              description: Network protocol name (tcp, udp, tcp-tls).
            - name: record_type
              description: DNS record type (e.g. A, AAAA, CNAME).
          metrics:
            - name: dns_query.query_status
              description: DNS Query Status
              unit: status
              chart_type: line
              dimensions:
                - name: success
                - name: network_error
                - name: dns_error
            - name: dns_query.query_time
              description: DNS Query Time
              unit: seconds
              chart_type: line
              dimensions:
                - name: query_time