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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-powerdns_recursor
     5        plugin_name: go.d.plugin
     6        module_name: powerdns_recursor
     7        monitored_instance:
     8          name: PowerDNS Recursor
     9          link: https://doc.powerdns.com/recursor/
    10          icon_filename: powerdns.svg
    11          categories:
    12            - data-collection.dns-and-dhcp-servers
    13        keywords:
    14          - powerdns
    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 PowerDNS Recursor instances.
    26            
    27            It collects metrics from [the internal webserver](https://doc.powerdns.com/recursor/http-api/index.html#built-in-webserver-and-http-api).
    28            
    29            Used endpoints:
    30            
    31            - [`/api/v1/servers/localhost/statistics`](https://doc.powerdns.com/recursor/common/api/endpoint-statistics.html)
    32          method_description: ""
    33        supported_platforms:
    34          include: []
    35          exclude: []
    36        multi_instance: true
    37        additional_permissions:
    38          description: ""
    39        default_behavior:
    40          auto_detection:
    41            description: ""
    42          limits:
    43            description: ""
    44          performance_impact:
    45            description: ""
    46      setup:
    47        prerequisites:
    48          list:
    49            - title: Enable webserver
    50              description: |
    51                Follow [webserver](https://doc.powerdns.com/recursor/http-api/index.html#webserver) documentation.
    52            - title: Enable HTTP API
    53              description: |
    54                Follow [HTTP API](https://doc.powerdns.com/recursor/http-api/index.html#enabling-the-api) documentation.
    55        configuration:
    56          file:
    57            name: go.d/powerdns_recursor.conf
    58          options:
    59            description: |
    60              The following options can be defined globally: update_every, autodetection_retry.
    61            folding:
    62              title: Config options
    63              enabled: true
    64            list:
    65              - name: update_every
    66                description: Data collection frequency.
    67                default_value: 5
    68                required: false
    69              - name: autodetection_retry
    70                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    71                default_value: 0
    72                required: false
    73              - name: url
    74                description: Server URL.
    75                default_value: http://127.0.0.1:8081
    76                required: true
    77              - name: timeout
    78                description: HTTP request timeout.
    79                default_value: 1
    80                required: false
    81              - name: username
    82                description: Username for basic HTTP authentication.
    83                default_value: ""
    84                required: false
    85              - name: password
    86                description: Password for basic HTTP authentication.
    87                default_value: ""
    88                required: false
    89              - name: proxy_url
    90                description: Proxy URL.
    91                default_value: ""
    92                required: false
    93              - name: proxy_username
    94                description: Username for proxy basic HTTP authentication.
    95                default_value: ""
    96                required: false
    97              - name: proxy_password
    98                description: Password for proxy basic HTTP authentication.
    99                default_value: ""
   100                required: false
   101              - name: method
   102                description: HTTP request method.
   103                default_value: GET
   104                required: false
   105              - name: body
   106                description: HTTP request body.
   107                default_value: ""
   108                required: false
   109              - name: headers
   110                description: HTTP request headers.
   111                default_value: ""
   112                required: false
   113              - name: not_follow_redirects
   114                description: Redirect handling policy. Controls whether the client follows redirects.
   115                default_value: false
   116                required: false
   117              - name: tls_skip_verify
   118                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   119                default_value: false
   120                required: false
   121              - name: tls_ca
   122                description: Certification authority that the client uses when verifying the server's certificates.
   123                default_value: ""
   124                required: false
   125              - name: tls_cert
   126                description: Client TLS certificate.
   127                default_value: ""
   128                required: false
   129              - name: tls_key
   130                description: Client TLS key.
   131                default_value: ""
   132                required: false
   133          examples:
   134            folding:
   135              title: Config
   136              enabled: true
   137            list:
   138              - name: Basic
   139                description: An example configuration.
   140                config: |
   141                  jobs:
   142                    - name: local
   143                      url: http://127.0.0.1:8081
   144              - name: HTTP authentication
   145                description: Basic HTTP authentication.
   146                config: |
   147                  jobs:
   148                    - name: local
   149                      url: http://127.0.0.1:8081
   150                      username: admin
   151                      password: password
   152              - name: Multi-instance
   153                description: |
   154                  > **Note**: When you define multiple jobs, their names must be unique.
   155                  
   156                  Local and remote instances.
   157                config: |
   158                  jobs:
   159                    - name: local
   160                      url: http://127.0.0.1:8081
   161                  
   162                    - name: remote
   163                      url: http://203.0.113.0:8081
   164      troubleshooting:
   165        problems:
   166          list: []
   167      alerts: []
   168      metrics:
   169        folding:
   170          title: Metrics
   171          enabled: false
   172        description: ""
   173        availability: []
   174        scopes:
   175          - name: global
   176            description: These metrics refer to the entire monitored application.
   177            labels: []
   178            metrics:
   179              - name: powerdns_recursor.questions_in
   180                description: Incoming questions
   181                unit: questions/s
   182                chart_type: line
   183                dimensions:
   184                  - name: total
   185                  - name: tcp
   186                  - name: ipv6
   187              - name: powerdns_recursor.questions_out
   188                description: Outgoing questions
   189                unit: questions/s
   190                chart_type: line
   191                dimensions:
   192                  - name: udp
   193                  - name: tcp
   194                  - name: ipv6
   195                  - name: throttled
   196              - name: powerdns_recursor.answer_time
   197                description: Queries answered within a time range
   198                unit: queries/s
   199                chart_type: line
   200                dimensions:
   201                  - name: 0-1ms
   202                  - name: 1-10ms
   203                  - name: 10-100ms
   204                  - name: 100-1000ms
   205                  - name: slow
   206              - name: powerdns_recursor.timeouts
   207                description: Timeouts on outgoing UDP queries
   208                unit: timeouts/s
   209                chart_type: line
   210                dimensions:
   211                  - name: total
   212                  - name: ipv4
   213                  - name: ipv6
   214              - name: powerdns_recursor.drops
   215                description: Drops
   216                unit: drops/s
   217                chart_type: line
   218                dimensions:
   219                  - name: over-capacity-drops
   220                  - name: query-pipe-full-drops
   221                  - name: too-old-drops
   222                  - name: truncated-drops
   223                  - name: empty-queries
   224              - name: powerdns_recursor.cache_usage
   225                description: Cache Usage
   226                unit: events/s
   227                chart_type: line
   228                dimensions:
   229                  - name: cache-hits
   230                  - name: cache-misses
   231                  - name: packet-cache-hits
   232                  - name: packet-cache-misses
   233              - name: powerdns_recursor.cache_size
   234                description: Cache Size
   235                unit: entries
   236                chart_type: line
   237                dimensions:
   238                  - name: cache
   239                  - name: packet-cache
   240                  - name: negative-cache