Skip to main content

A terminal log file viewer / tailer / analyzer

Project description

A Kookaburra sitting on a scroll

Discord

Toolong

A terminal application to view, tail, merge, and search log files (plus JSONL).

🎬 Viewing a single file

 

Keep calm and log files

See Toolong on Calmcode.io for a calming introduction to Toolong.

What?

Screenshot 2024-02-08 at 13 47 28
  • Live tailing of log files.
  • Syntax highlights common web server log formats.
  • As fast to open a multiple-gigabyte file as it is to open a tiny text file.
  • Support for JSONL files: lines are pretty printed.
  • Opens .bz and .bz2 files automatically.
  • Merges log files by auto detecting timestamps.

Why?

I spent a lot of time in my past life as a web developer working with logs, typically on web servers via ssh. I would use a variety of tools, but my goto method of analyzing logs was directly on the server with *nix tools like as tail, less, and grep etc. As useful as these tools are, they are not without friction.

I built toolong to be the tool I would have wanted back then. It is snappy, straightforward to use, and does a lot of the grunt work for you.

Screenshots

Screenshot 2024-02-08 at 13 47 28 Screenshot 2024-02-08 at 13 48 04
Screenshot 2024-02-08 at 13 49 22 Screenshot 2024-02-08 at 13 50 04

Videos

🎬 Merging multiple (compressed) files  
🎬 Viewing JSONL files  
🎬 Live Tailing a file  

How?

Toolong is currently best installed with pipx.

pipx install toolong

You could also install Toolong with Pip:

pip install toolong

[!NOTE] If you use pip, you should ideally create a virtual environment to avoid potential dependancy conflicts.

However you install Toolong, the tl command will be added to your path:

tl

In the near future there will be more install methods, and hopefully your favorite package manager.

Compatibility

Toolong works on Linux, macOS, and Windows.

Opening files

To open a file with Toolong, add the file name(s) as arguments to the command:

tl mylogfile.log

If you add multiple filenames, they will open in tabs.

Add the --merge switch to open multiple files and combine them in to a single view:

tl access.log* --merge

In the app, press f1 for additional help.

Piping

In addition to specifying files, you can also pipe directly into tl. This means that you can tail data that comes from another process, and not neccesarily a file. Here's an example of piping output from the tree command in to Toolong:

tree / | tl

Who?

This guy. An ex web developer who somehow makes a living writing terminal apps.


History

If you follow me on Twitter, you may have seen me refer to this app as Tailless, because it was intended to be a replacement for a tail + less combo. I settled on the name "Toolong" because it is a bit more apt, and still had the same initials.

Development

Toolong v1.0.0 has a solid feature set, which covers most of my requirements. However, there is a tonne of features which could be added to something like this, and I will likely implement some of them in the future.

If you want to talk about Toolong, find me on the Textualize Discord Server.

Thanks

I am grateful for the LogMerger project which I referenced (and borrowed regexes from) when building Toolong.

Alternatives

Toolong is not the first TUI for working with log files. See lnav as a more mature alternative.

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

toolong-1.5.0.tar.gz (30.5 kB view details)

Uploaded Source

Built Distribution

toolong-1.5.0-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file toolong-1.5.0.tar.gz.

File metadata

  • Download URL: toolong-1.5.0.tar.gz
  • Upload date:
  • Size: 30.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/23.4.0

File hashes

Hashes for toolong-1.5.0.tar.gz
Algorithm Hash digest
SHA256 49934701f954f9701d37381bed6e0f3dfbea0abe1065fcf1ff35de9eef3bbcf3
MD5 119d73e148c4392bdfa99bb7027023d2
BLAKE2b-256 45022a412839be723f58bd45c23c3fc89ea18c3bb76d5a3688c23c8e4f8c0734

See more details on using hashes here.

File details

Details for the file toolong-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: toolong-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/23.4.0

File hashes

Hashes for toolong-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc8e12b1937b3e6fd6b0e8ff924c0a9b1c3ad6171951655571f17d8ac2ca48ce
MD5 97fed6ba2bad5db620933320a60bec65
BLAKE2b-256 a7a36d414636ed190b5d3a74cbc3e2a0d34674166314f2cb9eae2e25a2a2d52f

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