Serilog.Sinks.RedisStream

Custom Serilog sink to push log messages to a Redis Stream. Written for .Net Core applications

<TargetFramework>netstandard2.0</TargetFramework>

Getting Started

Redis 5.0 introduced Redis Streams, an append only log like data structure. This paradigm is a natural fit for application logging, so a common logging framework, Serilog, was extended through a custom sink to provide the functionality.

This readme will provide detail on the how the sink should be leveraged to communicate with Redis Streams.

Available on Nuget.

Prerequisites

For Microsoft .Net Core applications An accessible Redis instance >= v5.0.

Docker is not required to run the example application, however a Dockerfile and docker-compose.yml file are included to maintain a consistent environment.

To run a remote instance of Redis for tests, review the Redis Docker container.

Configuration

The Serilog configuration is code first configuration as seen below.

    var config = new RedisStreamSinkConfiguration{
                RedisConnectionString="localhost:6739",
                RedisStreamName = "ExampleApp" };

    Log.Logger = new LoggerConfiguration()
        .MinimumLevel.Information()
        .WriteTo.RedisStreamSink(config)
        .CreateLogger();

The default template for the log message that is written to the Redis Streams is below. It can be changed by overriding the outTemplate input parameter for the Serilog extension.

[{Timestamp:yyyy-MM-dd HH:mm:ss.fff} {Level:u3}] {Message:lj}{NewLine}{Exception}

The sink configuration leverages three primary settings.

1. RedisConnectionString - Required - Connection string to the Redis instance
2. RedisStreamName - Required - The Redis Stream where log entries for this sink will be written
3. RedisStreamMessageField - Optional - The name of the field that hosts the log message data within the Redis Stream. By default, it is message.

It is important to note that in the configuration above, all log messages up to the INFO subtype are processed. DEBUG logs are not processed. This can be overriden via the standard Serilog minimumlevel configuration.

Execution

Docker configuration files are located at the root of the solution.

The Dockerfile creates a Docker serilog-sinks-redisstream-example image locally. Use the following command to build the image.

docker build -t serilog-sinks-redisstream-example .

Utilize the Docker Compose command to initialize the environment with a Redis instance along side the .NetCore example application. Configurations for Docker Compose are found in the docker-compose.yml. The configuration requires the previously built serilog-sinks-redisstream-example image.

docker-compose up

After some initial Redis startup logging, the following should be seen in the Docker console.

console_1 | Logging configuration set. console_1 | {"RedisConnectionString":"redis:6379","RedisStreamName":"ExampleApp","RedisStreamMessageField":"message"} console_1 | Logger created. console_1 | Log entry written. serilogsinksredisstream_console_1 exited with code 0

If Serilog is correctly configured, the standard logger should automatically forward to the Redis Stream instance. You can test that the number of entries has incremented by using the following command from the Redis cli command:

xlen ExampleApp

Note the stream name comes from the configuration

Or review the values with the following command (note this brings back ALL of stream entries):

xrange ExampleApp - +

See the Redis Streams documentation for more information.

To ensure that your Redis instance is available, you can use the cli command to PING the instance. If successful, a PONG response is expected.

Clean up

To clean up the resultant Docker images, containers, and network, use the following command:

docker-compose down

Running the tests

The tests are XUnit unit tests. You can execute the tests, with code coverage analysis, by running from the root folder:

dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat=lcov /p:CoverletOutput=./lcov.info /p:Exclude=[xunit.*]*

Built With

• VSCode - Integrated Development Environment
• Redis - In-memory and persistent data strustures
• StackExchange.Redis - Redis Client
• Serilog - Base logging framework
• XUnit - Unit test framework
• Docker Compose - Containerization and Orchestation

Tags

Tags on this repository.

Authors

• @Guarrdon - Problem-solving, technology leader

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.