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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-dnsmasq
     5        plugin_name: go.d.plugin
     6        module_name: dnsmasq
     7        monitored_instance:
     8          name: Dnsmasq
     9          link: https://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          - dns
    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 servers.
    26          method_description: ""
    27        supported_platforms:
    28          include: []
    29          exclude: []
    30        multi_instance: true
    31        additional_permissions:
    32          description: ""
    33        default_behavior:
    34          auto_detection:
    35            description: ""
    36          limits:
    37            description: ""
    38          performance_impact:
    39            description: ""
    40      setup:
    41        prerequisites:
    42          list: []
    43        configuration:
    44          file:
    45            name: go.d/dnsmasq.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: address
    62                description: Server address in `ip:port` format.
    63                default_value: 127.0.0.1:53
    64                required: true
    65              - name: protocol
    66                description: 'DNS query transport protocol. Supported protocols: udp, tcp, tcp-tls.'
    67                default_value: udp
    68                required: false
    69              - name: timeout
    70                description: DNS query timeout (dial, write and read) in seconds.
    71                default_value: 1
    72                required: false
    73          examples:
    74            folding:
    75              title: Config
    76              enabled: true
    77            list:
    78              - name: Basic
    79                description: An example configuration.
    80                config: |
    81                  jobs:
    82                    - name: local
    83                      address: 127.0.0.1:53
    84              - name: Using TCP protocol
    85                description: Local server with specific DNS query transport protocol.
    86                config: |
    87                  jobs:
    88                    - name: local
    89                      address: 127.0.0.1:53
    90                      protocol: tcp
    91              - name: Multi-instance
    92                description: |
    93                  > **Note**: When you define multiple jobs, their names must be unique.
    94                  
    95                  Collecting metrics from local and remote instances.
    96                config: |
    97                  jobs:
    98                    - name: local
    99                      address: 127.0.0.1:53
   100                  
   101                    - name: remote
   102                      address: 203.0.113.0:53
   103      troubleshooting:
   104        problems:
   105          list: []
   106      alerts: []
   107      metrics:
   108        folding:
   109          title: Metrics
   110          enabled: false
   111        description: ""
   112        availability: []
   113        scopes:
   114          - name: global
   115            description: The metrics apply to the entire monitored application.
   116            labels: []
   117            metrics:
   118              - name: dnsmasq.servers_queries
   119                description: Queries forwarded to the upstream servers
   120                unit: queries/s
   121                chart_type: line
   122                dimensions:
   123                  - name: success
   124                  - name: failed
   125              - name: dnsmasq.cache_performance
   126                description: Cache performance
   127                unit: events/s
   128                chart_type: line
   129                dimensions:
   130                  - name: hist
   131                  - name: misses
   132              - name: dnsmasq.cache_operations
   133                description: Cache operations
   134                unit: operations/s
   135                chart_type: line
   136                dimensions:
   137                  - name: insertions
   138                  - name: evictions
   139              - name: dnsmasq.cache_size
   140                description: Cache size
   141                unit: entries
   142                chart_type: line
   143                dimensions:
   144                  - name: size