github.com/netdata/go.d.plugin@v0.58.1/modules/isc_dhcpd/metadata.yaml (about)

     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.dns-and-dhcp-servers
    12          icon_filename: isc.png
    13        keywords:
    14          - dhcpd
    15          - dhcp
    16        most_popular: false
    17        info_provided_to_referring_integrations:
    18          description: ""
    19        related_resources:
    20          integrations:
    21            list: []
    22      overview:
    23        data_collection:
    24          metrics_description: |
    25            This collector monitors ISC DHCP lease usage by reading the DHCP client lease database (dhcpd.leases).
    26          method_description: ""
    27        default_behavior:
    28          auto_detection:
    29            description: ""
    30          limits:
    31            description: ""
    32          performance_impact:
    33            description: ""
    34        additional_permissions:
    35          description: ""
    36        multi_instance: true
    37        supported_platforms:
    38          include: []
    39          exclude: []
    40      setup:
    41        prerequisites:
    42          list: []
    43        configuration:
    44          file:
    45            name: go.d/isc_dhcpd.conf
    46          options:
    47            description: |
    48              The following options can be defined globally: update_every, autodetection_retry.
    49            folding:
    50              title: Config options
    51              enabled: true
    52            list:
    53              - name: update_every
    54                description: Data collection frequency.
    55                default_value: 1
    56                required: false
    57              - name: autodetection_retry
    58                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    59                default_value: 0
    60                required: false
    61              - name: leases_path
    62                description: Path to DHCP client lease database.
    63                default_value: /var/lib/dhcp/dhcpd.leases
    64                required: false
    65              - name: pools
    66                description: List of IP pools to monitor.
    67                default_value: ""
    68                required: true
    69                detailed_description: |
    70                  List of IP pools to monitor.
    71  
    72                  - IP range syntax: see [supported formats](https://github.com/netdata/go.d.plugin/tree/master/pkg/iprange#supported-formats).
    73                  - Syntax:
    74  
    75                  ```yaml
    76                  pools:
    77                    - name: "POOL_NAME1"
    78                      networks: "SPACE SEPARATED LIST OF IP RANGES"
    79                    - name: "POOL_NAME2"
    80                      networks: "SPACE SEPARATED LIST OF IP RANGES"
    81                  ```
    82          examples:
    83            folding:
    84              title: Config
    85              enabled: true
    86            list:
    87              - name: Basic
    88                description: A basic example configuration.
    89                config: |
    90                  jobs:
    91                    - name: local
    92                      pools:
    93                        - name: lan
    94                          networks: "192.168.0.0/24 192.168.1.0/24 192.168.2.0/24"
    95                        - name: wifi
    96                          networks: "10.0.0.0/24"
    97      troubleshooting:
    98        problems:
    99          list: []
   100      alerts: []
   101      metrics:
   102        folding:
   103          title: Metrics
   104          enabled: false
   105        description: ""
   106        availability: []
   107        scopes:
   108          - name: global
   109            description: These metrics refer to the entire monitored application.
   110            labels: []
   111            metrics:
   112              - name: isc_dhcpd.active_leases_total
   113                description: Active Leases Total
   114                unit: leases
   115                chart_type: line
   116                dimensions:
   117                  - name: active
   118              - name: isc_dhcpd.pool_active_leases
   119                description: Pool Active Leases
   120                unit: leases
   121                chart_type: line
   122                dimensions:
   123                  - name: a dimension per DHCP pool
   124              - name: isc_dhcpd.pool_utilization
   125                description: Pool Utilization
   126                unit: percentage
   127                chart_type: line
   128                dimensions:
   129                  - name: a dimension per DHCP pool