summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/isc_dhcpd/metadata.yaml
blob: 56ff3a04576b521d555cd13cc2221b9b83fc08b7 (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
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-isc_dhcpd
      plugin_name: go.d.plugin
      module_name: isc_dhcpd
      monitored_instance:
        name: ISC DHCP
        link: https://www.isc.org/dhcp/
        categories:
          - data-collection.dns-and-dhcp-servers
        icon_filename: isc.png
      keywords:
        - dhcpd
        - dhcp
      most_popular: false
      info_provided_to_referring_integrations:
        description: ""
      related_resources:
        integrations:
          list: []
    overview:
      data_collection:
        metrics_description: |
          This collector monitors ISC DHCP lease usage by reading the DHCP client lease database (dhcpd.leases).
        method_description: ""
      default_behavior:
        auto_detection:
          description: ""
        limits:
          description: ""
        performance_impact:
          description: ""
      additional_permissions:
        description: ""
      multi_instance: true
      supported_platforms:
        include: []
        exclude: []
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: go.d/isc_dhcpd.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: 1
              required: false
            - name: autodetection_retry
              description: Recheck interval in seconds. Zero means no recheck will be scheduled.
              default_value: 0
              required: false
            - name: leases_path
              description: Path to DHCP client lease database.
              default_value: /var/lib/dhcp/dhcpd.leases
              required: false
            - name: pools
              description: List of IP pools to monitor.
              default_value: ""
              required: true
              detailed_description: |
                List of IP pools to monitor.

                - IP range syntax: see [supported formats](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/iprange#supported-formats).
                - Syntax:

                ```yaml
                pools:
                  - name: "POOL_NAME1"
                    networks: "SPACE SEPARATED LIST OF IP RANGES"
                  - name: "POOL_NAME2"
                    networks: "SPACE SEPARATED LIST OF IP RANGES"
                ```
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Basic
              description: A basic example configuration.
              config: |
                jobs:
                  - name: local
                    pools:
                      - name: lan
                        networks: "192.168.0.0/24 192.168.1.0/24 192.168.2.0/24"
                      - name: wifi
                        networks: "10.0.0.0/24"
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: These metrics refer to the entire monitored application.
          labels: []
          metrics:
            - name: isc_dhcpd.active_leases_total
              description: Active Leases Total
              unit: leases
              chart_type: line
              dimensions:
                - name: active
            - name: isc_dhcpd.pool_active_leases
              description: Pool Active Leases
              unit: leases
              chart_type: line
              dimensions:
                - name: a dimension per DHCP pool
            - name: isc_dhcpd.pool_utilization
              description: Pool Utilization
              unit: percentage
              chart_type: line
              dimensions:
                - name: a dimension per DHCP pool