Skip to main content

Pretty Print Tailed JSONL Logs

Project description

tail-jsonl

Tail JSONL Logs

Background

I wanted to find a tool that could:

  1. Convert a stream of JSONL logs into a readable logfmt-like output with minimal configuration
  2. Show exceptions on their own line

I investigated a lot of alternatives such as: humanlog, lnav, goaccess, angle-grinder, jq, textualog, etc. but nothing would both cleanly format the JSONL data and show the exception.

.github/assets/demo.gif

Installation

Install with pipx

pipx install tail-jsonl

Usage

Pipe JSONL output from any file, kubernetes (such as stern), Docker, etc.

# Example piping input in shell
echo '{"message": "message", "timestamp": "2023-01-01T01:01:01.0123456Z", "level": "debug", "data": true, "more-data": [null, true, -123.123]}' | tail-jsonl
cat tests/data/logs.jsonl | tail-jsonl

# Optionally, pre-filter or format with jq, grep, awk, or other tools
cat tests/data/logs.jsonl | jq '.record' --compact-output | tail-jsonl

# An example stern command (also consider -o=extjson)
stern envvars --context staging --container gateway --since="60m" --output raw | tail-jsonl

# Or with Docker Compose (note that awk, cut, and grep all buffer. For awk, add '; system("")')
docker compose logs --follow | awk 'match($0, / \| \{.+/) { print substr($0, RSTART+3, RLENGTH); system("") }' | tail-jsonl

Configuration

Optionally, specify a path to a custom configuration file. See an example configuration file at: tests/config_default.toml

echo '...' | tail-jsonl --config-path=~/.tail-jsonl.toml

Project Status

See the Open Issues and/or the CODE_TAG_SUMMARY. For release history, see the CHANGELOG.

Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:

Code of Conduct

We follow the Contributor Covenant Code of Conduct.

Open Source Status

We try to reasonably meet most aspects of the "OpenSSF scorecard" from Open Source Insights

Responsible Disclosure

If you have any security issue to report, please contact the project maintainers privately. You can reach us at dev.act.kyle@gmail.com.

License

LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tail_jsonl-1.2.5.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

tail_jsonl-1.2.5-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file tail_jsonl-1.2.5.tar.gz.

File metadata

  • Download URL: tail_jsonl-1.2.5.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.5.0

File hashes

Hashes for tail_jsonl-1.2.5.tar.gz
Algorithm Hash digest
SHA256 d1dd05a1fceac6eae23c07a95745efaf1a451a691343eadf42029d4b16e62787
MD5 279e0a7365abe53c31b51dd8ed9e0aee
BLAKE2b-256 65482b14d261253eeb1216c9b5b0336c9711cf11385ba3bf02db723ca53146ce

See more details on using hashes here.

File details

Details for the file tail_jsonl-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: tail_jsonl-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.5.0

File hashes

Hashes for tail_jsonl-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 67576612d52bd3eb551a5e2f821d537d24bfbb86843f3ee1a9dbb9506b6c58c3
MD5 2fd9ec1dfbbba5fc078fe830d3d5b51d
BLAKE2b-256 b9124efc1ed20d8dcbb920ab543f071fbdc9b589abae86ca0fca6ec9bc5a35f3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page