Serilog.Sinks.NamedPipe 1.0.2-ci0002

Serilog.Sinks.NamedPipe

This Serilog sink writes events to a named pipe.

It supports automatically re-establishing a connection to the named pipe if it closes/fails, and also buffering undelivered log events.

The sink uses a background worker for sending events to the named pipe, and will not block the calling thread.

Getting started

Install the package from Nuget:

dotnet add package Serilog.Sinks.NamedPipe

Configure the logger:

There are three different named pipe sink implementations you can choose from. See the following examples at their most basic (note however there are several additional optional parameters available and documented further down):

1. Host a NamedPipeServerStream in the sink

This sink will create a NamedPipeServerStream and wait for a connection from a named pipe client.

Log.Logger = new LoggerConfiguration()
    .WriteTo.NamedPipeServer("pipeName")
    .CreateLogger();

2. Host a NamedPipeClientStream in the sink

This sink will create a NamedPipeClientStream and connect to a named pipe server.

Log.Logger = new LoggerConfiguration()
    .WriteTo.NamedPipeClient("pipeName")
    .CreateLogger();

3. Host any kind of PipeStream in the sink

This sink allows you complete control over the creation of the named pipe stream.

The factory is called each time a new connection is required and must also not return until it has a connected stream.

The factory should only dispose of the stream if an exception is thrown while connecting. Under all other conditions, the sink will dispose of the stream when it is finished with it.

var factory = NamedPipeSink.CreatePipeStreamFactory(
    getStream: () => new NamedPipeServerStream("pipeName", PipeDirection.InOut, 1, PipeTransmissionMode.Message, PipeOptions.Asynchronous),
    connect: (pipe, cancellationToken) => pipe.WaitForConnectionAsync(cancellationToken)
);

Log.Logger = new LoggerConfiguration()
    .WriteTo.NamedPipe(factory)
    .CreateLogger();

Or more verbosely, foregoing the convenience of NamedPipeStream.CreatePipeStreamFactory(getStream, connect):

PipeStreamFactory factory = async cancellationToken => {
    //This example uses a NamedPipeServerStream in Message transmission mode, but you can use any kind of PipeStream.
    var pipe = new NamedPipeServerStream("pipeName", PipeDirection.InOut, 1, PipeTransmissionMode.Message, PipeOptions.Asynchronous);
    
    try {
        //Wait for a client to connect.
        await pipe.WaitForConnectionAsync(cancellationToken);
        return pipe;

    } catch {
        //Dispose of the stream if it errors while connecting, then propogate the exception out so the sink can handle it.
        pipe.Dispose();
        throw;
    }
};

Log.Logger = new LoggerConfiguration()
    .WriteTo.NamedPipe(factory)
    .CreateLogger();

Sink Options

All sinks also provide the following optional parameters: