Serilog Sink

The Serilog sink logs details about the connector and the records it processes.
The Serilog sink supports writing logs to the following outputs:
Configure these outputs with the Serilog settings in the configuration file.
Prerequisites
Section titled “Prerequisites”Before using the Serilog sink connector, ensure you have:
- A KurrentDB instance with connectors enabled
- A Seq server (optional, only required when using Seq as the output destination)
Quickstart
Section titled “Quickstart”Create the Serilog sink with client.Connectors. Replace example-serilog with your own
connector id:
Dictionary<string, string> settings = new() { ["instanceTypeName"] = "serilog-sink", ["subscription:filter:scope"] = "stream", ["subscription:filter:filterType"] = "streamId", ["subscription:filter:expression"] = "example-stream"};
await client.Connectors.Create("example-serilog", settings);await client.Connectors.Start("example-serilog");Once started, the connector prints each record appended to example-stream to the console.
Managing Connectors covers the rest of the lifecycle.
Here is an example:
78689502-9502-9502-9502-172978689502 example-stream@16437 eventType178699411-9411-9411-9411-172978699411 example-stream@18975 eventType278699614-9614-9614-9614-172978699614 example-stream@19142 eventType378699732-9732-9732-9732-172978699732 example-stream@21170 eventType478699899-9899-9899-9899-172978699899 example-stream@23711 eventType5Settings
Section titled “Settings”Adjust these settings to control how the Serilog sink connector behaves and how it interacts with KurrentDB.
The Serilog sink can be configured with the following options:
| Name | Details |
|---|---|
configuration |
Description: The JSON serilog configuration. Accepted Values: A base64 encoded string of the serilog configuration Default: If not provided, it writes to the console |
includeRecordData |
Description: Whether the record data should be included in the log output. Default: "true" |
Examples
Section titled “Examples”Write to Seq
Section titled “Write to Seq”-
Refer to the Seq documentation for installation instructions.
-
Configure the Serilog sink to export logs to Seq by following these steps:
{ "Serilog": { "Using": ["Serilog.Sinks.Seq"], "WriteTo": [ { "Name": "Seq", "Args": { "serverUrl": "http://localhost:5341", "payloadFormatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact" } } ] }}{ "configuration": "ewogICJTZXJpbG9nIjogewogICAgIlVzaW5nIjogWyJTZXJpbG9nLlNpbmtzLlNlcSJdLAogICAgIldyaXRlVG8iOiBbCiAgICAgIHsKICAgICAgICAiTmFtZSI6ICJTZXEiLAogICAgICAgICJBcmdzIjogewogICAgICAgICAgInNlcnZlclVybCI6ICJodHRwOi8vbG9jYWxob3N0OjUzNDEiLAogICAgICAgICAgInBheWxvYWRGb3JtYXR0ZXIiOiAiU2VyaWxvZy5Gb3JtYXR0aW5nLkNvbXBhY3QuQ29tcGFjdEpzb25Gb3JtYXR0ZXIsIFNlcmlsb2cuRm9ybWF0dGluZy5Db21wYWN0IgogICAgICAgIH0KICAgICAgfQogICAgXQogIH0KfQ=="}- Browse the Seq UI at
http://localhost:5341to view the logs.
Follow the configuration guide from Serilog Seq for more details.
Write to a file
Section titled “Write to a file”Encode the JSON configuration to base64, then provide the base64 encoded configuration to the Serilog sink connector.
{ "Serilog": { "WriteTo": [ { "Name": "File", "Args": { "path": "/tmp/logs/log.txt", "rollingInterval": "Infinite" } } ] }}{ "configuration": "ewogICJTZXJpbG9nIjogewogICAgIldyaXRlVG8iOiBbCiAgICAgIHsKICAgICAgICAiTmFtZSI6ICJGaWxlIiwKICAgICAgICAiQXJncyI6IHsKICAgICAgICAgICJwYXRoIjogIi90bXAvbG9ncy9sb2cudHh0IiwKICAgICAgICAgICJyb2xsaW5nSW50ZXJ2YWwiOiAiSW5maW5pdGUiCiAgICAgICAgfQogICAgICB9CiAgICBdCiAgfQp9"}This writes logs to /tmp/logs/log.txt.
Follow the configuration guide from Serilog File for more details.