1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/uptime.md

111 lines
2.0 KiB
Markdown
Raw Normal View History

[Home](https://kellyjonbrazil.github.io/jc/)
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.uptime"></a>
2020-07-30 16:20:24 -07:00
2019-11-11 18:30:46 -08:00
# jc.parsers.uptime
2022-01-25 17:07:47 -08:00
2020-08-05 16:51:58 -07:00
jc - JSON CLI output utility `uptime` command output parser
2019-11-11 18:30:46 -08:00
2020-08-05 13:32:59 -07:00
Usage (cli):
2019-12-12 09:47:14 -08:00
2022-01-25 17:07:47 -08:00
$ uptime | jc --uptime
2020-08-05 16:51:58 -07:00
2022-01-25 17:07:47 -08:00
or
2020-08-05 16:51:58 -07:00
2022-01-25 17:07:47 -08:00
$ jc uptime
2019-11-11 18:30:46 -08:00
2020-08-05 13:32:59 -07:00
Usage (module):
2022-01-25 17:07:47 -08:00
import jc
result = jc.parse('uptime', uptime_command_output)
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
or
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
import jc.parsers.uptime
result = jc.parsers.uptime.parse(uptime_command_output)
2020-08-05 13:32:59 -07:00
2021-04-08 16:14:11 -07:00
Schema:
2022-01-25 17:07:47 -08:00
{
"time": string,
"time_hour": integer,
"time_minute": integer,
"time_second": integer, # null if not displayed
"uptime": string,
"uptime_days": integer,
"uptime_hours": integer,
"uptime_minutes": integer,
"uptime_total_seconds": integer,
"users": integer,
"load_1m": float,
"load_5m": float,
"load_15m": float
}
**Example**:
$ uptime | jc --uptime -p
{
- `"time"` - "11:35",
- `"uptime"` - "3 days, 4:03",
- `"users"` - 5,
- `"load_1m"` - 1.88,
- `"load_5m"` - 2.0,
- `"load_15m"` - 1.94,
- `"time_hour"` - 11,
- `"time_minute"` - 35,
- `"time_second"` - null,
- `"uptime_days"` - 3,
- `"uptime_hours"` - 4,
- `"uptime_minutes"` - 3,
- `"uptime_total_seconds"` - 273780
}
$ uptime | jc --uptime -p -r
{
- `"time"` - "11:36",
- `"uptime"` - "3 days, 4:04",
- `"users"` - "5",
- `"load_1m"` - "1.88",
- `"load_5m"` - "1.99",
- `"load_15m"` - "1.94"
}
<a id="jc.parsers.uptime.info"></a>
## info Objects
2019-12-14 23:35:42 -08:00
```python
2022-01-25 17:07:47 -08:00
class info()
2019-12-14 23:35:42 -08:00
```
2022-01-25 17:07:47 -08:00
2021-04-08 16:14:11 -07:00
Provides parser metadata (version, author, etc.)
2020-07-30 16:20:24 -07:00
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.uptime.parse"></a>
#### parse
2019-11-11 18:30:46 -08:00
```python
2022-01-25 17:07:47 -08:00
def parse(data, raw=False, quiet=False)
2019-11-11 18:30:46 -08:00
```
2019-11-12 11:18:00 -08:00
Main text parsing function
2019-11-11 18:30:46 -08:00
2022-01-25 17:07:47 -08:00
**Arguments**:
2019-11-11 18:30:46 -08:00
2022-01-25 17:07:47 -08:00
- `data` - (string) text data to parse
- `raw` - (boolean) unprocessed output if True
- `quiet` - (boolean) suppress warning messages if True
2019-11-12 11:18:00 -08:00
2022-01-25 17:07:47 -08:00
**Returns**:
2019-11-12 11:18:00 -08:00
2022-01-25 17:07:47 -08:00
Dictionary. Raw or processed structured data
2019-11-11 18:30:46 -08:00
## Parser Information
Compatibility: linux, darwin, cygwin, aix, freebsd
2021-12-01 16:12:51 -08:00
Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)