From 37a822b68776e7ffa1b06a15c7ee44172dcdf139 Mon Sep 17 00:00:00 2001 From: Mark Nellemann Date: Mon, 14 Jun 2021 12:34:30 +0200 Subject: [PATCH] Update README's and oshi dependency. --- gradle.properties | 2 +- plugins/README.md | 4 ++-- plugins/os-aix/README.md | 31 +------------------------------ plugins/os-base/README.md | 36 +++++++++++++++++++----------------- plugins/os-ibmi/README.md | 5 +---- plugins/os-linux/README.md | 37 ++++--------------------------------- 6 files changed, 28 insertions(+), 87 deletions(-) diff --git a/gradle.properties b/gradle.properties index 5794fb7..2f0aa76 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,4 +3,4 @@ pf4jVersion=3.6.0 slf4jVersion=1.7.30 camelVersion=3.10.0 picocliVersion=4.6.1 -oshiVersion=5.7.3 \ No newline at end of file +oshiVersion=5.7.5 \ No newline at end of file diff --git a/plugins/README.md b/plugins/README.md index b4b1d9e..2a3341f 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -1,3 +1,3 @@ -# Plugins +# System Monitor Plugins -Collections of base plugins. +Collection of sysmon plugins. \ No newline at end of file diff --git a/plugins/os-aix/README.md b/plugins/os-aix/README.md index ab367b7..7fe26a5 100644 --- a/plugins/os-aix/README.md +++ b/plugins/os-aix/README.md @@ -1,6 +1,6 @@ # AIX Plugin -## Processor Extension +## LPAR Processor Extension The processor extension works for both AIX and Linux on the Power ppc64/ppc64le architecture. @@ -10,35 +10,6 @@ Metrics reported are: - **type** - Processor type, Shared or Dedicated - **lcpu** - Number of logical CPU's available for this partition - **ent** - Processor entitlements available for this partition -- **user** - Indicates the percentage of the entitled processing capacity used while executing at the user level (application). -- **sys** - Indicates the percentage of the entitled processing capacity used while executing at the system level (kernel). -- **idle** - Indicates the percentage of the entitled processing capacity unused while the partition was idle and did not have any outstanding disk I/O request. -- **wait** - Indicates the percentage of the entitled processing capacity unused while the partition was idle and had outstanding disk I/O request(s). - **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. - - -## Memory Extension - -Metrics reported are: - -- **total** - Total amount of memory (in KB). -- **used** - real memory consumption (in KB). -- **free** - free memory for use (in KB). -- **pin** - pinned memory consumption (in KB). -- **virtual** - virtual memory consumption (in KB). -- **available** - available memory (if freeing up virtual) (in KB). -- **paged** - paging space consumption (in KB). - -*Pinning a memory region prohibits the pager from stealing pages from the pages backing the pinned memory region.* - -## Disk Extension - -Only reports first device found. Improvements on the TODO. - -Metrics reported are: - -- **device** - Name of device. -- **reads** - The total number of KB read. -- **writes** - The total number of KB written. diff --git a/plugins/os-base/README.md b/plugins/os-base/README.md index 6a0bd86..966eab0 100644 --- a/plugins/os-base/README.md +++ b/plugins/os-base/README.md @@ -1,36 +1,38 @@ # Base Plugin +The base plugin uses the [oshi](https://github.com/oshi/oshi) library to get it's metrics. + ## Processor Extension Reports the following metrics seen: -- **user** - CPU time spend on user processes. - **system** -CPU time spend on system processes. -- **iowait** - CPU time spend on waiting (for i/o). -- **idle** - CPU time spend on idle (doing nothing). -- **busy** - CPU time not spend on idle (working). +- **user** - CPU time spend on user processes. +- **nice** - CPU time spend on user processes running at lower priority. +- **iowait** - CPU time spend waiting (for i/o). +- **steal** - CPU time stolen by hypervisor and given to other virtual systems. +- **irq** - CPU time spend by kernel on interrupt requests. +- **softirq** - CPU time spend by kernel on soft interrupt requests. +- **idle** - CPU time spend idling (doing nothing). +- **busy** - CPU time spend working. ## Memory Extension -Reports the following metrics, from the *free* command: +Reports the following metrics (in bytes): -- **total** - The total amount of (installed) memory (in KB). -- **used** - Used memory (calculated as total - free - buffers - cache) (in KB). -- **free** - Unused memory (MemFree and SwapFree in /proc/meminfo) (in KB). -- **shared** - Memory used (mostly) by tmpfs (Shmem in /proc/meminfo) (in KB). -- **buffers** - Sum of buffers and cache (in KB). -- **available** - Estimation of how much memory is available for starting new applications, without swapping (in KB). +- **available** - Estimation of how much memory is available for starting new applications, without swapping. +- **total** - The total amount of (installed) memory. - **usage** - Percentage of memory used out of the total amount of memory. +- **paged** - ... +- **virtual** - ... ## Disk Extension - -Only reports first device found. Improvements on the TODO. - Metrics reported are: -- **device** - Name of device. -- **reads** - The total number of KB read. -- **writes** - The total number of KB written. +- **reads** - The total number of bytes read. +- **writes** - The total number of bytes written. +- **iotime** - Time spent on IO in milliseconds. +- **queue** - Lenght of IO queue. \ No newline at end of file diff --git a/plugins/os-ibmi/README.md b/plugins/os-ibmi/README.md index 7931bd5..b13f57d 100644 --- a/plugins/os-ibmi/README.md +++ b/plugins/os-ibmi/README.md @@ -1,7 +1,4 @@ # IBM i Plugin -## Processor Extension +TODO. Nothing here yet. -## Memory Extension - -## Disk Extension diff --git a/plugins/os-linux/README.md b/plugins/os-linux/README.md index 6a0bd86..7a43677 100644 --- a/plugins/os-linux/README.md +++ b/plugins/os-linux/README.md @@ -1,36 +1,7 @@ -# Base Plugin +# Linux Plugins -## Processor Extension +## Components -Reports the following metrics seen: +### Network Sockets -- **user** - CPU time spend on user processes. -- **system** -CPU time spend on system processes. -- **iowait** - CPU time spend on waiting (for i/o). -- **idle** - CPU time spend on idle (doing nothing). -- **busy** - CPU time not spend on idle (working). - - -## Memory Extension - -Reports the following metrics, from the *free* command: - -- **total** - The total amount of (installed) memory (in KB). -- **used** - Used memory (calculated as total - free - buffers - cache) (in KB). -- **free** - Unused memory (MemFree and SwapFree in /proc/meminfo) (in KB). -- **shared** - Memory used (mostly) by tmpfs (Shmem in /proc/meminfo) (in KB). -- **buffers** - Sum of buffers and cache (in KB). -- **available** - Estimation of how much memory is available for starting new applications, without swapping (in KB). -- **usage** - Percentage of memory used out of the total amount of memory. - - -## Disk Extension - - -Only reports first device found. Improvements on the TODO. - -Metrics reported are: - -- **device** - Name of device. -- **reads** - The total number of KB read. -- **writes** - The total number of KB written. +Collects statistics from */proc/net/sockstats*. \ No newline at end of file