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

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2021-09-20 11:51:27 -07:00
parent 5e68ae5009
commit 932060314b
2 changed files with 41 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/parsers/ping_s.md
View File

@ -5,7 +5,7 @@ jc - JSON CLI output utility `ping` command output streaming parser
Usage (cli): Usage (cli):
$ ping | jc --ping_s $ ping | jc --ping-s
Usage (module): Usage (module):
@ -19,23 +19,47 @@ Usage (module):
Schema: Schema:
{ {
"ping": string, "type": string, # 'reply', 'timeout', 'summary', etc. See `_error_type.type_map` for all options.
"_meta": # This object only exists if using -q or quiet=True "source_ip": string,
"destination_ip": string,
"sent_bytes": integer,
"pattern": string, # (null if not set)
"destination": string,
"timestamp": float,
"response_bytes": integer,
"response_ip": string,
"icmp_seq": integer,
"ttl": integer,
"time_ms": float,
"duplicate": boolean,
"packets_transmitted": integer,
"packets_received": integer,
"packet_loss_percent": float,
"duplicates": integer,
"round_trip_ms_min": float,
"round_trip_ms_avg": float,
"round_trip_ms_max": float,
"round_trip_ms_stddev": float,
"_meta": # This object only exists if using -q or quiet=True
{ {
"success": booean, # true if successfully parsed, false if error "success": booean, # true if successfully parsed, false if error
"error": string, # exists if "success" is false "error": string, # exists if "success" is false
"line": string # exists if "success" is false "line": string # exists if "success" is false
} }
} }
Examples: Examples:
$ ping | jc --ping-s $ ping 1.1.1.1 | jc --ping-s
{example output} {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":0,"ttl":56,"time_ms":23.703}
{"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":1,"ttl":56,"time_ms":22.862}
{"type":"reply","destination_ip":"1.1.1.1","sent_bytes":56,"pattern":null,"response_bytes":64,"response_ip":"1.1.1.1","icmp_seq":2,"ttl":56,"time_ms":22.82}
... ...
$ ping | jc --ping-s -r $ ping 1.1.1.1 | jc --ping-s -r
{example output} {"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"0","ttl":"56","time_ms":"23.054"}
{"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"1","ttl":"56","time_ms":"24.739"}
{"type":"reply","destination_ip":"1.1.1.1","sent_bytes":"56","pattern":null,"response_bytes":"64","response_ip":"1.1.1.1","icmp_seq":"2","ttl":"56","time_ms":"23.232"}
... ...
@ -45,6 +69,12 @@ info()
``` ```
Provides parser metadata (version, author, etc.) Provides parser metadata (version, author, etc.)
## state
```python
state()
```
## parse ## parse
```python ```python
parse(data, raw=False, quiet=False) parse(data, raw=False, quiet=False)

2
jc/parsers/ping_s.py
View File

@ -16,7 +16,7 @@ Usage (module):
Schema: Schema:
{ {
"type": string, # 'reply', 'timeout', 'summary' "type": string, # 'reply', 'timeout', 'summary', etc. See `_error_type.type_map` for all options.
"source_ip": string, "source_ip": string,
"destination_ip": string, "destination_ip": string,
"sent_bytes": integer, "sent_bytes": integer,