IceRpc.Telemetry 0.6.1

Telemetry interceptor and middleware for IceRPC

IceRpc.Telemetry provides an IceRPC interceptor and the corresponding middleware.

The telemetry interceptor starts an activity per request, following OpenTelemetry conventions. The activity context is propagated with the request using the trace context request field. The telemetry middleware starts an activity per dispatch. When the trace context request field is present in the incoming request the telemetry middleware restores the activity context and uses it to set the parent activity of the dispatch activity it starts.

The telemetry interceptor and middleware create activities only for requests that use the icerpc protocol; they don't create activities for requests that use the ice protocol.

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

Sample code

// Client application

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

// The activity source used by the telemetry interceptor.
using var activitySource = new ActivitySource("IceRpc");

// 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));

// Add the telemetry interceptor to the invocation pipeline.
Pipeline pipeline = new Pipeline().UseTelemetry(activitySource).Into(connection);

// Server application

using IceRpc;
using System.Diagnostics;

// The activity source used by the telemetry interceptor and middleware.
using var activitySource = new ActivitySource("IceRpc");

// Add the telemetry middleware to the dispatch pipeline.
Router router = new Router().UseTelemetry(activitySource);

Sample code with DI

This sample stays focused on the telemetry 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.DependencyInjection;
using Microsoft.Extensions.Hosting;
using System.Diagnostics;

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    .AddIceRpcClientConnection(new Uri("icerpc://localhost"))
    // The activity source used by the telemetry interceptor.
    .AddSingleton(_ => new ActivitySource("IceRpc"))
    .AddIceRpcInvoker(builder =>
        builder
            // Add the telemetry interceptor to the invocation pipeline.
            .UseTelemetry()
            .Into<ClientConnection>());

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

// Server application

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

HostApplicationBuilder hostBuilder = Host.CreateApplicationBuilder(args);

hostBuilder.Services
    // The activity source used by the telemetry middleware.
    .AddSingleton(_ => new ActivitySource("IceRpc"))
    .AddIceRpcServer(builder =>
        builder
            // Add the telemetry middleware to the dispatch pipeline.
            .UseTelemetry()
            .Map<...>());

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