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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-dnsmasq_dhcp
     5        plugin_name: go.d.plugin
     6        module_name: dnsmasq_dhcp
     7        monitored_instance:
     8          name: Dnsmasq DHCP
     9          link: https://www.thekelleys.org.uk/dnsmasq/doc.html
    10          icon_filename: dnsmasq.svg
    11          categories:
    12            - data-collection.dns-and-dhcp-servers
    13        keywords:
    14          - dnsmasq
    15          - dhcp
    16        related_resources:
    17          integrations:
    18            list: []
    19        info_provided_to_referring_integrations:
    20          description: ""
    21        most_popular: false
    22      overview:
    23        data_collection:
    24          metrics_description: |
    25            This collector monitors  Dnsmasq DHCP leases databases, depending on your configuration.
    26            
    27            By default, it uses:
    28  
    29            - `/var/lib/misc/dnsmasq.leases` to read leases.
    30            - `/etc/dnsmasq.conf` to detect dhcp-ranges.
    31            - `/etc/dnsmasq.d` to find additional configurations.
    32          method_description: ""
    33        supported_platforms:
    34          include: []
    35          exclude: []
    36        multi_instance: false
    37        additional_permissions:
    38          description: ""
    39        default_behavior:
    40          auto_detection:
    41            description: |
    42              All configured dhcp-ranges are detected automatically
    43          limits:
    44            description: ""
    45          performance_impact:
    46            description: ""
    47      setup:
    48        prerequisites:
    49          list: []
    50        configuration:
    51          file:
    52            name: go.d/dnsmasq_dhcp.conf
    53          options:
    54            description: |
    55              The following options can be defined globally: update_every, autodetection_retry.
    56            folding:
    57              title: Config options
    58              enabled: true
    59            list:
    60              - name: update_every
    61                description: Data collection frequency.
    62                default_value: 1
    63                required: false
    64              - name: autodetection_retry
    65                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    66                default_value: 0
    67                required: false
    68              - name: leases_path
    69                description: Path to dnsmasq DHCP leases file.
    70                default_value: /var/lib/misc/dnsmasq.leases
    71                required: false
    72              - name: conf_path
    73                description: Path to dnsmasq configuration file.
    74                default_value: /etc/dnsmasq.conf
    75                required: false
    76              - name: conf_dir
    77                description: Path to dnsmasq configuration directory.
    78                default_value: /etc/dnsmasq.d,.dpkg-dist,.dpkg-old,.dpkg-new
    79                required: false
    80          examples:
    81            folding:
    82              title: Config
    83              enabled: true
    84            list:
    85              - name: Basic
    86                description: An example configuration.
    87                config: |
    88                  jobs:
    89                    - name: dnsmasq_dhcp
    90                      leases_path: /var/lib/misc/dnsmasq.leases
    91                      conf_path: /etc/dnsmasq.conf
    92                      conf_dir: /etc/dnsmasq.d
    93              - name: Pi-hole
    94                description: Dnsmasq DHCP on Pi-hole.
    95                config: |
    96                  jobs:
    97                    - name: dnsmasq_dhcp
    98                      leases_path: /etc/pihole/dhcp.leases
    99                      conf_path: /etc/dnsmasq.conf
   100                      conf_dir: /etc/dnsmasq.d
   101      troubleshooting:
   102        problems:
   103          list: []
   104      alerts:
   105        - name: dnsmasq_dhcp_dhcp_range_utilization
   106          metric: dnsmasq_dhcp.dhcp_range_utilization
   107          info: DHCP range utilization
   108          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/dnsmasq_dhcp.conf
   109      metrics:
   110        folding:
   111          title: Metrics
   112          enabled: false
   113        description: ""
   114        availability: []
   115        scopes:
   116          - name: global
   117            description: These metrics refer to the entire monitored application.
   118            labels: []
   119            metrics:
   120              - name: dnsmasq_dhcp.dhcp_ranges
   121                description: Number of DHCP Ranges
   122                unit: ranges
   123                chart_type: stacked
   124                dimensions:
   125                  - name: ipv4
   126                  - name: ipv6
   127              - name: dnsmasq_dhcp.dhcp_hosts
   128                description: Number of DHCP Hosts
   129                unit: hosts
   130                chart_type: stacked
   131                dimensions:
   132                  - name: ipv4
   133                  - name: ipv6
   134          - name: dhcp range
   135            description: These metrics refer to the DHCP range.
   136            labels:
   137              - name: dhcp_range
   138                description: DHCP range in `START_IP:END_IP` format
   139            metrics:
   140              - name: dnsmasq_dhcp.dhcp_range_utilization
   141                description: DHCP Range utilization
   142                unit: percentage
   143                chart_type: line
   144                dimensions:
   145                  - name: used
   146              - name: dnsmasq_dhcp.dhcp_range_allocated_leases
   147                description: DHCP Range Allocated Leases
   148                unit: leases
   149                chart_type: line
   150                dimensions:
   151                  - name: allocated