python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00
Code Issues Releases Activity

doc formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-03-10 13:02:50 -08:00
parent a5fb8fbf94
commit 8aee4517bb
2 changed files with 12 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/parsers/pidstat_s.md
View File

@ -5,7 +5,8 @@
jc - JSON Convert `pidstat` command output streaming parser
> This streaming parser outputs JSON Lines
> This streaming parser outputs JSON Lines (cli) or returns a Generator
iterator of Dictionaries (module)
Must use the `-h` option in `pidstat`. All other `pidstat` options are
supported in combination with `-h`.
@ -17,19 +18,11 @@ Usage (cli):
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:
{
@ -66,9 +59,9 @@ Schema:
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...}
{"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_syste...}
{"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_syste...}
{"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_syste...}
...
$ pidstat -hl | jc --pidstat-s -r

19
jc/parsers/pidstat_s.py
View File

@ -1,6 +1,7 @@
"""jc - JSON Convert `pidstat` command output streaming parser
> This streaming parser outputs JSON Lines
> This streaming parser outputs JSON Lines (cli) or returns a Generator
iterator of Dictionaries (module)
Must use the `-h` option in `pidstat`. All other `pidstat` options are
supported in combination with `-h`.
@ -12,19 +13,11 @@ Usage (cli):
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:
{
@ -61,9 +54,9 @@ Schema:
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...}
{"time":1646859134,"uid":0,"pid":1,"percent_usr":0.0,"percent_syste...}
{"time":1646859134,"uid":0,"pid":6,"percent_usr":0.0,"percent_syste...}
{"time":1646859134,"uid":0,"pid":9,"percent_usr":0.0,"percent_syste...}
...
$ pidstat -hl | jc --pidstat-s -r