Freeimpi yaml (#15533)

* freeimpi_yaml: Add initial description

* freeimpi_yaml: Update freeimp yaml

* freeimpi_yaml: Update freeimp yaml second group

* freeimpi_yaml: Update description

1 files changed, 41 insertions, 25 deletions

diff --git a/collectors/freeipmi.plugin/multi_metadata.yaml b/collectors/freeipmi.plugin/multi_metadata.yaml
index 08716a5a88..64f42f8f2e 100644
--- a/collectors/freeipmi.plugin/multi_metadata.yaml
+++ b/collectors/freeipmi.plugin/multi_metadata.yaml
@@ -23,33 +23,42 @@ modules:
       data_collection:
         metrics_description:
           "Monitor enterprise server sensor readings, event log entries, and hardware statuses to ensure reliable server operations."
-        method_description: ""
+        method_description: |
+          The plugin uses open source library IPMImonitoring to communitcate with sensors.
       supported_platforms:
         include: []
         exclude: []
       multi_instance: true
       additional_permissions:
-        description: ""
+        description: "The plugin needs setuid."
       default_behavior:
         auto_detection:
           description: ""
         limits:
           description: ""
         performance_impact:
-          description: ""
+          description: "Linux kernel module for IPMI can create big overhead."
     setup:
       prerequisites:
-        list: []
+        list: |
+          If you have not previously used IPMI on your system, you will probably need to run the ipmimonitoring command as root to initiailze IPMI settings so that the Netdata plugin works correctly. It should return information about available seensors on the system.
+
+          In some distributions libipmimonitoring.pc is located in a non-standard directory, which can cause building the plugin to fail when building Netdata from source. In that case you should find the file and link it to the standard pkg-config directory. Usually, running sudo ln -s /usr/lib/$(uname -m)-linux-gnu/pkgconfig/libipmimonitoring.pc/libipmimonitoring.pc /usr/lib/pkgconfig/libipmimonitoring.pc resolves this issue.
       configuration:
         file:
-          name: ""
-          description: ""
+          name: "netdata.conf"
+          section_name: '[plugin:freeipmi]'
+          description: "This is netdata main configuration file"
         options:
-          description: ""
+          description: "This tool receives command line options that are visible when user run: `./usr/libexec/netdata/plugins.d/freeipmi.plugin --help`"
           folding:
-            title: ""
+            title: "Config options"
             enabled: true
-          list: []
+          list: |
+            - name: command options
+              description: Variable used to pass arguments for the plugin.
+              default_value: 1
+              required: false
         examples:
           folding:
             enabled: true
@@ -74,11 +83,11 @@ modules:
           description: ""
           labels:
             - name: sensor
-              description: TBD
+              description: The sensor name
             - name: type
-              description: TBD
+              description: One of 45 recognized sensor types (Battery, Voltage...)
             - name: component
-              description: TBD
+              description: One of 25 recognized components (Processor, Peripheral).
           metrics:
             - name: ipmi.sel
               description: IPMI Events
@@ -158,28 +167,35 @@ modules:
         include: []
         exclude: []
       multi_instance: true
-      additional_permissions:
-        description: ""
+      additional_permissions: |
+        The plugin uses open source library IPMImonitoring to communitcate with sensors.
       default_behavior:
         auto_detection:
           description: ""
         limits:
           description: ""
         performance_impact:
-          description: ""
+          description: "Linux kernel module for IPMI can create big overhead."
     setup:
       prerequisites:
-        list: []
+        list: |
+          If you have not previously used IPMI on your system, you will probably need to run the ipmimonitoring command as root to initiailze IPMI settings so that the Netdata plugin works correctly. It should return information about available seensors on the system.
+
+          In some distributions libipmimonitoring.pc is located in a non-standard directory, which can cause building the plugin to fail when building Netdata from source. In that case you should find the file and link it to the standard pkg-config directory. Usually, running sudo ln -s /usr/lib/$(uname -m)-linux-gnu/pkgconfig/libipmimonitoring.pc/libipmimonitoring.pc /usr/lib/pkgconfig/libipmimonitoring.pc resolves this issue.
       configuration:
-        file:
-          name: ""
-          description: ""
+        name: "netdata.conf"
+        section_name: '[plugin:freeipmi]'
+        description: "This is netdata main configuration file"
         options:
-          description: ""
+          description: "This tool receives command line options that are visible when user run: `./usr/libexec/netdata/plugins.d/freeipmi.plugin --help`"
           folding:
-            title: ""
+            title: "Config options"
             enabled: true
-          list: []
+          list: |
+            - name: command options
+              description: Variable used to pass arguments for the plugin.
+              default_value: 1
+              required: false
         examples:
           folding:
             enabled: true
@@ -204,11 +220,11 @@ modules:
           description: ""
           labels:
             - name: sensor
-              description: TBD
+              description: The sensor name
             - name: type
-              description: TBD
+              description: One of 45 recognized sensor types (Battery, Voltage...)
             - name: component
-              description: TBD
+              description: One of 25 recognized components (Processor, Peripheral).
           metrics:
             - name: ipmi.sel
               description: IPMI Events