add mpstat to docs

2025-06-23 00:29:59 +02:00 · 2022-03-11 14:54:06 -08:00
parent 2cddb1f0bb
commit d7efd25d88
4 changed files with 207 additions and 1 deletions
--- a/docs/parsers/mpstat.md
+++ b/docs/parsers/mpstat.md
@ -0,0 +1,136 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.mpstat"></a>
+
+# jc.parsers.mpstat
+
+jc - JSON Convert `mpstat` command output parser
+
+Usage (cli):
+
+    $ mpstat | jc --mpstat
+
+    or
+
+    $ jc mpstat
+
+Usage (module):
+
+    import jc
+    result = jc.parse('mpstat', mpstat_command_output)
+
+Schema:
+
+    [
+      {
+        "type":               string,
+        "time":               string,
+        "cpu":                string,
+        "average":            boolean,
+        "percent_usr":        float,
+        "percent_nice":       float,
+        "percent_sys":        float,
+        "percent_iowait":     float,
+        "percent_irq":        float,
+        "percent_soft":       float,
+        "percent_steal":      float,
+        "percent_guest":      float,
+        "percent_gnice":      float,
+        "percent_idle":       float,
+        "intr_s":             float,
+        "<x>_s":              float,      # <x> is an integer
+        "nmi_s":              float,
+        "loc_s":              float,
+        "spu_s":              float,
+        "pmi_s":              float,
+        "iwi_s":              float,
+        "rtr_s":              float,
+        "res_s":              float,
+        "cal_s":              float,
+        "tlb_s":              float,
+        "trm_s":              float,
+        "thr_s":              float,
+        "dfr_s":              float,
+        "mce_s":              float,
+        "mcp_s":              float,
+        "err_s":              float,
+        "mis_s":              float,
+        "pin_s":              float,
+        "npi_s":              float,
+        "piw_s":              float,
+        "hi_s":               float,
+        "timer_s":            float,
+        "net_tx_s":           float,
+        "net_rx_s":           float,
+        "block_s":            float,
+        "block_iopoll_s":     float,
+        "tasklet_s":          float,
+        "sched_s":            float,
+        "hrtimer_s":          float,
+        "rcu_s":              float
+      }
+    ]
+
+Examples:
+
+    $ mpstat | jc --mpstat -p
+    [
+      {
+        "cpu": "all",
+        "percent_usr": 12.94,
+        "percent_nice": 0.0,
+        "percent_sys": 26.42,
+        "percent_iowait": 0.43,
+        "percent_irq": 0.0,
+        "percent_soft": 0.16,
+        "percent_steal": 0.0,
+        "percent_guest": 0.0,
+        "percent_gnice": 0.0,
+        "percent_idle": 60.05,
+        "type": "cpu",
+        "time": "01:58:14 PM"
+      }
+    ]
+
+    $ mpstat | jc --mpstat -p -r
+    [
+      {
+        "cpu": "all",
+        "percent_usr": "12.94",
+        "percent_nice": "0.00",
+        "percent_sys": "26.42",
+        "percent_iowait": "0.43",
+        "percent_irq": "0.00",
+        "percent_soft": "0.16",
+        "percent_steal": "0.00",
+        "percent_guest": "0.00",
+        "percent_gnice": "0.00",
+        "percent_idle": "60.05",
+        "type": "cpu",
+        "time": "01:58:14 PM"
+      }
+    ]
+
+<a id="jc.parsers.mpstat.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+Main text parsing function
+
+Parameters:
+
+    data:        (string)  text data to parse
+    raw:         (boolean) unprocessed output if True
+    quiet:       (boolean) suppress warning messages if True
+
+Returns:
+
+    List of Dictionaries. Raw or processed structured data.
+
+### Parser Information
+Compatibility:  linux
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)