Serilog.Sinks.NamedPipe 1.1.1-ci0015

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.

Optionally, you can use the Serilog.Sinks.NamedPipe.Reader package to read log events from the named pipe.

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. Have the sink write to a NamedPipeServerStream

This sink will create a NamedPipeServerStream and wait for a connection from a named pipe client (by default: asynchronous, with InOut direction, and Byte transmission mode).

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

2. Have the sink write to a NamedPipeClientStream

This sink will create a NamedPipeClientStream and connect to a named pipe server (by default: asynchronous, with InOut direction, and Byte transmission mode).

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

3. Have the sink write to any kind of PipeStream

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 = NamedPipeFactories.CreateFactory(
    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 NamedPipeFactories.CreateFactory(getStream, connect):

async ValueTask<PipeStream> MyPipeStreamFactory(CancellationToken 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(MyPipeStreamFactory)
    .CreateLogger();

Sink Options

The NamedPipeServer and NamedPipeClient sinks also provide the following optional parameters:

License

This library is licensed under the MIT License.