IceRpc.Logger 0.6.1

Logger interceptor and middleware for IceRPC

IceRpc.Logger provides an IceRPC interceptor that logs every invocation and an IceRPC middleware that logs every dispatch.

Source code | Package | Example | API reference | Interceptor documentation | Middleware documentation

Sample code

// Client application

using IceRpc;
using Microsoft.Extensions.Logging;
using System.Security.Cryptography.X509Certificates;

// Create a simple console logger factory and configure the log level for category IceRpc.
using ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
    builder
        .AddSimpleConsole()
        .AddFilter("IceRpc", LogLevel.Debug));

// Load the test root CA certificate in order to connect to the server that uses a test
// server certificate.
using var rootCA = X509CertificateLoader.LoadCertificateFromFile("certs/cacert.der");

await using var connection = new ClientConnection(
    new Uri("icerpc://localhost"),
    // examples/common/Program.Authentication.cs in the icerpc-csharp repo provides the
    // CreateClientAuthenticationOptions helper method
    clientAuthenticationOptions: CreateClientAuthenticationOptions(rootCA));

// Create an invocation pipeline and install the logger interceptor. This interceptor logs
// invocations using category `IceRpc.Logger.LoggerInterceptor`.
Pipeline pipeline = new Pipeline()
    .UseLogger(loggerFactory)
    .Into(connection);

// Server application

using IceRpc;
using Microsoft.Extensions.Logging;

// Create a simple console logger factory and configure the log level for category IceRpc.
using ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
    builder
        .AddSimpleConsole()
        .AddFilter("IceRpc", LogLevel.Debug));

// Create a router (dispatch pipeline) and install the logger middleware. This middleware
// logs dispatches using category `IceRpc.Logger.LoggerMiddleware`.
Router router = new Router()
    .UseLogger(loggerFactory)
    .Map(...);

Sample code with DI

This sample stays focused on the logger registration. For a complete Generic Host setup with certificates and configuration, see the GenericHost example.

// Client application

using IceRpc;
using IceRpc.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    .AddIceRpcClientConnection(new Uri("icerpc://localhost"))
    .AddIceRpcInvoker(builder =>
        // Add the logger interceptor to the invocation pipeline.
        builder
            .UseLogger()
            .Into<ClientConnection>());

using IHost host = hostBuilder.Build();
host.Run();

// Server application

using IceRpc;
using IceRpc.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    .AddIceRpcServer(builder =>
        // Add the logger middleware to the dispatch pipeline.
        builder
            .UseLogger()
            .Map<...>());

using IHost host = hostBuilder.Build();
host.Run();