jc/docs/parsers/ps.md

jc.parsers.ps

jc - JSON CLI output utility ps Parser

Usage:

specify --ps as the first argument if the piped input is coming from ps

ps options supported:
- ef
- axu

Compatibility:

'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

Examples:

$ ps -ef | jc --ps -p
[
  {
    "uid": "root",
    "pid": 1,
    "ppid": 0,
    "c": 0,
    "stime": "Nov01",
    "tty": null,
    "time": "00:00:11",
    "cmd": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
  },
  {
    "uid": "root",
    "pid": 2,
    "ppid": 0,
    "c": 0,
    "stime": "Nov01",
    "tty": null,
    "time": "00:00:00",
    "cmd": "[kthreadd]"
  },
  {
    "uid": "root",
    "pid": 4,
    "ppid": 2,
    "c": 0,
    "stime": "Nov01",
    "tty": null,
    "time": "00:00:00",
    "cmd": "[kworker/0:0H]"
  },
  ...
]

$ ps -ef | jc --ps -p -r
[
  {
    "uid": "root",
    "pid": "1",
    "ppid": "0",
    "c": "0",
    "stime": "Nov01",
    "tty": "?",
    "time": "00:00:11",
    "cmd": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
  },
  {
    "uid": "root",
    "pid": "2",
    "ppid": "0",
    "c": "0",
    "stime": "Nov01",
    "tty": "?",
    "time": "00:00:00",
    "cmd": "[kthreadd]"
  },
  {
    "uid": "root",
    "pid": "4",
    "ppid": "2",
    "c": "0",
    "stime": "Nov01",
    "tty": "?",
    "time": "00:00:00",
    "cmd": "[kworker/0:0H]"
  },
  ...
]

$ ps axu | jc --ps -p
[
  {
    "user": "root",
    "pid": 1,
    "cpu_percent": 0.0,
    "mem_percent": 0.1,
    "vsz": 128072,
    "rss": 6784,
    "tty": null,
    "stat": "Ss",
    "start": "Nov09",
    "time": "0:08",
    "command": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
  },
  {
    "user": "root",
    "pid": 2,
    "cpu_percent": 0.0,
    "mem_percent": 0.0,
    "vsz": 0,
    "rss": 0,
    "tty": null,
    "stat": "S",
    "start": "Nov09",
    "time": "0:00",
    "command": "[kthreadd]"
  },
  {
    "user": "root",
    "pid": 4,
    "cpu_percent": 0.0,
    "mem_percent": 0.0,
    "vsz": 0,
    "rss": 0,
    "tty": null,
    "stat": "S<",
    "start": "Nov09",
    "time": "0:00",
    "command": "[kworker/0:0H]"
  },
  ...
]

$ ps axu | jc --ps -p -r
[
  {
    "user": "root",
    "pid": "1",
    "cpu_percent": "0.0",
    "mem_percent": "0.1",
    "vsz": "128072",
    "rss": "6784",
    "tty": "?",
    "stat": "Ss",
    "start": "Nov09",
    "time": "0:08",
    "command": "/usr/lib/systemd/systemd --switched-root --system --deserialize 22"
  },
  {
    "user": "root",
    "pid": "2",
    "cpu_percent": "0.0",
    "mem_percent": "0.0",
    "vsz": "0",
    "rss": "0",
    "tty": "?",
    "stat": "S",
    "start": "Nov09",
    "time": "0:00",
    "command": "[kthreadd]"
  },
  {
    "user": "root",
    "pid": "4",
    "cpu_percent": "0.0",
    "mem_percent": "0.0",
    "vsz": "0",
    "rss": "0",
    "tty": "?",
    "stat": "S<",
    "start": "Nov09",
    "time": "0:00",
    "command": "[kworker/0:0H]"
  },
  ...
]

info

info(self, /, *args, **kwargs)

process

process(proc_data)

Final processing to conform to the schema.

Parameters:

proc_data:   (dictionary) raw structured data to process

Returns:

List of dictionaries. Structured data with the following schema:

[
  {
    "uid":           string,
    "pid":           integer,
    "ppid":          integer,
    "c":             integer,
    "stime":         string,
    "tty":           string,    # ? or ?? = Null
    "tt":            string,    # ?? = Null
    "time":          string,
    "cmd":           string,
    "user":          string,
    "cpu_percent":   float,
    "mem_percent":   float,
    "vsz":           integer,
    "rss":           integer,
    "stat":          string,
    "start":         string,
    "command":       string
  }
]

parse

parse(data, raw=False, quiet=False)

Main text parsing function

Parameters:

data:        (string)  text data to parse
raw:         (boolean) output preprocessed JSON if True
quiet:       (boolean) suppress warning messages if True

Returns:

List of dictionaries. Raw or processed structured data.