v2.1Introduction
Introduction
What Sverlo is, which problems it solves and which page to read first.
Sverlo is a Node.js library that turns log lines into objects with ts, level, msg and fields. It reads files and streams line by line, never loads a whole log into memory, and filters records with a short query such as level>=warn status:5xx.
This is a demo
Sverlo is a fictional product. There is no sverlo package on npm, and every example shows what the documentation would look like. What is real here is the documentation itself and the generator that built it.
What it does#
- Parses five built-in formats:
nginx-combined,json-lines,logfmt,syslogand arbitrary lines through a pattern. - Joins multi-line records such as stack traces into one record.
- Streams: memory use on a gigabyte log does not depend on the file size (streaming).
- Does not fall over on garbage: unparsed lines go to
parser.errorsor are skipped, as you decide.
Where to start#
| If you need | Open |
|---|---|
| Install and run in five minutes | Install, then Quick start |
| Parse your own format | Patterns |
| Filter records | Query language |
| Understand the design | Architecture |
| Upgrade from version 1 | Migrating from v1 |
How to read these docs#
The section tree is on the left, the outline of the current page on the right. Search opens with the / key and works offline once the page has loaded. Version and language switches are in the left column: if a page has no counterpart in the other version, that version's home opens.