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
Lnav
Что это такое?lnav — это просмотрщик лог-файлов для терминала. Укажите ему на файлы или каталоги, и он определит их форматы, объединит всё в единую картину, упорядоченную по времени, и продолжит следить за ними по мере поступления новых сообщений.
Чем это лучше, чем просто tail, grep или less?Эти утилиты работают только с сырыми текстовыми строками, а lnav понимает лог-сообщения. Tail не покажет сообщения в хронологическом порядке и не даст пролистать назад, grep не вернёт многострочное сообщение целиком, less открывает по одному файлу за раз, и none из них не умеет читать сжатые файлы.
Как установить и запустить?Скачайте статически слинкованный бинарник для Linux, MacOS или Windows со страницы релизов или используйте Brew на MacOS. Затем просто запустите 'lnav' на файлах или каталогах, за которыми нужно следить, — TUI откроется и сразу начнёт индексацию.
Нужно ли что-то ещё установить для работы?Нет — бинарники из релизов статически слинкованы и работают сами по себе. Если же собирать из исходников, понадобятся компилятор C++14, libpcre2, SQLite 3.9+, zlib, bzip2, libcurl 7.23+, libarchive, libunistring, tshark, а также cargo/Rust для компилятора PRQL.
Любой ли открытый мной файл попадёт в просмотр логов?В режим LOG попадают только файлы, сообщения из которых lnav смог распознать. Файлы без узнаваемых лог-сообщений всё равно видны в отдельном режиме TEXT — нажмите t, чтобы перейти к нему.
Отправляет ли lnav какие-то данные по сети?Согласно его политике подписи кода, нет — программа не будет передавать информацию другим системам в сети, если пользователь или установщик явно этого не запросит.
Что реально можно делать внутри режима lnav?Переходить к предыдущей или следующей ошибке клавишами e/E, искать по регулярным выражениям через /, фильтровать и подсвечивать сообщения регулярками, нажать P для красивого форматирования структурированного текста вроде JSON-lines, а клавиша i покажет гистограмму сообщений по времени.
Можно ли анализировать логи через SQL?Да — SQLite встроен. Нажмите ; в TUI, чтобы выполнять запросы к проиндексированным сообщениям, а фильтры сообщений могут использовать выражения SQLite вместо обычных регулярных выражений.
Можно ли попробовать lnav до установки?Да, по SSH. Команда 'ssh [email protected]' запускает lnav с парой примеров лог-файлов, а 'ssh [email protected]' открывает интерактивный урок с основами работы.
Работает ли он с логами systemd-journald?Да — lnav может работать как пейджер для journalctl, включая режим слежения, а JSON-вывод journalctl даёт ему дополнительные поля вроде PRIORITY. На долго работающих системах для эффективности ограничьте входные данные (например, --since или -b).
What are similar projects?glances, goaccess, k9s, sampler, osquery, witr, btop, apprise
Which topics is it in?less, logging, tui, sysadmin, observability, json, bsd, sqlite, cpp, c++, monitoring, command-line
Creator
tstack
Size
68.9 MB
Stars
10.7K
Updated
CommitOct 14Releasev0.14.1Sep 05
Age
17y
Commits · 90 Days