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

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