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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-dns_query
     5        plugin_name: go.d.plugin
     6        module_name: dns_query
     7        monitored_instance:
     8          name: DNS query
     9          link: ""
    10          icon_filename: network-wired.svg
    11          categories:
    12            - data-collection.dns-and-dhcp-servers
    13        keywords:
    14          - dns
    15        related_resources:
    16          integrations:
    17            list: []
    18        info_provided_to_referring_integrations:
    19          description: ""
    20        most_popular: false
    21      overview:
    22        data_collection:
    23          metrics_description: |
    24            This module monitors DNS query round-trip time (RTT).
    25          method_description: ""
    26        supported_platforms:
    27          include: []
    28          exclude: []
    29        multi_instance: true
    30        additional_permissions:
    31          description: ""
    32        default_behavior:
    33          auto_detection:
    34            description: ""
    35          limits:
    36            description: ""
    37          performance_impact:
    38            description: ""
    39      setup:
    40        prerequisites:
    41          list: []
    42        configuration:
    43          file:
    44            name: go.d/dns_query.conf
    45          options:
    46            description: |
    47              The following options can be defined globally: update_every, autodetection_retry.
    48            folding:
    49              title: All options
    50              enabled: true
    51            list:
    52              - name: update_every
    53                description: Data collection frequency.
    54                default_value: 1
    55                required: false
    56              - name: autodetection_retry
    57                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    58                default_value: 0
    59                required: false
    60              - name: domains
    61                description: Domain or subdomains to query. The collector will choose a random domain from the list on every iteration.
    62                default_value: ""
    63                required: true
    64              - name: servers
    65                description: Servers to query.
    66                default_value: ""
    67                required: true
    68              - name: port
    69                description: DNS server port.
    70                default_value: 53
    71                required: false
    72              - name: network
    73                description: "Network protocol name. Available options: udp, tcp, tcp-tls."
    74                default_value: udp
    75                required: false
    76              - name: record_types
    77                description: "Query record type. Available options: A, AAAA, CNAME, MX, NS, PTR, TXT, SOA, SPF, TXT, SRV."
    78                default_value: A
    79                required: false
    80              - name: timeout
    81                description: Query read timeout.
    82                default_value: 2
    83                required: false
    84          examples:
    85            folding:
    86              title: Config
    87              enabled: true
    88            list:
    89              - name: Basic
    90                description: An example configuration.
    91                config: |
    92                  jobs:
    93                    - name: job1
    94                      record_types:
    95                        - A
    96                        - AAAA
    97                      domains:
    98                        - google.com
    99                        - github.com
   100                        - reddit.com
   101                      servers:
   102                        - 8.8.8.8
   103                        - 8.8.4.4
   104      troubleshooting:
   105        problems:
   106          list: []
   107      alerts:
   108        - name: dns_query_query_status
   109          metric: dns_query.query_status
   110          info: "DNS request type ${label:record_type} to server ${label:server} is unsuccessful"
   111          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/dns_query.conf
   112      metrics:
   113        folding:
   114          title: Metrics
   115          enabled: false
   116        description: ""
   117        availability: []
   118        scopes:
   119          - name: server
   120            description: These metrics refer to the DNS server.
   121            labels:
   122              - name: server
   123                description: DNS server address.
   124              - name: network
   125                description: Network protocol name (tcp, udp, tcp-tls).
   126              - name: record_type
   127                description: DNS record type (e.g. A, AAAA, CNAME).
   128            metrics:
   129              - name: dns_query.query_status
   130                description: DNS Query Status
   131                unit: status
   132                chart_type: line
   133                dimensions:
   134                  - name: success
   135                  - name: network_error
   136                  - name: dns_error
   137              - name: dns_query.query_time
   138                description: DNS Query Time
   139                unit: seconds
   140                chart_type: line
   141                dimensions:
   142                  - name: query_time