Adding upstream version 1.42.0.upstream/1.42.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

3 files changed, 197 insertions, 118 deletions

diff --git a/collectors/python.d.plugin/bind_rndc/bind_rndc.conf b/collectors/python.d.plugin/bind_rndc/bind_rndc.conf
index 3b7e9a216..84eaf0594 100644
--- a/collectors/python.d.plugin/bind_rndc/bind_rndc.conf
+++ b/collectors/python.d.plugin/bind_rndc/bind_rndc.conf
@@ -63,14 +63,14 @@
 #
 #     named_stats_path: 'path to named.stats'		# Default: '/var/log/bind/named.stats'
 #------------------------------------------------------------------------------------------------------------------
-# IMPORTANT Information
+# Important Information
 #
-# BIND APPEND logs at EVERY RUN. Its NOT RECOMMENDED to set update_every below 30 sec.
-# STRONGLY RECOMMENDED to create a bind-rndc conf file for logrotate
+# BIND appends logs at EVERY RUN. It is NOT RECOMMENDED to set update_every below 30 sec.
+# It is STRONGLY RECOMMENDED to create a bind-rndc.conf file for logrotate.
 #
 # To set up your BIND to dump stats do the following:
 #
-# 1. add to 'named.conf.options' options {}: 
+# 1. Add to 'named.conf.options' options {}:
 # statistics-file "/var/log/bind/named.stats";
 #
 # 2. Create bind/ directory in /var/log
@@ -83,13 +83,12 @@
 # systemctl reload bind9.service
 #
 # 5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
-# 
 #
-# To ALLOW NETDATA TO RUN 'rndc stats' change '/etc/bind/rndc.key' group to netdata
+# To allow Netdata to run 'rndc stats' change '/etc/bind/rndc.key' group to netdata
 # chown :netdata rndc.key
 #
-# The last BUT NOT least is to create bind-rndc.conf in logrotate.d/
-# The working one
+# Last, BUT NOT least, is to create bind-rndc.conf in logrotate.d/:
+#
 #  /var/log/bind/named.stats {
 #   
 #     daily
@@ -104,7 +103,6 @@
 # }
 #
 # To test your logrotate conf file run as root:
-#
 # logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)
 #
 # ----------------------------------------------------------------------
