Merge pull request #7063 from k32/doc-sysmon-roots

docs: Add documentation for the sysmon roots

.github/workflows/spelling.yml

@@ -17,7 +17,8 @@ jobs:
     - uses: actions/checkout@v2
     - uses: actions/download-artifact@v2
       with:
-        name: emqx-24.1.5-4-ubuntu20.04
+        name:  emqx-24.1.5-4-ubuntu20.04
+        workflow: build_slim_packages.yaml
         path: .
     - name: Run spellcheck
       run: |

apps/emqx/src/emqx_schema.erl

@@ -922,15 +922,23 @@ fields("broker_perf") ->
 fields("sysmon") ->
     [ {"vm",
        sc(ref("sysmon_vm"),
-          #{})
+          #{ desc => "This part of the configuration is responsible for collecting
+ BEAM VM events, such as long garbage collection, traffic congestion in the inter-broker
+ communication, etc."
+           })
       }
     , {"os",
        sc(ref("sysmon_os"),
-          #{})
+          #{ desc => "This part of the configuration is responsible for monitoring
+ the host OS health, such as free memory, disk space, CPU load, etc."
+           })
       }
     , {"top",
        sc(ref("sysmon_top"),
-          #{})
+          #{ desc => "This part of the configuration is responsible for monitoring
+ the Erlang processes in the VM. This information can be sent to an external
+ PostgreSQL database. This feature is inactive unless the PostgreSQL sink is configured."
+           })
       }
     ];