Update metadata.yaml for some python collectors (#15513)

* add more info to metadata.yaml for ceph, haproxy and tor

* changes

* add dovecot metdata

* add metdata for hpssa

* add icecast metadata

* add rethinkdbs metadata

* add am2320 metadata

* address review comments

* Update collectors/python.d.plugin/ceph/metadata.yaml

* Update collectors/python.d.plugin/am2320/metadata.yaml

* Apply suggestions from code review

* Update collectors/python.d.plugin/ceph/metadata.yaml

---------

Co-authored-by: Andrew Maguire <andrewm4894@gmail.com>
Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>

1 files changed, 68 insertions, 15 deletions

diff --git a/collectors/python.d.plugin/icecast/metadata.yaml b/collectors/python.d.plugin/icecast/metadata.yaml
index 4d378ea1d8..757e444b12 100644
--- a/collectors/python.d.plugin/icecast/metadata.yaml
+++ b/collectors/python.d.plugin/icecast/metadata.yaml
@@ -3,7 +3,7 @@ meta:
   module_name: icecast
   monitored_instance:
     name: Icecast
-    link: ''
+    link: 'https://icecast.org/'
     categories:
     - data-collection.media-streaming-servers
     icon_filename: 'icecast.png'
@@ -12,12 +12,15 @@ meta:
       list: []
   info_provided_to_referring_integrations:
     description: ''
-  keywords: []
+  keywords:
+    - icecast
+    - streaming
+    - media
   most_popular: false
 overview:
   data_collection:
-    metrics_description: 'Examine Icecast metrics for insights into media streaming server operations. Study listener counts, bitrate, and connection statuses for smooth streaming services.'
-    method_description: ''
+    metrics_description: 'This collector monitors Icecast listener counts.'
+    method_description: 'It connects to an icecast URL and uses the `status-json.xsl` endpoint to retrieve statistics.'
   supported_platforms:
     include: []
     exclude: []
@@ -26,29 +29,79 @@ overview:
     description: ''
   default_behavior:
     auto_detection:
-      description: ''
+      description: 'Without configuration, the collector attempts to connect to http://localhost:8443/status-json.xsl'
     limits:
       description: ''
     performance_impact:
       description: ''
 setup:
   prerequisites:
-    list: []
+    list:
+      - title: 'Icecast minimum version'
+        description: 'Needs at least icecast version >= 2.4.0'
   configuration:
     file:
-      name: ''
-      description: ''
+      name: python.d/icecast.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: 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: url
+          description: The URL (and port) to the icecast server. Needs to also include `/status-json.xsl`
+          default_value: 'http://localhost:8443/status-json.xsl'
+          required: false
+        - name: user
+          description: Username to use to connect to `url` if it's password protected.
+          default_value: ''
+          required: false
+        - name: pass
+          description: Password to use to connect to `url` if it's password protected.
+          default_value: ''
+          required: false
     examples:
       folding:
-        enabled: true
-        title: ''
-      list: []
+        enabled: false
+        title: "Config"
+      list:
+        - name: Remote Icecast server
+          description: Configure a remote icecast server
+          folding:
+            enabled: false
+          config: |
+            remote:
+             url: 'http://1.2.3.4:8443/status-json.xsl'
 troubleshooting:
   problems:
     list: []
@@ -61,7 +114,7 @@ metrics:
   availability: []
   scopes:
   - name: global
-    description: ""
+    description: "These metrics refer to the entire monitored application."
     labels: []
     metrics:
     - name: icecast.listeners