2 unstable releases
new 0.7.0 | Nov 24, 2024 |
---|---|
0.6.0 | Jul 13, 2023 |
#25 in #watch
73 downloads per month
30KB
673 lines
jsonwatch — like watch -d
, but for JSON
jsonwatch is a command-line utility that lets you track changes in JSON data delivered by a command or a web (HTTP/HTTPS) API.
jsonwatch requests data from the source repeatedly at a set interval.
It displays the differences when the data changes.
It is similar but not identical to how watch(1) with the -d
switch works for plain text.
jsonwatch has been tested on Debian 12, Ubuntu 24.04, macOS 14, and Windows 10 and Server 2022.
The two previous versions of jsonwatch are preserved in the branch
python
and
haskell
.
Installation
Prebuilt binaries are available for Linux (x86_64) and Windows (x86). Binaries are attached to releases on the "Releases" page.
Installing with Cargo
cargo install jsonwatch
Building on Debian and Ubuntu
Follow the instructions to build a static Linux binary of jsonwatch from the source code on recent Debian and Ubuntu.
1. Install Rustup. Through Rustup, add the stable musl libc target for your CPU.
rustup target add x86_64-unknown-linux-musl
2. Install the build and test dependencies.
sudo apt install build-essential expect musl-tools
cargo install just
3. Clone this repository. Build the binary.
git clone https://github.com/dbohdan/jsonwatch
cd jsonwatch
just test
just release-linux
Cross-compiling for Windows
Follow the instructions to build a 32-bit Windows binary of jsonwatch on recent Debian and Ubuntu.
1. Install Rustup. Through Rustup, add the i686 GNU ABI Windows target.
rustup target add i686-pc-windows-gnu
2. Install the build dependencies.
sudo apt install build-essential mingw-w64
cargo install just
3. Configure Cargo for cross-compilation.
Add the following to ~/.cargo/config
.
[target.i686-pc-windows-gnu]
linker = "/usr/bin/i686-w64-mingw32-gcc"
4. Clone this repository. Build the binary.
git clone https://github.com/dbohdan/jsonwatch
cd jsonwatch
just release-windows
Usage
You must run jsonwatch with a subcommand.
jsonwatch ignores data that isn't valid JSON.
General options
Track changes in JSON data
Usage: jsonwatch [OPTIONS] <COMMAND>
Commands:
cmd Execute a command and track changes in the JSON output
url Fetch a URL and track changes in the JSON data
help Print this message or the help of the given subcommand(s)
Options:
-D, --no-date Don't print date and time for each diff
-I, --no-initial-values Don't print initial JSON values
-d, --debug Print raw data to standard error with a timestamp
-n, --interval <seconds> Polling interval in seconds [default: 1]
-h, --help Print help
-V, --version Print version
cmd
subcommand
You can use c
, cmd
, or command
as the name of the subcommand.
Execute a command and track changes in the JSON output
Usage: jsonwatch cmd <command> [arg]...
Arguments:
<command> Command to execute
[arg]... Arguments to the command
Options:
-h, --help Print help
url
subcommand
You can use u
or url
as the name of the subcommand.
Fetch a URL and track changes in the JSON data
Usage: jsonwatch url [OPTIONS] <url>
Arguments:
<url> URL to fetch
Options:
-A, --user-agent <user-agent> Custom User-Agent string [default: curl/7.58.0]
-h, --help Print help
Use examples
Command
Testing jsonwatch
This example uses the POSIX shell to generate random JSON test data.
$ jsonwatch -n 1 cmd sh -c "echo '{ \"filename\": \"'\$(mktemp -u)'\"}'"
{
"filename": "/tmp/tmp.dh3Y7LJTaK"
}
2020-01-19T18:52:19+0000 .filename: "/tmp/tmp.dh3Y7LJTaK" -> "/tmp/tmp.i4s56VENEJ"
2020-01-19T18:52:20+0000 .filename: "/tmp/tmp.i4s56VENEJ" -> "/tmp/tmp.zzMUSn45Fc"
2020-01-19T18:52:21+0000 .filename: "/tmp/tmp.zzMUSn45Fc" -> "/tmp/tmp.Jj1cKt6VLr"
2020-01-19T18:52:22+0000 .filename: "/tmp/tmp.Jj1cKt6VLr" -> "/tmp/tmp.1LGk4ok8O2"
2020-01-19T18:52:23+0000 .filename: "/tmp/tmp.1LGk4ok8O2" -> "/tmp/tmp.wWulyho8Qj"
Docker
The command in this example tracks Docker process information when you have a single running container.
$ jsonwatch command docker ps -a "--format={{json .}}"
2020-01-19T18:57:20+0000
+ .Command: "\"bash\""
+ .CreatedAt: "2020-01-19 18:57:20 +0000 UTC"
+ .ID: "dce7fb2194ed"
+ .Image: "i386/ubuntu:latest"
+ .Labels: ""
+ .LocalVolumes: "0"
+ .Mounts: ""
+ .Names: "dreamy_edison"
+ .Networks: "bridge"
+ .Ports: ""
+ .RunningFor: "Less than a second ago"
+ .Size: "0B"
+ .Status: "Created"
2020-01-19T18:57:21+0000 .RunningFor: "Less than a second ago" -> "1 second ago"
2020-01-19T18:57:23+0000
.RunningFor: "1 second ago" -> "3 seconds ago"
.Status: "Created" -> "Up 1 second"
2020-01-19T18:57:24+0000
.RunningFor: "3 seconds ago" -> "4 seconds ago"
.Status: "Up 1 second" -> "Up 2 seconds"
2020-01-19T18:57:25+0000
.RunningFor: "4 seconds ago" -> "5 seconds ago"
.Status: "Up 2 seconds" -> "Up 3 seconds"
For multiple running containers, you will need a more complex jsonwatch command. The command needs to transform the JSON Lines output into a single JSON document. For example, it can be the following command with the POSIX shell and jq:
jsonwatch -I cmd sh -c 'docker ps -a "--format={{json .}}" | jq -s .'
cmd.exe
on Windows
This example is a simple test on Windows.
We start watching the output of a cmd.exe
command, then manually edit the file the command prints and are shown the changes.
> jsonwatch command cmd.exe /c "type tests\weather1.json"
{
"clouds": {
"all": 92
},
"name": "Kiev",
"coord": {
"lat": 50.43,
"lon": 30.52
},
"sys": {
"country": "UA",
"message": 0.0051,
"sunset": 1394985874,
"sunrise": 1394942901
},
"weather": [
{
"main": "Snow",
"id": 612,
"icon": "13d",
"description": "light shower sleet"
},
{
"main": "Rain",
"id": 520,
"icon": "09d",
"description": "light intensity shower rain"
}
],
"rain": {
"3h": 2
},
"base": "cmc stations",
"dt": 1394979003,
"main": {
"pressure": 974.8229,
"humidity": 91,
"temp_max": 277.45,
"temp": 276.45,
"temp_min": 276.15
},
"id": 703448,
"wind": {
"speed": 10.27,
"deg": 245.507
},
"cod": 200
}
2020-01-19T18:51:04+0000 + .test: true
2020-01-19T18:51:10+0000 .test: true -> false
2020-01-19T18:51:23+0000 - .test: false
URL
Weather tracking
The API in this example no longer works without a key.
$ jsonwatch url --no-initial-values -n 300 'http://api.openweathermap.org/data/2.5/weather?q=Kiev,ua'
2014-03-17T23:06:19.073790
+ .rain.1h: 0.76
- .rain.3h: 0.5
.dt: 1395086402 -> 1395089402
.main.temp: 279.07 -> 278.66
.main.temp_max: 279.82 -> 280.15
.main.temp_min: 277.95 -> 276.05
.sys.message: 0.0353 -> 0.0083
Geolocation
Try this on a mobile device.
$ jsonwatch u --no-initial-values -n 300 https://ipinfo.io/
License
jsonwatch is distributed under the MIT license.
See the file LICENSE
for details.
Wapp is copyright (c) 2017 D. Richard Hipp and is distributed under the Simplified BSD License.
Dependencies
~5.5–7.5MB
~128K SLoC