| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-dnsmasq |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: dnsmasq |
| 7 | monitored_instance: |
| 8 | name: Dnsmasq |
| 9 | link: https://thekelleys.org.uk/dnsmasq/doc.html |
| 10 | icon_filename: dnsmasq.svg |
| 11 | categories: |
| 12 | - data-collection.networking |
| 13 | keywords: |
| 14 | - dnsmasq |
| 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 Dnsmasq 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 | configuration: |
| 43 | file: |
| 44 | name: go.d/dnsmasq.conf |
| 45 | options: |
| 46 | description: | |
| 47 | The following options can be defined globally: update_every, autodetection_retry. |
| 48 | folding: |
| 49 | title: Config options |
| 50 | enabled: true |
| 51 | list: |
| 52 | - name: update_every |
| 53 | description: Data collection interval (seconds). |
| 54 | default_value: 1 |
| 55 | required: false |
| 56 | group: Collection |
| 57 | - name: autodetection_retry |
| 58 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 59 | default_value: 0 |
| 60 | required: false |
| 61 | group: Collection |
| 62 | |
| 63 | - name: address |
| 64 | description: Dnsmasq server address (`IP:PORT`). |
| 65 | default_value: 127.0.0.1:53 |
| 66 | required: true |
| 67 | group: Target |
| 68 | - name: protocol |
| 69 | description: "DNS query transport protocol. Options: `udp`, `tcp`, `tcp-tls`." |
| 70 | default_value: udp |
| 71 | required: false |
| 72 | group: Target |
| 73 | - name: timeout |
| 74 | description: DNS query timeout for dial, write, and read (seconds). |
| 75 | default_value: 1 |
| 76 | required: false |
| 77 | group: Target |
| 78 | |
| 79 | - name: vnode |
| 80 | 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). |
| 81 | default_value: "" |
| 82 | required: false |
| 83 | group: Virtual Node |
| 84 | examples: |
| 85 | folding: |
| 86 | title: Config |
| 87 | enabled: true |
| 88 | list: |
| 89 | - name: Basic |
| 90 | description: An example configuration. |
| 91 | config: | |
| 92 | jobs: |
| 93 | - name: local |
| 94 | address: 127.0.0.1:53 |
| 95 | - name: Using TCP protocol |
| 96 | description: Local server with specific DNS query transport protocol. |
| 97 | config: | |
| 98 | jobs: |
| 99 | - name: local |
| 100 | address: 127.0.0.1:53 |
| 101 | protocol: tcp |
| 102 | - name: Multi-instance |
| 103 | description: | |
| 104 | > **Note**: When you define multiple jobs, their names must be unique. |
| 105 | |
| 106 | Collecting metrics from local and remote instances. |
| 107 | config: | |
| 108 | jobs: |
| 109 | - name: local |
| 110 | address: 127.0.0.1:53 |
| 111 | |
| 112 | - name: remote |
| 113 | address: 203.0.113.0:53 |
| 114 | troubleshooting: |
| 115 | problems: |
| 116 | list: [] |
| 117 | alerts: [] |
| 118 | metrics: |
| 119 | folding: |
| 120 | title: Metrics |
| 121 | enabled: false |
| 122 | description: "" |
| 123 | availability: [] |
| 124 | scopes: |
| 125 | - name: global |
| 126 | description: The metrics apply to the entire monitored application. |
| 127 | labels: [] |
| 128 | metrics: |
| 129 | - name: dnsmasq.servers_queries |
| 130 | description: Queries forwarded to the upstream servers |
| 131 | unit: queries/s |
| 132 | chart_type: line |
| 133 | dimensions: |
| 134 | - name: success |
| 135 | - name: failed |
| 136 | - name: dnsmasq.cache_performance |
| 137 | description: Cache performance |
| 138 | unit: events/s |
| 139 | chart_type: line |
| 140 | dimensions: |
| 141 | - name: hist |
| 142 | - name: misses |
| 143 | - name: dnsmasq.cache_operations |
| 144 | description: Cache operations |
| 145 | unit: operations/s |
| 146 | chart_type: line |
| 147 | dimensions: |
| 148 | - name: insertions |
| 149 | - name: evictions |
| 150 | - name: dnsmasq.cache_size |
| 151 | description: Cache size |
| 152 | unit: entries |
| 153 | chart_type: line |
| 154 | dimensions: |
| 155 | - name: size |