jc/docs/parsers/pidstat_s.md

Home

jc.parsers.pidstat_s

jc - JSON Convert pidstat command output streaming parser

This streaming parser outputs JSON Lines

Must use the -h option in pidstat. All other pidstat options are supported in combination with -h.

Usage (cli):

$ pidstat | jc --pidstat-s

Usage (module):

import jc
# result is an iterable object (generator)
result = jc.parse('pidstat_s', pidstat_command_output.splitlines())
for item in result:
    # do something

or

import jc.parsers.pidstat_s
# result is an iterable object (generator)
result = jc.parsers.pidstat_s.parse(pidstat_command_output.splitlines())
for item in result:
    # do something

Schema:

{
  "time":             integer,
  "uid":              integer,
  "pid":              integer,
  "percent_usr":      float,
  "percent_system":   float,
  "percent_guest":    float,
  "percent_cpu":      float,
  "cpu":              integer,
  "minflt_s":         float,
  "majflt_s":         float,
  "vsz":              integer,
  "rss":              integer,
  "percent_mem":      float,
  "stksize":          integer,
  "stkref":           integer,
  "kb_rd_s":          float,
  "kb_wr_s":          float,
  "kb_ccwr_s":        float,
  "cswch_s":          float,
  "nvcswch_s":        float,
  "command":          string,

  # below object only exists if using -qq or ignore_exceptions=True
  "_jc_meta": {
    "success":        boolean,     # false if error parsing
    "error":          string,      # exists if "success" is false
    "line":           string       # exists if "success" is false
  }
}

Examples:

$ pidstat -hl | jc --pidstat-s
{"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_system...}
{"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_system...}
{"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_system...}
...

$ pidstat -hl | jc --pidstat-s -r
{"time":"1646859134","uid":"0","pid":"1","percent_usr":"0.00","perc...}
{"time":"1646859134","uid":"0","pid":"6","percent_usr":"0.00","perc...}
{"time":"1646859134","uid":"0","pid":"9","percent_usr":"0.00","perc...}
...

parse

@add_jc_meta
def parse(data: Iterable[str],
          raw: bool = False,
          quiet: bool = False,
          ignore_exceptions: bool = False) -> Union[Iterable[Dict], tuple]

Main text parsing generator function. Returns an iterator object.

Parameters:

data:              (iterable)  line-based text data to parse
                               (e.g. sys.stdin or str.splitlines())

raw:               (boolean)   unprocessed output if True
quiet:             (boolean)   suppress warning messages if True
ignore_exceptions: (boolean)   ignore parsing exceptions if True

Yields:

Dictionary. Raw or processed structured data.

Returns:

Iterator object (generator)

Parser Information

Compatibility: linux

Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)