From 8f539af4ab4ad4c4fae2dbc4197ca383e6a75235 Mon Sep 17 00:00:00 2001
From: Kelly Brazil <kellyjonbrazil@gmail.com>
Date: Fri, 16 Sep 2022 14:50:14 -0700
Subject: [PATCH] add proc-softirqs parser
---
docs/parsers/proc_pagetypeinfo.md | 4 +-
docs/parsers/proc_softirqs.md | 85 ++++++++++++++++++++
jc/lib.py | 1 +
jc/parsers/proc_pagetypeinfo.py | 4 +-
jc/parsers/proc_softirqs.py | 129 ++++++++++++++++++++++++++++++
man/jc.1 | 5 ++
6 files changed, 226 insertions(+), 2 deletions(-)
create mode 100644 docs/parsers/proc_softirqs.md
create mode 100644 jc/parsers/proc_softirqs.py
diff --git a/docs/parsers/proc_pagetypeinfo.md b/docs/parsers/proc_pagetypeinfo.md
index 3fdebf03..f1cfb990 100644
--- a/docs/parsers/proc_pagetypeinfo.md
+++ b/docs/parsers/proc_pagetypeinfo.md
@@ -38,7 +38,7 @@ Schema:
"zone": string,
"type": string,
"free": [
- integer
+ integer # [0]
]
],
"num_blocks_type": [
@@ -54,6 +54,8 @@ Schema:
]
}
+ [0] array index correlates to the Order number.
+ E.g. free[0] is the value for Order 0
Examples:
diff --git a/docs/parsers/proc_softirqs.md b/docs/parsers/proc_softirqs.md
new file mode 100644
index 00000000..150b5a73
--- /dev/null
+++ b/docs/parsers/proc_softirqs.md
@@ -0,0 +1,85 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.proc_softirqs"></a>
+
+# jc.parsers.proc\_softirqs
+
+jc - JSON Convert `/proc/softirqs` file parser
+
+Usage (cli):
+
+ $ cat /proc/softirqs | jc --proc
+
+or
+
+ $ jc /proc/softirqs
+
+or
+
+ $ cat /proc/softirqs | jc --proc-softirqs
+
+Usage (module):
+
+ import jc
+ result = jc.parse('proc', proc_softirqs_file)
+
+or
+
+ import jc
+ result = jc.parse('proc_softirqs', proc_softirqs_file)
+
+Schema:
+
+ [
+ {
+ "counter": string,
+ "CPU<number>": integer,
+ }
+ ]
+
+Examples:
+
+ $ cat /proc/softirqs | jc --proc -p
+ [
+ {
+ "counter": "HI",
+ "CPU0": 1,
+ "CPU1": 34056,
+ "CPU2": 0,
+ "CPU3": 0,
+ "CPU4": 0
+ },
+ {
+ "counter": "TIMER",
+ "CPU0": 322970,
+ "CPU1": 888166,
+ "CPU2": 0,
+ "CPU3": 0,
+ "CPU4": 0
+ },
+ ...
+ ]
+
+<a id="jc.parsers.proc_softirqs.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)
diff --git a/jc/lib.py b/jc/lib.py
index 7620d6f6..72c680bd 100644
--- a/jc/lib.py
+++ b/jc/lib.py
@@ -104,6 +104,7 @@ parsers = [
'proc-pagetypeinfo',
'proc-partitions',
'proc-slabinfo',
+ 'proc-softirqs',
'proc-pid-numa-maps',
'ps',
'route',
diff --git a/jc/parsers/proc_pagetypeinfo.py b/jc/parsers/proc_pagetypeinfo.py
index 9eaeadb4..08ef08ba 100644
--- a/jc/parsers/proc_pagetypeinfo.py
+++ b/jc/parsers/proc_pagetypeinfo.py
@@ -33,7 +33,7 @@ Schema:
"zone": string,
"type": string,
"free": [
- integer
+ integer # [0]
]
],
"num_blocks_type": [
@@ -49,6 +49,8 @@ Schema:
]
}
+ [0] array index correlates to the Order number.
+ E.g. free[0] is the value for Order 0
Examples:
diff --git a/jc/parsers/proc_softirqs.py b/jc/parsers/proc_softirqs.py
new file mode 100644
index 00000000..d4068ec1
--- /dev/null
+++ b/jc/parsers/proc_softirqs.py
@@ -0,0 +1,129 @@
+"""jc - JSON Convert `/proc/softirqs` file parser
+
+Usage (cli):
+
+ $ cat /proc/softirqs | jc --proc
+
+or
+
+ $ jc /proc/softirqs
+
+or
+
+ $ cat /proc/softirqs | jc --proc-softirqs
+
+Usage (module):
+
+ import jc
+ result = jc.parse('proc', proc_softirqs_file)
+
+or
+
+ import jc
+ result = jc.parse('proc_softirqs', proc_softirqs_file)
+
+Schema:
+
+ [
+ {
+ "counter": string,
+ "CPU<number>": integer,
+ }
+ ]
+
+Examples:
+
+ $ cat /proc/softirqs | jc --proc -p
+ [
+ {
+ "counter": "HI",
+ "CPU0": 1,
+ "CPU1": 34056,
+ "CPU2": 0,
+ "CPU3": 0,
+ "CPU4": 0
+ },
+ {
+ "counter": "TIMER",
+ "CPU0": 322970,
+ "CPU1": 888166,
+ "CPU2": 0,
+ "CPU3": 0,
+ "CPU4": 0
+ },
+ ...
+ ]
+"""
+from typing import List, Dict
+import jc.utils
+from jc.parsers.universal import simple_table_parse
+
+
+class info():
+ """Provides parser metadata (version, author, etc.)"""
+ version = '1.0'
+ description = '`/proc/softirqs` file parser'
+ author = 'Kelly Brazil'
+ author_email = 'kellyjonbrazil@gmail.com'
+ compatible = ['linux']
+ hidden = True
+
+
+__version__ = info.version
+
+
+def _process(proc_data: List[Dict]) -> List[Dict]:
+ """
+ Final processing to conform to the schema.
+
+ Parameters:
+
+ proc_data: (List of Dictionaries) raw structured data to process
+
+ Returns:
+
+ List of Dictionaries. Structured to conform to the schema.
+ """
+ return proc_data
+
+
+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.
+ """
+ jc.utils.compatibility(__name__, info.compatible, quiet)
+ jc.utils.input_type_check(data)
+
+ raw_output: List = []
+
+ if jc.utils.has_data(data):
+
+ cleandata = list(filter(None, data.splitlines()))
+ cleandata[0] = 'counter ' + cleandata[0]
+ raw_output = simple_table_parse(cleandata)
+
+ for item in raw_output:
+ if 'counter' in item:
+ item['counter'] = item['counter'][:-1]
+
+ for key in item:
+ try:
+ item[key] = int(item[key])
+ except Exception:
+ pass
+
+ return raw_output if raw else _process(raw_output)
diff --git a/man/jc.1 b/man/jc.1
index ab202336..506b65bd 100644
--- a/man/jc.1
+++ b/man/jc.1
@@ -505,6 +505,11 @@ PLIST file parser
\fB--proc-slabinfo\fP
`/proc/slabinfo` file parser
+.TP
+.B
+\fB--proc-softirqs\fP
+`/proc/softirqs` file parser
+
.TP
.B
\fB--proc-pid-numa-maps\fP