diff --git a/README.md b/README.md index b492ce5..f358fc2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # System Monitor -System monitoring solution with support for plugins. +Open source system monitoring solution with support for plugins. ![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 -### Client / Agent - -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). +This software consist of a server and client component. ### 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 diff --git a/client/README.md b/client/README.md index ab2a609..43f3393 100644 --- a/client/README.md +++ b/client/README.md @@ -1,12 +1,12 @@ # 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 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 diff --git a/doc/sysmon.drawio b/doc/sysmon.drawio index e78d121..ef4402e 100644 --- a/doc/sysmon.drawio +++ b/doc/sysmon.drawio @@ -1 +1,52 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/sysmon.png b/doc/sysmon.png index f369e11..be8fc52 100644 Binary files a/doc/sysmon.png and b/doc/sysmon.png differ diff --git a/plugins/README.md b/plugins/README.md index ad6943c..637c8db 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -2,6 +2,6 @@ Collection of standard sysmon plugins for use with the client. -- [base](os-base/) - Base OS metrics (uses [oshi](https://github.com/oshi/oshi)) -- [aix](os-aix/) - AIX (and IBM Power) specific metrics -- [linux](os-linux/) - Linux specific metrics +- [base](os-base/README.md) - Base OS metrics (uses [oshi](https://github.com/oshi/oshi)) +- [aix](os-aix/README.md) - AIX (and IBM Power) specific metrics +- [linux](os-linux/README.md) - Linux specific metrics diff --git a/plugins/os-aix/README.md b/plugins/os-aix/README.md index 7fe26a5..2170b88 100644 --- a/plugins/os-aix/README.md +++ b/plugins/os-aix/README.md @@ -6,10 +6,10 @@ The processor extension works for both AIX and Linux on the Power ppc64/ppc64le Metrics reported are: -- **mode** - Processor mode, Capped or Uncapped +- **mode** - Processor mode, Capped or Uncapped - **type** - Processor type, Shared or Dedicated - **lcpu** - Number of logical CPU's available for this partition - **ent** - Processor entitlements available for this partition - **physc** - Indicates the number of physical processors 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. diff --git a/plugins/os-linux/README.md b/plugins/os-linux/README.md index 7a43677..1b6412a 100644 --- a/plugins/os-linux/README.md +++ b/plugins/os-linux/README.md @@ -4,4 +4,4 @@ ### Network Sockets -Collects statistics from */proc/net/sockstats*. \ No newline at end of file +Collects statistics from */proc/net/sockstats*. diff --git a/server/README.md b/server/README.md index 0947758..adbe477 100644 --- a/server/README.md +++ b/server/README.md @@ -1,12 +1,12 @@ # Server -This is the server component of SysMon. +This is the server component of sysmon. ## Installation 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