adding page for plugin

docs/assets/extra.css

@@ -1,11 +1,6 @@
 /*
- https://coolors.co/568e83-f5fbef-84c318-9684a1-161925
+ https://coolors.co/e6c229-f17105-d11149-6610f2-1a8fe3
- https://coolors.co/2ec0f9-67aaf9-9bbdf9-c4e0f9-b95f89
+*/
- https://coolors.co/ddd8c4-a3c9a8-84b59f-69a297-50808e
-https://coolors.co/e6c229-f17105-d11149-6610f2-1a8fe3
-
-
- */
 
 .md-header {
   background: #d11149;

docs/plugins/sys_broker.md

@@ -0,0 +1,29 @@
+# Plugin: $SYS
+
+Publishes, on a periodic basis, statistics about the broker
+
+### Config Options
+
+- `sys_interval` - int, seconds between updates
+
+### Supported Topics
+
+- `$SYS/broker/load/bytes/received` - payload: 'data` - payload: `data`,  int
+- `$SYS/broker/load/bytes/sent` - payload: 'data` - payload: `data`,  int
+- `$SYS/broker/messages/received` - payload: `data`, int
+- `$SYS/broker/messages/sent` - payload: `data`, int
+- `$SYS/broker/time` - payload: `data`,  int (current, epoch seconds)
+- `$SYS/broker/uptime` - payload: `data`,  datetime (start)
+- `$SYS/broker/uptime/formatted` - payload: `data`, int (seconds)
+- `$SYS/broker/clients/connected` - payload: `data`, int
+- `$SYS/broker/clients/disconnected` - payload: `data`, int
+- `$SYS/broker/clients/maximum` - payload: `data`, int
+- `$SYS/broker/clients/total` - payload: `data`, int
+- `$SYS/broker/messages/inflight` - payload: `data`, int
+- `$SYS/broker/messages/inflight/in` - payload: `data`, int
+- `$SYS/broker/messages/inflight/out` - payload: `data`, int
+- `$SYS/broker/messages/inflight/stored` - payload: `data`, int
+- `$SYS/broker/messages/publish/received` - payload: `data`, int
+- `$SYS/broker/messages/publish/sent` - payload: `data`, int
+- `$SYS/broker/messages/retained/count` - payload: `data`, int
+- `$SYS/broker/messages/subscriptions/count` - payload: `data`, int

mkdocs.yml

@@ -24,6 +24,8 @@ nav:
       - API Usage:
           - Broker: references/broker.md
           - Client: references/client.md
+      - Plugins:
+          - $SYS: plugins/sys_broker.md
       - Reference:
           - Contributing: contributing.md
           - Code of Conduct: code_of_conduct.md