blob: b6ef9656f102d2a55b36a49fc28fcef8ae25fd44 (
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-pihole
plugin_name: go.d.plugin
module_name: pihole
monitored_instance:
name: Pi-hole
link: https://pi-hole.net
icon_filename: pihole.png
categories:
- data-collection.dns-and-dhcp-servers
keywords:
- pihole
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
most_popular: false
overview:
data_collection:
metrics_description: |
This collector monitors Pi-hole instances using [PHP API](https://github.com/pi-hole/AdminLTE).
The data provided by the API is for the last 24 hours. All collected values refer to this time period and not to the
module's collection interval.
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/pihole.conf
options:
description: |
The following options can be defined globally: update_every, autodetection_retry.
folding:
title: Config options
enabled: true
list:
- name: update_every
description: Data collection frequency.
default_value: 5
required: false
- name: autodetection_retry
description: Recheck interval in seconds. Zero means no recheck will be scheduled.
default_value: 0
required: false
- name: url
description: Server URL.
default_value: http://127.0.0.1
required: true
- name: setup_vars_path
description: Path to setupVars.conf. This file is used to get the web password.
default_value: /etc/pihole/setupVars.conf
required: false
- name: timeout
description: HTTP request timeout.
default_value: 5
required: false
- name: username
description: Username for basic HTTP authentication.
default_value: ""
required: false
- name: password
description: Password for basic HTTP authentication.
default_value: ""
required: false
- name: proxy_url
description: Proxy URL.
default_value: ""
required: false
- name: proxy_username
description: Username for proxy basic HTTP authentication.
default_value: ""
required: false
- name: proxy_password
description: Password for proxy basic HTTP authentication.
default_value: ""
required: false
- name: method
description: HTTP request method.
default_value: GET
required: false
- name: body
description: HTTP request body.
default_value: ""
required: false
- name: headers
description: HTTP request headers.
default_value: ""
required: false
- name: not_follow_redirects
description: Redirect handling policy. Controls whether the client follows redirects.
default_value: false
required: false
- name: tls_skip_verify
description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
default_value: false
required: false
- name: tls_ca
description: Certification authority that the client uses when verifying the server's certificates.
default_value: ""
required: false
- name: tls_cert
description: Client TLS certificate.
default_value: ""
required: false
- name: tls_key
description: Client TLS key.
default_value: ""
required: false
examples:
folding:
title: Config
enabled: true
list:
- name: Basic
description: A basic example configuration.
config: |
jobs:
- name: local
url: http://127.0.0.1
- name: HTTPS with self-signed certificate
description: Remote instance with enabled HTTPS and self-signed certificate.
config: |
jobs:
- name: local
url: https://203.0.113.11
tls_skip_verify: yes
password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
config: |
jobs:
- name: local
url: http://127.0.0.1
- name: remote
url: http://203.0.113.10
password: 1ebd33f882f9aa5fac26a7cb74704742f91100228eb322e41b7bd6e6aeb8f74b
troubleshooting:
problems:
list: []
alerts:
- name: pihole_blocklist_last_update
metric: pihole.blocklist_last_update
info: "gravity.list (blocklist) file last update time"
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/pihole.conf
- name: pihole_status
metric: pihole.unwanted_domains_blocking_status
info: unwanted domains blocking is disabled
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/pihole.conf
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: These metrics refer to the entire monitored application.
labels: []
metrics:
- name: pihole.dns_queries_total
description: DNS Queries Total (Cached, Blocked and Forwarded)
unit: queries
chart_type: line
dimensions:
- name: queries
- name: pihole.dns_queries
description: DNS Queries
unit: queries
chart_type: stacked
dimensions:
- name: cached
- name: blocked
- name: forwarded
- name: pihole.dns_queries_percentage
description: DNS Queries Percentage
unit: percentage
chart_type: stacked
dimensions:
- name: cached
- name: blocked
- name: forwarded
- name: pihole.unique_clients
description: Unique Clients
unit: clients
chart_type: line
dimensions:
- name: unique
- name: pihole.domains_on_blocklist
description: Domains On Blocklist
unit: domains
chart_type: line
dimensions:
- name: blocklist
- name: pihole.blocklist_last_update
description: Blocklist Last Update
unit: seconds
chart_type: line
dimensions:
- name: ago
- name: pihole.unwanted_domains_blocking_status
description: Unwanted Domains Blocking Status
unit: status
chart_type: line
dimensions:
- name: enabled
- name: disabled
- name: pihole.dns_queries_types
description: DNS Queries Per Type
unit: percentage
chart_type: stacked
dimensions:
- name: a
- name: aaaa
- name: any
- name: ptr
- name: soa
- name: srv
- name: txt
- name: pihole.dns_queries_forwarded_destination
description: DNS Queries Per Destination
unit: percentage
chart_type: stacked
dimensions:
- name: cached
- name: blocked
- name: other
|
