@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 139 lines 4.35 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-isc_dhcpd
5 plugin_name: go.d.plugin
6 module_name: isc_dhcpd
7 monitored_instance:
8 name: ISC DHCP
9 link: https://www.isc.org/dhcp/
10 categories:
11 - data-collection.networking
12 icon_filename: isc.png
13 keywords:
14 - dhcpd
15 - dhcp
16 info_provided_to_referring_integrations:
17 description: ""
18 related_resources:
19 integrations:
20 list: []
21 overview:
22 data_collection:
23 metrics_description: |
24 This collector monitors ISC DHCP lease usage by reading the DHCP client lease database (dhcpd.leases).
25 method_description: ""
26 default_behavior:
27 auto_detection:
28 description: ""
29 limits:
30 description: ""
31 performance_impact:
32 description: ""
33 additional_permissions:
34 description: ""
35 multi_instance: true
36 supported_platforms:
37 include: [Linux, BSD]
38 exclude: []
39 setup:
40 prerequisites:
41 list: []
42 configuration:
43 file:
44 name: go.d/isc_dhcpd.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: leases_path
64 description: Path to DHCP client lease database.
65 default_value: /var/lib/dhcp/dhcpd.leases
66 required: false
67 group: Target
68 - name: pools
69 description: DHCP IP pools to monitor.
70 default_value: ""
71 required: true
72 group: Target
73 detailed_description: |
74 List of IP pools to monitor.
75
76 - IP range syntax: see [supported formats](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/pkg/iprange#supported-formats).
77 - Syntax:
78
79 ```yaml
80 pools:
81 - name: "POOL_NAME1"
82 networks: "SPACE SEPARATED LIST OF IP RANGES"
83 - name: "POOL_NAME2"
84 networks: "SPACE SEPARATED LIST OF IP RANGES"
85 ```
86 examples:
87 folding:
88 title: Config
89 enabled: true
90 list:
91 - name: Basic
92 description: A basic example configuration.
93 config: |
94 jobs:
95 - name: local
96 pools:
97 - name: lan
98 networks: "192.168.0.0/24 192.168.1.0/24 192.168.2.0/24"
99 - name: wifi
100 networks: "10.0.0.0/24"
101 troubleshooting:
102 problems:
103 list: []
104 alerts: []
105 metrics:
106 folding:
107 title: Metrics
108 enabled: false
109 description: ""
110 availability: []
111 scopes:
112 - name: global
113 description: These metrics refer to the entire monitored application.
114 labels: []
115 metrics:
116 - name: isc_dhcpd.active_leases_total
117 description: Active Leases Total
118 unit: leases
119 chart_type: line
120 dimensions:
121 - name: active
122 - name: global
123 description: These metrics refer to the DHCP pool.
124 labels:
125 - name: dhcp_pool_name
126 description: The DHCP pool name defined in the collector configuration.
127 metrics:
128 - name: isc_dhcpd.dhcp_pool_utilization
129 description: DHCP Pool Utilization
130 unit: percent
131 chart_type: area
132 dimensions:
133 - name: utilization
134 - name: isc_dhcpd.dhcp_pool_active_leases
135 description: Active Leases Total
136 unit: leases
137 chart_type: line
138 dimensions:
139 - name: active