diff --git a/collectors/python.d.plugin/bind_rndc/metadata.yaml b/collectors/python.d.plugin/bind_rndc/metadata.yaml
index 72c3acff5..1e9fb24fe 100644
--- a/collectors/python.d.plugin/bind_rndc/metadata.yaml
+++ b/collectors/python.d.plugin/bind_rndc/metadata.yaml
@@ -1,105 +1,191 @@
-meta:
-  plugin_name: python.d.plugin
-  module_name: bind_rndc
-  monitored_instance:
-    name: ISCBind (RNDC)
-    link: ''
-    categories:
-    - data-collection.dns-and-dhcp-servers
-    icon_filename: 'isc.png'
-  related_resources:
-    integrations:
-      list: []
-  info_provided_to_referring_integrations:
-    description: ''
-  keywords: []
-  most_popular: false
-overview:
-  data_collection:
-    metrics_description: 'Monitor ISCBind (RNDC) performance for optimal DNS server operations. Monitor query rates, response times, and error rates to ensure reliable DNS service delivery.'
-    method_description: ''
-  supported_platforms:
-    include: []
-    exclude: []
-  multi-instance: true
-  additional_permissions:
-    description: ''
-  default_behavior:
-    auto_detection:
-      description: ''
-    limits:
-      description: ''
-    performance_impact:
-      description: ''
-setup:
-  prerequisites:
-    list: []
-  configuration:
-    file:
-      name: ''
-      description: ''
-    options:
-      description: ''
-      folding:
-        title: ''
-        enabled: true
-      list: []
-    examples:
-      folding:
-        enabled: true
-        title: ''
-      list: []
-troubleshooting:
-  problems:
-    list: []
-alerts:
-- name: bind_rndc_stats_file_size
-  link: https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf
-  metric: bind_rndc.stats_size
-  info: BIND statistics-file size
-metrics:
-  folding:
-    title: Metrics
-    enabled: false
-  description: ""
-  availability: []
-  scopes:
-  - name: global
-    description: ""
-    labels: []
+plugin_name: python.d.plugin
+modules:
+  - meta:
+      plugin_name: python.d.plugin
+      module_name: bind_rndc
+      monitored_instance:
+        name: ISCBind (RNDC)
+        link: "https://www.isc.org/bind/"
+        categories:
+          - data-collection.dns-and-dhcp-servers
+        icon_filename: "isc.png"
+      related_resources:
+        integrations:
+          list: []
+      info_provided_to_referring_integrations:
+        description: ""
+      keywords:
+        - dns
+        - bind
+        - server
+      most_popular: false
+    overview:
+      data_collection:
+        metrics_description: "Monitor ISCBind (RNDC) performance for optimal DNS server operations. Monitor query rates, response times, and error rates to ensure reliable DNS service delivery."
+        method_description: "This collector uses the `rndc` tool to dump (named.stats) statistics then read them to gather Bind Name Server summary performance metrics."
+      supported_platforms:
+        include: []
+        exclude: []
+      multi_instance: false
+      additional_permissions:
+        description: ""
+      default_behavior:
+        auto_detection:
+          description: "If no configuration is given, the collector will attempt to read named.stats file at `/var/log/bind/named.stats`"
+        limits:
+          description: ""
+        performance_impact:
+          description: ""
+    setup:
+      prerequisites:
+        list:
+          - title: "Minimum bind version and permissions"
+            description: "Version of bind must be >=9.6 and the Netdata user must have permissions to run `rndc stats`"
+          - title: "Setup log rotate for bind stats"
+            description: |
+              BIND appends logs at EVERY RUN. It is NOT RECOMMENDED to set `update_every` below 30 sec.
+              It is STRONGLY RECOMMENDED to create a `bind-rndc.conf` file for logrotate.
+              
+              To set up BIND to dump stats do the following:
+              
+              1. Add to 'named.conf.options' options {}:
+              `statistics-file "/var/log/bind/named.stats";`
+              
+              2. Create bind/ directory in /var/log:
+              `cd /var/log/ && mkdir bind`
+              
+              3. Change owner of directory to 'bind' user:
+              `chown bind bind/`
+              
+              4. RELOAD (NOT restart) BIND:
+              `systemctl reload bind9.service`
+              
+              5. Run as a root 'rndc stats' to dump (BIND will create named.stats in new directory)
+              
+              To allow Netdata to run 'rndc stats' change '/etc/bind/rndc.key' group to netdata:
+              `chown :netdata rndc.key`
+              
+              Last, BUT NOT least, is to create bind-rndc.conf in logrotate.d/:
+              ```
+              /var/log/bind/named.stats {
+              
+                  daily
+                  rotate 4
+                  compress
+                  delaycompress
+                  create 0644 bind bind
+                  missingok
+                  postrotate
+                      rndc reload > /dev/null
+                  endscript
+              }
+              ```
+              To test your logrotate conf file run as root:
+              `logrotate /etc/logrotate.d/bind-rndc -d (debug dry-run mode)`
+      configuration:
+        file:
+          name: python.d/bind_rndc.conf
+        options:
+          description: |
+            There are 2 sections:
+            
+            * Global variables
+            * One or more JOBS that can define multiple different instances to monitor.
+            
+            The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
+            
+            Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
+            
+            Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
+          folding:
+            title: "Config options"
+            enabled: true
+          list:
+            - name: update_every
+              description: Sets the default data collection frequency.
+              default_value: 5
+              required: false
+            - name: priority
+              description: Controls the order of charts at the netdata dashboard.
+              default_value: 60000
+              required: false
+            - name: autodetection_retry
+              description: Sets the job re-check interval in seconds.
+              default_value: 0
+              required: false
+            - name: penalty
+              description: Indicates whether to apply penalty to update_every in case of failures.
+              default_value: yes
+              required: false
+            - name: name
+              description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
+              default_value: ""
+              required: false
+            - name: named_stats_path
+              description: Path to the named stats, after being dumped by `nrdc`
+              default_value: "/var/log/bind/named.stats"
+              required: false
+        examples:
+          folding:
+            enabled: false
+            title: "Config"
+          list:
+            - name: Local bind stats
+              description: Define a local path to bind stats file
+              config: |
+                local:
+                 named_stats_path: '/var/log/bind/named.stats'
+    troubleshooting:
+      problems:
+        list: []
+    alerts:
+      - name: bind_rndc_stats_file_size
+        link: https://github.com/netdata/netdata/blob/master/health/health.d/bind_rndc.conf
+        metric: bind_rndc.stats_size
+        info: BIND statistics-file size
     metrics:
