nellemann/sysmon
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases 3 Wiki Activity

Update documentation

Browse source
This commit is contained in:
Mark Nellemann 2022-09-19 14:41:11 +02:00
parent 8bc02798d2
commit 249238e7a5
8 changed files with 72 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,6 +1,6 @@
# System Monitor # System Monitor
System monitoring solution with support for plugins. Open source system monitoring solution with support for plugins.
![Sysmon Icon](doc/sysmon.png) ![Sysmon Icon](doc/sysmon.png)
@ -12,24 +12,20 @@ This software is free to use and is licensed under the [Apache 2.0 License](LICE
## Components ## Components
### Client / Agent This software consist of a server and client component.
Runs on your hosts and collects metrics, which are sent to the central *server*.
[More information](client/README.md).
### Plugins
Loaded by the *client* and provides extensions for doing the actual collecting of metrics.
[More information](plugins/README.md).
### Server ### Server
Receives aggregated metrics from *clients* and saves these into InfluxDB. The server component receives aggregated metrics from *clients* and saves these into InfluxDB.
[More information](server/README.md). - More information and documentation on the [sysmon-server](server/README.md).
### Client & Plugins
The client runs on all or some of your hosts and collects metrics, which are then sent to the central sysmon-server component. Plugins are loaded by the client at startup and should also be installed.
- More information and documentation on the [sysmon-client](client/README.md).
. More information and documentation on the [sysmon-plugins](plugins/README.md).
## Known problems ## Known problems

4
client/README.md
View file

@ -1,12 +1,12 @@
# Client / Agent # Client / Agent
This is the client/agent component of SysMon, which you install (together with sysmon-plugins) on the hosts where you want to collect metrics. This is the client/agent component of sysmon, which you install (together with sysmon-plugins) on the hosts where you want to collect metrics.
## Installation ## Installation
Download *.deb* or *.rpm* packages for sysmon-client *and* sysmon-plugins, and install. Download *.deb* or *.rpm* packages for sysmon-client *and* sysmon-plugins, and install.
See the [doc/systemd.md](doc/systemd.md) or [doc/sysv-init.md](doc/sysv-init.md) files for further instructions. See the [doc/systemd.md](doc/systemd.md) or [doc/sysv-init.md](doc/sysv-init.md) files for further instructions on running as a system service.
## Development ## Development

53
doc/sysmon.drawio
View file

@ -1 +1,52 @@
<mxfile host="drawio-plugin" modified="2022-05-16T14:44:52.661Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.45 Safari/537.36" etag="qMHZwv0ZoSoZOGvtPIOa" version="15.5.4" type="embed"><diagram id="JBJC25AnoTCSJF4dnfuA" name="Page-1"><mxGraphModel dx="1380" dy="630" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0"><root><mxCell id="0"/><mxCell id="1" parent="0"/><mxCell id="n2YpyNFSe_BwzrgFeqL7-1" value="Linux" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1"><mxGeometry x="250" y="50" width="120" height="60" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-2" value="AIX" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1"><mxGeometry x="180" y="140" width="120" height="60" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-6" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;sketch=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-3" target="n2YpyNFSe_BwzrgFeqL7-4" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-3" value="Sysmon Server" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1"><mxGeometry x="510" y="120" width="120" height="60" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-7" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;sketch=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-4" target="n2YpyNFSe_BwzrgFeqL7-5" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-4" value="InfluxDB" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;sketch=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1"><mxGeometry x="690" y="110" width="60" height="80" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-5" value="Grafana&lt;br&gt;Dashboards &amp;amp; Alerting" style="shape=document;whiteSpace=wrap;html=1;boundedLbl=1;sketch=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1"><mxGeometry x="800" y="110" width="120" height="80" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-8" value="Other OS'es" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1"><mxGeometry x="310" y="210" width="120" height="60" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-17" style="edgeStyle=orthogonalEdgeStyle;rounded=1;sketch=1;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-9" target="n2YpyNFSe_BwzrgFeqL7-3" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-9" value="Agent" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;" parent="1" vertex="1"><mxGeometry x="320" y="90" width="50" height="20" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-15" style="edgeStyle=orthogonalEdgeStyle;rounded=1;sketch=1;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-10" target="n2YpyNFSe_BwzrgFeqL7-3" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-10" value="Agent" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;" parent="1" vertex="1"><mxGeometry x="250" y="180" width="50" height="20" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-16" style="edgeStyle=orthogonalEdgeStyle;rounded=1;sketch=1;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-11" target="n2YpyNFSe_BwzrgFeqL7-3" edge="1"><mxGeometry relative="1" as="geometry"/></mxCell><mxCell id="n2YpyNFSe_BwzrgFeqL7-11" value="Agent" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;" parent="1" vertex="1"><mxGeometry x="380" y="250" width="50" height="20" as="geometry"/></mxCell></root></mxGraphModel></diagram></mxfile> <mxfile host="65bd71144e" scale="1" border="15">
<diagram id="JBJC25AnoTCSJF4dnfuA" name="Page-1">
<mxGraphModel dx="1761" dy="1167" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-1" value="Linux" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1">
<mxGeometry x="250" y="50" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-2" value="AIX" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1">
<mxGeometry x="180" y="140" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-6" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;sketch=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-3" target="n2YpyNFSe_BwzrgFeqL7-4" edge="1">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-3" value="Sysmon Server" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
<mxGeometry x="510" y="120" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-7" style="edgeStyle=orthogonalEdgeStyle;rounded=1;orthogonalLoop=1;jettySize=auto;html=1;sketch=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-4" target="n2YpyNFSe_BwzrgFeqL7-5" edge="1">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-4" value="InfluxDB&lt;br&gt;ver 1.x" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=15;sketch=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
<mxGeometry x="690" y="110" width="60" height="80" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-5" value="Grafana&lt;br&gt;Dashboards &amp;amp; Alerting" style="shape=document;whiteSpace=wrap;html=1;boundedLbl=1;sketch=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
<mxGeometry x="800" y="110" width="120" height="80" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-8" value="Other OS'es" style="rounded=1;whiteSpace=wrap;html=1;sketch=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1">
<mxGeometry x="310" y="210" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-17" style="edgeStyle=orthogonalEdgeStyle;rounded=1;sketch=1;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-9" target="n2YpyNFSe_BwzrgFeqL7-3" edge="1">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-9" value="Agent" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;" parent="1" vertex="1">
<mxGeometry x="320" y="90" width="50" height="20" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-15" style="edgeStyle=orthogonalEdgeStyle;rounded=1;sketch=1;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-10" target="n2YpyNFSe_BwzrgFeqL7-3" edge="1">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-10" value="Agent" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;" parent="1" vertex="1">
<mxGeometry x="250" y="180" width="50" height="20" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-16" style="edgeStyle=orthogonalEdgeStyle;rounded=1;sketch=1;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="n2YpyNFSe_BwzrgFeqL7-11" target="n2YpyNFSe_BwzrgFeqL7-3" edge="1">
<mxGeometry relative="1" as="geometry"/>
</mxCell>
<mxCell id="n2YpyNFSe_BwzrgFeqL7-11" value="Agent" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;sketch=1;" parent="1" vertex="1">
<mxGeometry x="380" y="250" width="50" height="20" as="geometry"/>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>

BIN
doc/sysmon.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 138 KiB

6
plugins/README.md
View file

@ -2,6 +2,6 @@
Collection of standard sysmon plugins for use with the client. Collection of standard sysmon plugins for use with the client.
- [base](os-base/) - Base OS metrics (uses [oshi](https://github.com/oshi/oshi)) - [base](os-base/README.md) - Base OS metrics (uses [oshi](https://github.com/oshi/oshi))
- [aix](os-aix/) - AIX (and IBM Power) specific metrics - [aix](os-aix/README.md) - AIX (and IBM Power) specific metrics
- [linux](os-linux/) - Linux specific metrics - [linux](os-linux/README.md) - Linux specific metrics

4
plugins/os-aix/README.md
View file

@ -6,10 +6,10 @@ The processor extension works for both AIX and Linux on the Power ppc64/ppc64le
Metrics reported are: Metrics reported are:
- **mode** - Processor mode, Capped or Uncapped - **mode** - Processor mode, Capped or Uncapped
- **type** - Processor type, Shared or Dedicated - **type** - Processor type, Shared or Dedicated
- **lcpu** - Number of logical CPU's available for this partition - **lcpu** - Number of logical CPU's available for this partition
- **ent** - Processor entitlements available for this partition - **ent** - Processor entitlements available for this partition
- **physc** - Indicates the number of physical processors consumed. - **physc** - Indicates the number of physical processors consumed.
- **entc** - Indicates the percentage of the entitled capacity consumed. - **entc** - Indicates the percentage of the entitled capacity consumed.
- **lbusy** - Indicates the percentage of logical processor(s) utilization that occurred while executing at the user and system level. - **lbusy** - Indicates the percentage of logical processor(s) utilization that occurred while executing at the user and system level.

2
plugins/os-linux/README.md
View file

@ -4,4 +4,4 @@
### Network Sockets ### Network Sockets
Collects statistics from */proc/net/sockstats*. Collects statistics from */proc/net/sockstats*.

4
server/README.md
View file

@ -1,12 +1,12 @@
# Server # Server
This is the server component of SysMon. This is the server component of sysmon.
## Installation ## Installation
Download *.deb* or *.rpm* package and install. Download *.deb* or *.rpm* package and install.
See the [doc/systemd.md](doc/systemd.md) or [doc/sysv-init.md](doc/sysv-init.md) files for further instructions. See the [doc/systemd.md](doc/systemd.md) or [doc/sysv-init.md](doc/sysv-init.md) files for further instructions on running as a system service.
### Influx Database ### Influx Database