IceRpc.Metrics 0.6.1

Metrics interceptor and middleware for IceRPC

IceRpc.Metrics provides an IceRPC interceptor and an IceRPC middleware.

The metrics interceptor instruments invocations using the Meter API, while the metrics middleware instruments dispatches using the same API.

You can display the collected measurements with dotnet-counters and other tools.

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

Sample code

// Client application

using IceRpc;
using System.Security.Cryptography.X509Certificates;

// 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 metrics interceptor.
Pipeline pipeline = new Pipeline().UseMetrics().Into(connection);

// Server application

using IceRpc;

// Create a router (dispatch pipeline) and install the metrics middleware.
Router router = new Router().UseMetrics().Map(...);

Sample code with DI

This sample stays focused on the metrics 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 =>
        builder
            // Add the metrics interceptor to the invocation pipeline.
            .UseMetrics()
            .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 =>
        builder
            // Add the metrics middleware to the dispatch pipeline.
            .UseMetrics()
            .Map<...>());

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