| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-dns_query |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: dns_query |
| 7 | monitored_instance: |
| 8 | name: DNS query |
| 9 | link: "" |
| 10 | icon_filename: network-wired.svg |
| 11 | categories: |
| 12 | - data-collection.synthetic-testing |
| 13 | keywords: |
| 14 | - dns |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This module monitors DNS query round-trip time (RTT). |
| 24 | method_description: "" |
| 25 | supported_platforms: |
| 26 | include: [] |
| 27 | exclude: [] |
| 28 | multi_instance: true |
| 29 | additional_permissions: |
| 30 | description: "" |
| 31 | default_behavior: |
| 32 | auto_detection: |
| 33 | description: "" |
| 34 | limits: |
| 35 | description: "" |
| 36 | performance_impact: |
| 37 | description: "" |
| 38 | setup: |
| 39 | prerequisites: |
| 40 | list: [] |
| 41 | configuration: |
| 42 | file: |
| 43 | name: go.d/dns_query.conf |
| 44 | options: |
| 45 | description: | |
| 46 | The following options can be defined globally: update_every, autodetection_retry. |
| 47 | folding: |
| 48 | title: All options |
| 49 | enabled: true |
| 50 | list: |
| 51 | - name: update_every |
| 52 | description: Data collection interval (seconds). |
| 53 | default_value: 1 |
| 54 | required: false |
| 55 | group: Collection |
| 56 | - name: autodetection_retry |
| 57 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 58 | default_value: 0 |
| 59 | required: false |
| 60 | group: Collection |
| 61 | |
| 62 | - name: domains |
| 63 | description: One or more domains/subdomains to query. A random domain from the list is selected on each iteration. |
| 64 | default_value: "[]" |
| 65 | required: true |
| 66 | group: Target |
| 67 | - name: servers |
| 68 | description: DNS servers to query. If empty, servers from `/etc/resolv.conf` are used automatically. |
| 69 | default_value: "[]" |
| 70 | required: false |
| 71 | group: Target |
| 72 | - name: timeout |
| 73 | description: Query timeout (seconds). |
| 74 | default_value: 2 |
| 75 | required: false |
| 76 | group: Target |
| 77 | - name: port |
| 78 | description: DNS server port. |
| 79 | default_value: 53 |
| 80 | required: false |
| 81 | group: Target |
| 82 | - name: network |
| 83 | description: "DNS query transport protocol. Options: `udp`, `tcp`, `tcp-tls`." |
| 84 | default_value: udp |
| 85 | required: false |
| 86 | group: Target |
| 87 | |
| 88 | - name: record_types |
| 89 | description: "DNS record types to query. Options: A, AAAA, CNAME, MX, NS, PTR, TXT, SOA, SPF, SRV." |
| 90 | default_value: A |
| 91 | required: false |
| 92 | group: DNS Query |
| 93 | |
| 94 | - name: vnode |
| 95 | 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). |
| 96 | default_value: "" |
| 97 | required: false |
| 98 | group: Virtual Node |
| 99 | examples: |
| 100 | folding: |
| 101 | title: Config |
| 102 | enabled: true |
| 103 | list: |
| 104 | - name: Specific DNS servers |
| 105 | description: An example configuration using Google's public DNS servers. |
| 106 | config: | |
| 107 | jobs: |
| 108 | - name: job1 |
| 109 | record_types: |
| 110 | - A |
| 111 | - AAAA |
| 112 | domains: |
| 113 | - google.com |
| 114 | - github.com |
| 115 | - reddit.com |
| 116 | servers: |
| 117 | - 8.8.8.8 |
| 118 | - 8.8.4.4 |
| 119 | - name: System DNS |
| 120 | description: An example configuration using DNS servers from `/etc/resolv.conf`. |
| 121 | config: | |
| 122 | jobs: |
| 123 | - name: job1 |
| 124 | record_types: |
| 125 | - A |
| 126 | - AAAA |
| 127 | domains: |
| 128 | - google.com |
| 129 | - github.com |
| 130 | - reddit.com |
| 131 | troubleshooting: |
| 132 | problems: |
| 133 | list: [] |
| 134 | alerts: |
| 135 | - name: dns_query_query_status |
| 136 | metric: dns_query.query_status |
| 137 | info: "DNS request type ${label:record_type} to server ${label:server} is unsuccessful" |
| 138 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/dns_query.conf |
| 139 | metrics: |
| 140 | folding: |
| 141 | title: Metrics |
| 142 | enabled: false |
| 143 | description: "" |
| 144 | availability: [] |
| 145 | scopes: |
| 146 | - name: server |
| 147 | description: These metrics refer to the DNS server. |
| 148 | labels: |
| 149 | - name: server |
| 150 | description: DNS server address. |
| 151 | - name: network |
| 152 | description: Network protocol name (tcp, udp, tcp-tls). |
| 153 | - name: record_type |
| 154 | description: DNS record type (e.g. A, AAAA, CNAME). |
| 155 | metrics: |
| 156 | - name: dns_query.query_status |
| 157 | description: DNS Query Status |
| 158 | unit: status |
| 159 | chart_type: line |
| 160 | dimensions: |
| 161 | - name: success |
| 162 | - name: network_error |
| 163 | - name: dns_error |
| 164 | - name: dns_query.query_time |
| 165 | description: DNS Query Time |
| 166 | unit: seconds |
| 167 | chart_type: line |
| 168 | dimensions: |
| 169 | - name: query_time |