github.com/netdata/go.d.plugin@v0.58.1/modules/pihole/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-pihole 5 plugin_name: go.d.plugin 6 module_name: pihole 7 monitored_instance: 8 name: Pi-hole 9 link: https://pi-hole.net 10 icon_filename: pihole.png 11 categories: 12 - data-collection.dns-and-dhcp-servers 13 keywords: 14 - pihole 15 related_resources: 16 integrations: 17 list: [] 18 info_provided_to_referring_integrations: 19 description: "" 20 most_popular: false 21 overview: 22 data_collection: 23 metrics_description: | 24 This collector monitors Pi-hole instances using [PHP API](https://github.com/pi-hole/AdminLTE). 25 26 The data provided by the API is for the last 24 hours. All collected values refer to this time period and not to the 27 module's collection interval. 28 method_description: "" 29 supported_platforms: 30 include: [] 31 exclude: [] 32 multi_instance: true 33 additional_permissions: 34 description: "" 35 default_behavior: 36 auto_detection: 37 description: "" 38 limits: 39 description: "" 40 performance_impact: 41 description: "" 42 setup: 43 prerequisites: 44 list: [] 45 configuration: 46 file: 47 name: go.d/pihole.conf 48 options: 49 description: | 50 The following options can be defined globally: update_every, autodetection_retry. 51 folding: 52 title: Config options 53 enabled: true 54 list: 55 - name: update_every 56 description: Data collection frequency. 57 default_value: 5 58 required: false 59 - name: autodetection_retry 60 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 61 default_value: 0 62 required: false 63 - name: url 64 description: Server URL. 65 default_value: http://127.0.0.1 66 required: true 67 - name: setup_vars_path 68 description: Path to setupVars.conf. This file is used to get the web password. 69 default_value: /etc/pihole/setupVars.conf 70 required: false 71 - name: timeout 72 description: HTTP request timeout. 73 default_value: 5 74 required: false 75 - name: username 76 description: Username for basic HTTP authentication. 77 default_value: "" 78 required: false 79 - name: password 80 description: Password for basic HTTP authentication. 81 default_value: "" 82 required: false 83 - name: proxy_url 84 description: Proxy URL. 85 default_value: "" 86 required: false 87 - name: proxy_username 88 description: Username for proxy basic HTTP authentication. 89 default_value: "" 90 required: false 91 - name: proxy_password 92 description: Password for proxy basic HTTP authentication. 93 default_value: "" 94 required: false 95 - name: method 96 description: HTTP request method. 97 default_value: GET 98 required: false 99 - name: body 100 description: HTTP request body. 101 default_value: "" 102 required: false 103 - name: headers 104 description: HTTP request headers. 105 default_value: "" 106 required: false 107 - name: not_follow_redirects 108 description: Redirect handling policy. Controls whether the client follows redirects. 109 default_value: false 110 required: false 111 - name: tls_skip_verify 112 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 113 default_value: false 114 required: false 115 - name: tls_ca 116 description: Certification authority that the client uses when verifying the server's certificates. 117 default_value: "" 118 required: false 119 - name: tls_cert 120 description: Client TLS certificate. 121 default_value: "" 122 required: false 123 - name: tls_key 124 description: Client TLS key. 125 default_value: "" 126 required: false 127 examples: 128 folding: 129 title: Config 130 enabled: true 131 list: 132 - name: Basic 133 description: A basic example configuration. 134 config: | 135 jobs: 136 - name: local 137 url: http://127.0.0.1 138 - name: HTTPS with self-signed certificate 139 description: Remote instance with enabled HTTPS and self-signed certificate. 140 config: | 141 jobs: 142 - name: local 143 url: https://203.0.113.11 144 tls_skip_verify: yes 145 password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b 146 - name: Multi-instance 147 description: | 148 > **Note**: When you define multiple jobs, their names must be unique. 149 150 Collecting metrics from local and remote instances. 151 config: | 152 jobs: 153 - name: local 154 url: http://127.0.0.1 155 156 - name: remote 157 url: http://203.0.113.10 158 password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b 159 troubleshooting: 160 problems: 161 list: [] 162 alerts: 163 - name: pihole_blocklist_last_update 164 metric: pihole.blocklist_last_update 165 info: "gravity.list (blocklist) file last update time" 166 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/pihole.conf 167 - name: pihole_status 168 metric: pihole.unwanted_domains_blocking_status 169 info: unwanted domains blocking is disabled 170 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/pihole.conf 171 metrics: 172 folding: 173 title: Metrics 174 enabled: false 175 description: "" 176 availability: [] 177 scopes: 178 - name: global 179 description: These metrics refer to the entire monitored application. 180 labels: [] 181 metrics: 182 - name: pihole.dns_queries_total 183 description: DNS Queries Total (Cached, Blocked and Forwarded) 184 unit: queries 185 chart_type: line 186 dimensions: 187 - name: queries 188 - name: pihole.dns_queries 189 description: DNS Queries 190 unit: queries 191 chart_type: stacked 192 dimensions: 193 - name: cached 194 - name: blocked 195 - name: forwarded 196 - name: pihole.dns_queries_percentage 197 description: DNS Queries Percentage 198 unit: percentage 199 chart_type: stacked 200 dimensions: 201 - name: cached 202 - name: blocked 203 - name: forwarded 204 - name: pihole.unique_clients 205 description: Unique Clients 206 unit: clients 207 chart_type: line 208 dimensions: 209 - name: unique 210 - name: pihole.domains_on_blocklist 211 description: Domains On Blocklist 212 unit: domains 213 chart_type: line 214 dimensions: 215 - name: blocklist 216 - name: pihole.blocklist_last_update 217 description: Blocklist Last Update 218 unit: seconds 219 chart_type: line 220 dimensions: 221 - name: ago 222 - name: pihole.unwanted_domains_blocking_status 223 description: Unwanted Domains Blocking Status 224 unit: status 225 chart_type: line 226 dimensions: 227 - name: enabled 228 - name: disabled 229 - name: pihole.dns_queries_types 230 description: DNS Queries Per Type 231 unit: percentage 232 chart_type: stacked 233 dimensions: 234 - name: a 235 - name: aaaa 236 - name: any 237 - name: ptr 238 - name: soa 239 - name: srv 240 - name: txt 241 - name: pihole.dns_queries_forwarded_destination 242 description: DNS Queries Per Destination 243 unit: percentage 244 chart_type: stacked 245 dimensions: 246 - name: cached 247 - name: blocked 248 - name: other