Python collector yaml updates (#15517)

update collector metadata for monit, spigotmc, hddtemp, nsd

1 files changed, 171 insertions, 94 deletions

diff --git a/collectors/python.d.plugin/monit/metadata.yaml b/collectors/python.d.plugin/monit/metadata.yaml
index 60a87831e5..44fdb6df3e 100644
--- a/collectors/python.d.plugin/monit/metadata.yaml
+++ b/collectors/python.d.plugin/monit/metadata.yaml
@@ -3,52 +3,129 @@ meta:
   module_name: monit
   monitored_instance:
     name: Monit
-    link: ''
+    link: https://mmonit.com/monit/
     categories:
-    - data-collection.synthetic-checks
-    icon_filename: 'monit.png'
+      - data-collection.synthetic-checks
+    icon_filename: "monit.png"
   related_resources:
     integrations:
       list: []
   info_provided_to_referring_integrations:
-    description: ''
-  keywords: []
+    description: ""
+  keywords:
+    - monit
+    - mmonit
+    - supervision tool
+    - monitrc
   most_popular: false
 overview:
   data_collection:
-    metrics_description: 'Monitor Monit performance for optimal system monitoring operations. Monitor system status, process health, and error rates to maintain system stability.'
-    method_description: ''
+    metrics_description: |
+      This collector monitors Monit targets such as filesystems, directories, files, FIFO pipes and more.
+    method_description: |
+      It gathers data from Monit's XML interface.
   supported_platforms:
     include: []
     exclude: []
   multi_instance: true
   additional_permissions:
-    description: ''
+    description: ""
   default_behavior:
     auto_detection:
-      description: ''
+      description: By default, this collector will attempt to connect to Monit at `http://localhost:2812`
     limits:
-      description: ''
+      description: ""
     performance_impact:
-      description: ''
+      description: ""
 setup:
   prerequisites:
     list: []
   configuration:
     file:
-      name: ''
-      description: ''
+      name: "python.d/monit.conf"
     options:
-      description: ''
+      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: ''
+        title: "Config options"
         enabled: true
-      list: []
+      list:
+        - name: update_every
+          description: Sets the default data collection frequency.
+          default_value: 1
+          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: "local"
+          required: false
+        - name: url
+          description: The URL to fetch Monit's metrics.
+          default_value: http://localhost:2812
+          required: true
+        - name: user
+          description: Username in case the URL is password protected.
+          default_value: ""
+          required: false
+        - name: pass
+          description: Password in case the URL is password protected.
+          default_value: ""
+          required: false
     examples:
       folding:
         enabled: true
-        title: ''
-      list: []
+        title: "Config"
+      list:
+        - name: Basic
+          description: A basic configuration example.
+          folding:
+            enabled: false
+          config: |
+            localhost:
+              name : 'local'
+              url  : 'http://localhost:2812'
+        - name: Basic Authentication
+          description: Example using basic username and password in order to authenticate.
+          config: |
+            localhost:
+              name : 'local'
+              url  : 'http://localhost:2812'
+              user: 'foo'
+              pass: 'bar'
+        - name: Multi-instance
+          description: |
+            > **Note**: When you define multiple jobs, their names must be unique.
+
+            Collecting metrics from local and remote instances.
+          config: |
+            localhost:
+              name: 'local'
+              url: 'http://localhost:2812'
+
+            remote_job:
+              name: 'remote'
+              url: 'http://192.0.2.1:2812'
 troubleshooting:
   problems:
     list: []
@@ -60,79 +137,79 @@ metrics:
   description: ""
   availability: []
   scopes:
-  - name: global
-    description: ""
-    labels: []
-    metrics:
-    - name: monit.filesystems
-      description: Filesystems
-      unit: "filesystems"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.directories
-      description: Directories
-      unit: "directories"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.files
-      description: Files
-      unit: "files"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.fifos
-      description: Pipes (fifo)
-      unit: "pipes"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.programs
-      description: Programs statuses
-      unit: "programs"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.services
-      description: Processes statuses
-      unit: "processes"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.process_uptime
-      description: Processes uptime
-      unit: "seconds"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.process_threads
-      description: Processes threads
-      unit: "threads"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.process_childrens
-      description: Child processes
-      unit: "children"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.hosts
-      description: Hosts
-      unit: "hosts"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.host_latency
-      description: Hosts latency
-      unit: "milliseconds"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
-    - name: monit.networks
-      description: Network interfaces and addresses
-      unit: "interfaces"
-      chart_type: line
-      dimensions:
-      - name: a dimension per target
+    - name: global
+      description: "These metrics refer to the entire monitored application."
+      labels: []
+      metrics:
+        - name: monit.filesystems
+          description: Filesystems
+          unit: "filesystems"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.directories
+          description: Directories
+          unit: "directories"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.files
+          description: Files
+          unit: "files"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.fifos
+          description: Pipes (fifo)
+          unit: "pipes"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.programs
+          description: Programs statuses
+          unit: "programs"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.services
+          description: Processes statuses
+          unit: "processes"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.process_uptime
+          description: Processes uptime
+          unit: "seconds"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.process_threads
+          description: Processes threads
+          unit: "threads"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.process_childrens
+          description: Child processes
+          unit: "children"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.hosts
+          description: Hosts
+          unit: "hosts"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.host_latency
+          description: Hosts latency
+          unit: "milliseconds"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target
+        - name: monit.networks
+          description: Network interfaces and addresses
+          unit: "interfaces"
+          chart_type: line
+          dimensions:
+            - name: a dimension per target