lnav README

The project's README from github.com/tstack/lnav. As one markdown file: README.md.

Build Docs Coverage Status lnav Gurubase

Discord Logo

This is the source repository for lnav, visit https://lnav.org for a high level overview.

LNAV -- The Logfile Navigator

The Logfile Navigator is a log file viewer for the terminal. Given a set of files/directories, lnav will:

Then, in the lnav TUI, you can:

Screenshot

The following screenshot shows a mix of syslog and web access log files. Failed requests are shown in red. Identifiers, like IP address and PIDs are semantically highlighted.

Screenshot

Why not just use tail/grep/less?

The standard Unix utilities are great for processing raw text lines, however, they do not understand log messages. Tail can watch multiple files at a time, but it won't display messages in order by time and you can't scroll backwards. Grep will only find matching lines, but won't return a full multi-line log message. Less can only display a single file at a time. Also, none of these basic tools handle compressed files.

Try online before installing

You can SSH into a demo node to play with lnav before installing.

The "playground" account starts lnav with a couple of log files as an example:

$ ssh [email protected]

The "tutorial 1" account is an interactive tutorial that can teach you the basics of operation:

$ ssh [email protected]

Installation

Download a statically-linked binary for Linux/MacOS/Windows from the release page

Brew on MacOS

$ brew install lnav

FreeBSD

$ pkg install lnav

Usage

Simply point lnav at the files or directories you want to monitor, it will figure out the rest:

$ lnav /path/to/file1 /path/to/dir ...

The lnav TUI will pop up right away and begin indexing the files. Progress is displayed in the "Files" panel at the bottom. Once the indexing has finished, the LOG view will display the log messages that were recognized[^1]. You can then use the usual hotkeys to move around the view (arrow keys or j/k/h/l to move down/up/left/right).

See the Usage section of the online documentation for more information.

[^1]: Files that do not contain log messages can be seen in the TEXT view (reachable by pressing t).

Usage with systemd-journald

On systems running systemd-journald, you can use lnav as the pager:

$ journalctl | lnav

or in follow mode:

$ journalctl -f | lnav

Since journalctl's default output format omits the year, if you are viewing logs which span multiple years you will need to change the output format to include the year, otherwise lnav gets confused:

$ journalctl -o short-iso | lnav

It is also possible to use journalctl's json output format and lnav will make use of additional fields such as PRIORITY and _SYSTEMD_UNIT:

$ journalctl -o json | lnav

In case some MESSAGE fields contain special characters such as ANSI color codes which are considered as unprintable by journalctl, specifying journalctl's -a option might be preferable in order to output those messages still in a non-binary representation:

$ journalctl -a -o json | lnav

If using systemd v236 or newer, the output fields can be limited to the ones actually recognized by lnav for increased efficiency:

$ journalctl -o json --output-fields=MESSAGE,PRIORITY,_PID,SYSLOG_IDENTIFIER,_SYSTEMD_UNIT | lnav

If your system has been running for a long time, for increased efficiency you may want to limit the number of log lines fed into lnav, e.g. via journalctl's -n or --since=... options.

In case of a persistent journal, you may want to limit the number of log lines fed into lnav via journalctl's -b option.

Support

Please file issues on this repository or use the discussions section. The following alternatives are also available:

Contributing

Building From Source

Prerequisites

The following software packages are required to build lnav:

Build

Lnav follows the usual GNU style for configuring and installing software:

Run ./autogen.sh if compiling from a cloned repository.

$ ./configure
$ make
$ sudo make install

See Also

Angle-grinder is a tool to slice and dice log files on the command-line. If you're familiar with the SumoLogic query language, you might find this tool more comfortable to work with.

Code Signing Policy

Free code signing provided by SignPath.io, certificate by SignPath Foundation.

This program will not transfer any information to other networked systems unless specifically requested by the user or the person installing or operating it.

Acknowledgements

Many thanks to:

lnav (tstack/lnav)

Searching Database…

10.7K ·GitHub
What is this?lnav is a log file viewer for the terminal. Point it at files or directories and it detects their formats, merges them into a single view ordered by time, and keeps tailing them as new messages arrive.
How is it different from just using tail, grep or less?Those tools only process raw text lines, while lnav understands log messages. Tail won't show messages in time order or scroll backwards, grep won't return full multi-line messages, less shows one file at a time, and none of them handle compressed files.
How do I install and start it?Download a statically-linked binary for Linux, MacOS or Windows from the release page, or use Brew on MacOS. Then just run 'lnav' on the files or directories to monitor — the TUI opens and starts indexing right away.
Do I need to install anything else to get it running?No — the release binaries are statically linked and run standalone. If you build from source instead, you need a C++14 compiler, libpcre2, SQLite 3.9+, zlib, bzip2, libcurl 7.23+, libarchive, libunistring, tshark, and cargo/Rust for the PRQL compiler.
Will every file I open show up in the log view?Only files whose messages lnav recognizes appear in the LOG view. Files without recognizable log messages are still visible in the separate TEXT view — press t to reach it.
Does lnav send any data over the network?According to its code signing policy, no — it will not transfer information to other networked systems unless the user or installer specifically requests it.
What can I actually do inside the lnav view?Jump to the previous or next error with e/E, search with regular expressions via /, filter or highlight messages with regexes, press P to pretty-print structured text like JSON-lines, and press i for a histogram of messages over time.
Can I analyze my logs with SQL?Yes — SQLite is built in. Press ; in the TUI to run queries against the indexed messages, and message filters can also use SQLite expressions instead of plain regular expressions.
Can I try lnav before installing it?Yes, over SSH. 'ssh [email protected]' starts lnav with a couple of example log files, and 'ssh [email protected]' runs an interactive tutorial teaching the basics of operation.
Does it work with systemd-journald logs?Yes — lnav can serve as the pager for journalctl, including follow mode, and journalctl's JSON output gives it extra fields like PRIORITY. On long-running systems, limit the input (e.g. --since or -b) for efficiency.
What are similar projects?glances, goaccess, k9s, sampler, osquery, witr, btop, apprise
Creator
tstack
Size
68.9 MB
Stars
10.7K
Age
17y
Commits · 90 Days