Skip to content

Latest commit

 

History

History
111 lines (73 loc) · 3.64 KB

README.md

File metadata and controls

111 lines (73 loc) · 3.64 KB
Raw

Compact Log Event Format Tool Build status Download

The clef command-line tool reads and processes the newline-delimited JSON streams produced by Serilog.Formatting.Compact and other sources.

ℹ️ clef-tool is in maintenance mode. We're focusing our efforts on the later, more complete implementation of this functionality in seqcli, which is also open source, and works as a standalone tool. The seqcli print and seqcli ingest commands provide the main features of clef-tool.

What does CLEF look like?

CLEF is a very simple, compact JSON event format with standardized fields for timestamps, messages, levels and so-on.

{"@t":"2022-05-09T01:23:45.67890Z","@mt":"Starting up","MachineName":"web-53a889fe"}

Getting started

Binary releases can be downloaded directly from this project.

Or, if you have dotnet installed, clef can be installed as a global tool using:

dotnet tool install --global Datalust.ClefTool

And run with:

clef --help

Reading CLEF files

The default action, given a CLEF file, will be to pretty-print it in text format to the console.

> clef -i log-20220509.clef
[2022-05-09T01:23:45.67890Z INF] Starting up
[2022-05-09T01:23:45.96950Z INF] Checking for updates to version 123.4
...

The tool also accepts events on STDIN:

> cat log-20220509.clef | clef
...

Filtering

Expressions using the Serilog.Expressions syntax can be specified to filter the stream:

> clef -i log-20220509.clef --filter="Version > 100"
[2022-05-09T01:23:45.96950Z INF] Checking for updates to version 123.4

Formats

Output will be plain text unless another format is specified.

Write the output in JSON format using --format-json:

> clef -i log-20220509.clef --format-json
{"@t":"2022-05-09T01:23:45.67890Z","@mt":"Starting up"}
...

Control the output text format using --format-template:

> clef -i log-20220509.clef --format-template="{@m}{NewLine()}"
Starting up
...

Outputs

Output will be written to STDOUT unless another destination is specified.

Write output to a file with -o:

> clef -i log-20220509.clef -o log-20220509.txt

Send the output to Seq by specifying a server URL and optional API key:

> clef -i log-20220509.clef --out-seq="https://seq.example.com" --out-seq-apikey="1234567890"

Enrichment

Events can be enriched with additional properties by specifying them using the -p switch:

> clef -i log-20220509.clef -p CustomerId=C123 -p Environment=Support [...]

Filter and template syntax

The syntax supported in the --filter and --format-template arguments is documented in the Serilog.Expressions language reference.

The following functions are added:

Function Description
NewLine() Returns a platform-dependent newline character (supported in --format-template only).