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, 77 insertions, 13 deletions

diff --git a/collectors/python.d.plugin/haproxy/metadata.yaml b/collectors/python.d.plugin/haproxy/metadata.yaml
index d0d165a9ea..b7c3c5eaa2 100644
--- a/collectors/python.d.plugin/haproxy/metadata.yaml
+++ b/collectors/python.d.plugin/haproxy/metadata.yaml
@@ -3,7 +3,7 @@ meta:
   module_name: haproxy
   monitored_instance:
     name: HAProxy
-    link: ''
+    link: 'https://www.haproxy.org/'
     categories:
     - data-collection.web-servers-and-web-proxies
     icon_filename: 'haproxy.png'
@@ -12,12 +12,15 @@ meta:
       list: []
   info_provided_to_referring_integrations:
     description: ''
-  keywords: []
+  keywords:
+    - haproxy
+    - tcp
+    - balancer
   most_popular: false
 overview:
   data_collection:
-    metrics_description: 'Monitor HAProxy performance for ideal load balancing operations. Monitor session rates, queue lengths, and error rates to maintain balanced network traffic.'
-    method_description: ''
+    metrics_description: 'This collector monitors HAProxy metrics about frontend servers, backend servers, responses and more.'
+    method_description: 'It connects to the HAProxy instance via URL or UNIX socket.'
   supported_platforms:
     include: []
     exclude: []
@@ -33,22 +36,83 @@ overview:
       description: ''
 setup:
   prerequisites:
-    list: []
+    list:
+      - title: 'HAProxy setup for socket'
+        description: 'Socket must be readable and writable by the netdata user.'
+      - title: 'HAProxy setup for URL'
+        description: 'URL must have `stats uri <path>` present in the haproxy config, otherwise you will get HTTP 503 in the haproxy logs.'
   configuration:
     file:
-      name: ''
-      description: ''
+      name: python.d/haproxy.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: user
+          description: Username if stats auth is used.
+          default_value: ''
+          required: false
+        - name: pass
+          description: Password if stats auth is used.
+          default_value: ''
+          required: false
+        - name: url
+          description: URL to the haproxy_stats endpoint. Also make sure the parameters `csv` and `norefresh` are provided.
+          default_value: ''
+          required: false
+        - name: socket
+          description: Unix socket path to the haproxy sock file.
+          default_value: ''
+          required: false
     examples:
       folding:
         enabled: true
-        title: ''
-      list: []
+        title: "Config"
+      list:
+        - name: URL method
+          description: Use a URL to specify the endpoint to check for haproxy statistics.
+          config: |
+            via_url:
+             user: 'username' # ONLY IF stats auth is used
+             pass: 'password' # # ONLY IF stats auth is used
+             url: 'http://ip.address:port/url;csv;norefresh'
+        - name: Local socket
+          description: Use a local socket to check for haproxy statistics.
+          config: |
+             via_socket:
+              socket: 'path/to/haproxy/sock'
 troubleshooting:
   problems:
     list: []
@@ -69,7 +133,7 @@ metrics:
   availability: []
   scopes:
   - name: global
-    description: ""
+    description: 'These metrics refer to the entire monitored application.'
     labels: []
     metrics:
     - name: haproxy_f.bin