-    - name: bind_rndc.name_server_statistics
-      description: Name Server Statistics
-      unit: "stats"
-      chart_type: line
-      dimensions:
-      - name: requests
-      - name: rejected_queries
-      - name: success
-      - name: failure
-      - name: responses
-      - name: duplicate
-      - name: recursion
-      - name: nxrrset
-      - name: nxdomain
-      - name: non_auth_answer
-      - name: auth_answer
-      - name: dropped_queries
-    - name: bind_rndc.incoming_queries
-      description: Incoming queries
-      unit: "queries"
-      chart_type: line
-      dimensions:
-      - name: a dimension per incoming query type
-    - name: bind_rndc.outgoing_queries
-      description: Outgoing queries
-      unit: "queries"
-      chart_type: line
-      dimensions:
-      - name: a dimension per outgoing query type
-    - name: bind_rndc.stats_size
-      description: Named Stats File Size
-      unit: "MiB"
-      chart_type: line
-      dimensions:
-      - name: stats_size
+      folding:
+        title: Metrics
+        enabled: false
+      description: ""
+      availability: []
+      scopes:
+        - name: global
+          description: "These metrics refer to the entire monitored application."
+          labels: []
+          metrics:
+            - name: bind_rndc.name_server_statistics
+              description: Name Server Statistics
+              unit: "stats"
+              chart_type: line
+              dimensions:
+                - name: requests
+                - name: rejected_queries
+                - name: success
+                - name: failure
+                - name: responses
+                - name: duplicate
+                - name: recursion
+                - name: nxrrset
+                - name: nxdomain
+                - name: non_auth_answer
+                - name: auth_answer
+                - name: dropped_queries
+            - name: bind_rndc.incoming_queries
+              description: Incoming queries
+              unit: "queries"
+              chart_type: line
+              dimensions:
+                - name: a dimension per incoming query type
+            - name: bind_rndc.outgoing_queries
+              description: Outgoing queries
+              unit: "queries"
+              chart_type: line
+              dimensions:
+                - name: a dimension per outgoing query type
+            - name: bind_rndc.stats_size
+              description: Named Stats File Size
+              unit: "MiB"
+              chart_type: line
+              dimensions:
+                - name: stats_size
diff --git a/collectors/python.d.plugin/bind_rndc/metrics.csv b/collectors/python.d.plugin/bind_rndc/metrics.csv
deleted file mode 100644
index 3b0733099..000000000
--- a/collectors/python.d.plugin/bind_rndc/metrics.csv
+++ /dev/null
@@ -1,5 +0,0 @@
-metric,scope,dimensions,unit,description,chart_type,labels,plugin,module
-bind_rndc.name_server_statistics,,"requests, rejected_queries, success, failure, responses, duplicate, recursion, nxrrset, nxdomain, non_auth_answer, auth_answer, dropped_queries",stats,Name Server Statistics,line,,python.d.plugin,bind_rndc
-bind_rndc.incoming_queries,,a dimension per incoming query type,queries,Incoming queries,line,,python.d.plugin,bind_rndc
-bind_rndc.outgoing_queries,,a dimension per outgoing query type,queries,Outgoing queries,line,,python.d.plugin,bind_rndc
-bind_rndc.stats_size,,stats_size,MiB,Named Stats File Size,line,,python.d.plugin,bind_rndc