magpies

A command-line tool for polling and visualizing JSON-formatted time series metrics.

This tool does not require any schema or query definitions, making it ideal for quickly understanding an overview of targets that provide JSON-formatted metrics.

For more detailed or complex analysis, it is recommended to use more feature-rich tools such as Prometheus and Grafana.

Examples

```console // Install. $ cargo install magpies

// Print help. $ magpies -h Command-line tool for polling and visualizing JSON-formatted time series metrics

Usage: magpies

Commands: poll Poll the metrics of the specified targets and output the results in JSON Lines format to stdout view Launch the TUI viewer to visualize the results of the poll command target Generate a JSON object that defines a polling target help Print this message or the help of the given subcommand(s)

Options: -h, --help Print help -V, --version Print version

// Collect memory metrics via sysinfojson command. $ cargo install sysinfojson $ sysinfojson system memory | jq . { "memory": { "availablememory": 38591873024, "totalmemory": 68719476736, "totalswap": 0, "usedmemory": 32941457408, "used_swap": 0 } }

$ LOCALTARGET=$(magpies target --name local -- sysinfojson system memory) $ REMOTETARGET=$(magpies target --name remote -- ssh foo@bar sysinfojson system memory)

$ magpies poll $LOCALTARGET $REMOTETARGET | tee metrics.jsonl {"target":"local","timestamp":1727066396.667561,"metrics":{"memory":{"availablememory":38727598080,"totalmemory":68719476736,"totalswap":0,"usedmemory":32796721152,"usedswap":0}}} {"target":"remote","timestamp":1727066397.19239,"metrics":{"memory":{"availablememory":3853799424,"totalmemory":11564953600,"totalswap":8589930496,"usedmemory":7711154176,"usedswap":2966417408}}} {"target":"local","timestamp":1727066397.68037,"metrics":{"memory":{"availablememory":38723633152,"totalmemory":68719476736,"totalswap":0,"usedmemory":32799850496,"usedswap":0}}} {"target":"remote","timestamp":1727066398.052064,"metrics":{"memory":{"availablememory":3853238272,"totalmemory":11564953600,"totalswap":8589930496,"usedmemory":7711715328,"usedswap":2966417408}}} ...

// Launch the TUI viewer in a separate terminal. $ magpies view metrics.jsonl --interval 5 --portable-chart ┏Status━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓┏Help━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃Time: 120s ~ 124s (between 0s ~ 124s) ┃┃Quit: ┃ ┃Targets: 2 ┃┃Time:

rev, ext, tart, nd ┃ ┃Metrics: 5 (filter=.*) ┃┃Move: , , , , , ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ┏Aggregated Metrics━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓┏Metrics of "memory.usedmemory"━━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Name Value Delta/s ║┃┃ Target Value Delta/s █┃ ┃memory.availablememory 42,546,443,605 -353,293 ║┃┃local 32,797,085,696 -747,601 █┃ ┃memory.totalmemory 80,284,430,336 0 █┃┃remote 7,746,992,810 1,172,493 █┃ ┃memory.totalswap 8,589,930,496 0 █┃┃ █┃ ┃memory.usedmemory 40,544,078,506 424,891 █┃┃ █┃ ┃memory.usedswap 2,955,407,360 0 █┃┃ █┃ ┃ █┃┃ ║┃ ┃ █┃┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ┃ █┃┏Delta/s Chart of "memory.used_memory"━━━━━━━━━━━━━━━━━━━━┓ ┃ █┃┃ 2,629,345│ ••• •• •• ••• •••• ┃ ┃ █┃┃ │ • •••• • • •• •• •• ••• ••┃ ┃ █┃┃ │ • • • •• •• •• ┃ ┃ █┃┃ │• • • •• ┃ ┃ █┃┃-3,064,996│ • ┃ ┃ █┃┃ └──────────────────────────────────────────────┃ ┃ ║┃┃ 60s 120s┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ```