| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-dnsmasq_dhcp |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: dnsmasq_dhcp |
| 7 | monitored_instance: |
| 8 | name: Dnsmasq DHCP |
| 9 | link: https://www.thekelleys.org.uk/dnsmasq/doc.html |
| 10 | icon_filename: dnsmasq.svg |
| 11 | categories: |
| 12 | - data-collection.networking |
| 13 | keywords: |
| 14 | - dnsmasq |
| 15 | - dhcp |
| 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 DHCP leases databases, depending on your configuration. |
| 25 | |
| 26 | By default, it uses: |
| 27 | |
| 28 | - `/var/lib/misc/dnsmasq.leases` to read leases. |
| 29 | - `/etc/dnsmasq.conf` to detect dhcp-ranges. |
| 30 | - `/etc/dnsmasq.d` to find additional configurations. |
| 31 | method_description: "" |
| 32 | supported_platforms: |
| 33 | include: [Linux] |
| 34 | exclude: [] |
| 35 | multi_instance: false |
| 36 | additional_permissions: |
| 37 | description: "" |
| 38 | default_behavior: |
| 39 | auto_detection: |
| 40 | description: | |
| 41 | All configured dhcp-ranges are detected automatically |
| 42 | limits: |
| 43 | description: "" |
| 44 | performance_impact: |
| 45 | description: "" |
| 46 | setup: |
| 47 | prerequisites: |
| 48 | list: [] |
| 49 | configuration: |
| 50 | file: |
| 51 | name: go.d/dnsmasq_dhcp.conf |
| 52 | options: |
| 53 | description: | |
| 54 | The following options can be defined globally: update_every, autodetection_retry. |
| 55 | folding: |
| 56 | title: Config options |
| 57 | enabled: true |
| 58 | list: |
| 59 | - name: update_every |
| 60 | description: Data collection interval (seconds). |
| 61 | default_value: 1 |
| 62 | required: false |
| 63 | group: Collection |
| 64 | - name: autodetection_retry |
| 65 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 66 | default_value: 0 |
| 67 | required: false |
| 68 | group: Collection |
| 69 | |
| 70 | - name: leases_path |
| 71 | description: Path to dnsmasq DHCP leases file. |
| 72 | default_value: /var/lib/misc/dnsmasq.leases |
| 73 | required: false |
| 74 | group: Target |
| 75 | - name: conf_path |
| 76 | description: Path to dnsmasq configuration file (used to extract configured DHCP pools). |
| 77 | default_value: /etc/dnsmasq.conf |
| 78 | required: false |
| 79 | group: Target |
| 80 | - name: conf_dir |
| 81 | description: Path to dnsmasq configuration directory (used to extract configured DHCP pools). |
| 82 | default_value: /etc/dnsmasq.d,.dpkg-dist,.dpkg-old,.dpkg-new |
| 83 | required: false |
| 84 | group: Target |
| 85 | examples: |
| 86 | folding: |
| 87 | title: Config |
| 88 | enabled: true |
| 89 | list: |
| 90 | - name: Basic |
| 91 | description: An example configuration. |
| 92 | config: | |
| 93 | jobs: |
| 94 | - name: dnsmasq_dhcp |
| 95 | leases_path: /var/lib/misc/dnsmasq.leases |
| 96 | conf_path: /etc/dnsmasq.conf |
| 97 | conf_dir: /etc/dnsmasq.d |
| 98 | - name: Pi-hole |
| 99 | description: Dnsmasq DHCP on Pi-hole. |
| 100 | config: | |
| 101 | jobs: |
| 102 | - name: dnsmasq_dhcp |
| 103 | leases_path: /etc/pihole/dhcp.leases |
| 104 | conf_path: /etc/dnsmasq.conf |
| 105 | conf_dir: /etc/dnsmasq.d |
| 106 | troubleshooting: |
| 107 | problems: |
| 108 | list: [] |
| 109 | alerts: |
| 110 | - name: dnsmasq_dhcp_dhcp_range_utilization |
| 111 | metric: dnsmasq_dhcp.dhcp_range_utilization |
| 112 | info: DHCP range utilization |
| 113 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/dnsmasq_dhcp.conf |
| 114 | metrics: |
| 115 | folding: |
| 116 | title: Metrics |
| 117 | enabled: false |
| 118 | description: "" |
| 119 | availability: [] |
| 120 | scopes: |
| 121 | - name: global |
| 122 | description: These metrics refer to the entire monitored application. |
| 123 | labels: [] |
| 124 | metrics: |
| 125 | - name: dnsmasq_dhcp.dhcp_ranges |
| 126 | description: Number of DHCP Ranges |
| 127 | unit: ranges |
| 128 | chart_type: stacked |
| 129 | dimensions: |
| 130 | - name: ipv4 |
| 131 | - name: ipv6 |
| 132 | - name: dnsmasq_dhcp.dhcp_hosts |
| 133 | description: Number of DHCP Hosts |
| 134 | unit: hosts |
| 135 | chart_type: stacked |
| 136 | dimensions: |
| 137 | - name: ipv4 |
| 138 | - name: ipv6 |
| 139 | - name: dhcp range |
| 140 | description: These metrics refer to the DHCP range. |
| 141 | labels: |
| 142 | - name: dhcp_range |
| 143 | description: DHCP range in `START_IP:END_IP` format |
| 144 | metrics: |
| 145 | - name: dnsmasq_dhcp.dhcp_range_utilization |
| 146 | description: DHCP Range utilization |
| 147 | unit: percentage |
| 148 | chart_type: line |
| 149 | dimensions: |
| 150 | - name: used |
| 151 | - name: dnsmasq_dhcp.dhcp_range_allocated_leases |
| 152 | description: DHCP Range Allocated Leases |
| 153 | unit: leases |
| 154 | chart_type: line |
| 155 | dimensions: |
| 156 | - name: allocated |