v2.1Введение
Введение
Что такое Сверло, какие задачи оно решает и с какой страницы начать чтение.
Сверло — библиотека для Node.js, которая превращает строки лога в объекты с полями ts, level, msg и fields. Она читает файлы и потоки построчно, не загружает лог в память целиком и умеет фильтровать записи коротким запросом вроде level>=warn status:5xx.
Это демо
Сверло — вымышленный продукт. Пакета sverlo на npm нет, а все примеры показывают, как выглядела бы документация. Настоящая здесь только сама документация и генератор, который её собрал.
Что она делает#
- Разбирает пять встроенных форматов:
nginx-combined,json-lines,logfmt,syslogи произвольные строки по шаблону. - Собирает многострочные записи, например стек-трейсы, в одну запись (многострочные записи).
- Работает потоком: на гигабайтном логе расход памяти не зависит от размера файла (потоки).
- Не падает на мусоре: битые строки попадают в
parser.errorsили пропускаются, как вы решите (ошибки).
С чего начать#
| Если вам нужно | Откройте |
|---|---|
| Поставить и запустить за пять минут | Установка, затем Быстрый старт |
| Разобрать свой формат | Шаблоны |
| Отфильтровать записи | Язык запросов |
| Понять, как это устроено | Архитектура |
| Перейти с версии 1 | Миграция с v1 |
Как читать эту документацию#
Слева дерево разделов, справа оглавление текущей страницы. Поиск открывается клавишей / и работает без сети, когда страница уже загружена. Версию и язык можно переключить в левой колонке: если у страницы нет пары в другой версии, откроется главная этой версии.