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, 80 insertions, 15 deletions

diff --git a/collectors/python.d.plugin/rethinkdbs/metadata.yaml b/collectors/python.d.plugin/rethinkdbs/metadata.yaml
index 40d6cf00e2..f749e67958 100644
--- a/collectors/python.d.plugin/rethinkdbs/metadata.yaml
+++ b/collectors/python.d.plugin/rethinkdbs/metadata.yaml
@@ -3,7 +3,7 @@ meta:
   module_name: rethinkdbs
   monitored_instance:
     name: RethinkDB
-    link: ''
+    link: 'https://rethinkdb.com/'
     categories:
     - data-collection.database-servers
     icon_filename: 'rethinkdb.png'
@@ -12,12 +12,15 @@ meta:
       list: []
   info_provided_to_referring_integrations:
     description: ''
-  keywords: []
+  keywords:
+    - rethinkdb
+    - database
+    - db
   most_popular: false
 overview:
   data_collection:
-    metrics_description: 'Monitor RethinkDB performance for real-time database operations and performance. Improve your database operations with Netdata''s real-time metrics and built-in alerts.'
-    method_description: ''
+    metrics_description: 'This collector monitors metrics about RethinkDB clusters and database servers.'
+    method_description: 'It uses the `rethinkdb` python module to connect to a RethinkDB server instance and gather statistics.'
   supported_platforms:
     include: []
     exclude: []
@@ -26,29 +29,91 @@ overview:
     description: ''
   default_behavior:
     auto_detection:
-      description: ''
+      description: 'When no configuration file is found, the collector tries to connect to 127.0.0.1:28015.'
     limits:
       description: ''
     performance_impact:
       description: ''
 setup:
   prerequisites:
-    list: []
+    list:
+      - title: 'Required python module'
+        description: 'The collector requires the `rethinkdb` python module to be installed.'
   configuration:
     file:
-      name: ''
-      description: ''
+      name: python.d/rethinkdbs.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: host
+          description: Hostname or ip of the RethinkDB server.
+          default_value: 'localhost'
+          required: false
+        - name: port
+          description: Port to connect to the RethinkDB server.
+          default_value: '28015'
+          required: false
+        - name: user
+          description: The username to use to connect to the RethinkDB server.
+          default_value: 'admin'
+          required: false
+        - name: password
+          description: The password to use to connect to the RethinkDB server.
+          default_value: ''
+          required: false
+        - name: timeout
+          description: Set a connect timeout to the RethinkDB server.
+          default_value: '2'
+          required: false
     examples:
       folding:
-        enabled: true
-        title: ''
-      list: []
+        enabled: false
+        title: "Config"
+      list:
+        - name: Local RethinkDB server
+          description: An example of a configuration for a local RethinkDB server
+          folding:
+            enabled: false
+          config: |
+            localhost:
+             name: 'local'
+             host: '127.0.0.1'
+             port: 28015
+             user: "user"
+             password: "pass"
 troubleshooting:
   problems:
     list: []
@@ -61,7 +126,7 @@ metrics:
   availability: []
   scopes:
   - name: global
-    description: ""
+    description: "These metrics refer to the entire monitored application."
     labels: []
     metrics:
     - name: rethinkdb.cluster_connected_servers