OpenTelemetry.Instrumentation.ServiceFabricRemoting 1.14.0-beta.1

Service Fabric Remoting Instrumentation for OpenTelemetry .NET

This is an Instrumentation Library, which instruments Service Fabric Remoting and collects telemetry about incoming requests.

Steps to enable OpenTelemetry.Instrumentation.ServiceFabricRemoting

Step 1: Install Package

Add a reference to the OpenTelemetry.Instrumentation.ServiceFabricRemoting package. Also, add any other instrumentations & exporters you will need.

dotnet add package OpenTelemetry.Instrumentation.ServiceFabricRemoting

Step 2: Configure SF Remoting with Distributed Tracing instrumentation

These instructions are a moified vertion of the steps mentioned here: Use an assembly attribute to use the V2 stack

1. Change the endpoint resource from "ServiceEndpoint" to "ServiceEndpointV2" in the service manifest.

    <Resources>
     <Endpoints>
       <Endpoint Name="ServiceEndpointV2" />
     </Endpoints>
    </Resources>

2. Use the Microsoft.ServiceFabric.Services.Remoting.Runtime .CreateServiceRemotingInstanceListeners extension method to create remoting listeners.

    protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
    {
        return this.CreateServiceRemotingInstanceListeners();
    }

3. Mark the assembly that contains the remoting interfaces with a TraceContextEnrichedActorRemotingProvider and/or a TraceContextEnrichedServiceRemotingProvider attribute. Note that these attributes are not part of the Service Fabric SDK and are provided by the OpenTelemetry.Instrumentation.ServiceFabricRemoting package.*

   [assembly: TraceContextEnrichedActorRemotingProvider()]
   [assembly: TraceContextEnrichedServiceRemotingProvider()]

Step 3: Enable SF Remoting Instrumentation

Configure OpenTelemetry TracerProvider in Program.cs

Call the AddServiceFabricRemotingInstrumentation extension method on the TracerProviderBuilder to register the OpenTelemetry instrumentation.

    using TracerProvider tracerProvider = Sdk.CreateTracerProviderBuilder()
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("ServiceFabricRemoting-Example"))
        .AddServiceFabricRemotingInstrumentation()
        .AddOtlpExporter()
        .Build();

This will register the ServiceFabric.Remoting ActivitySource and create spans for incoming and outgoing remoting calls.

It will also automatically inject the trace context and Baggage into the remoting headers, and extract them on the receiving side.

Configuration options

The AddServiceFabricRemotingInstrumentation extension method takes an optional ServiceFabricRemotingInstrumentationOptions parameter that offers the following configurable settings:

• Filter - A filter function that can be used to exclude certain remoting calls from being instrumented. The function takes a ServiceRemotingRequest and returns a boolean value. If the function returns true, the remoting call will be instrumented. If the function returns false, the remoting call will not be instrumented. By default, all remoting calls are instrumented.

    TracerProvider tracerProvider = Sdk.CreateTracerProviderBuilder()
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("ServiceFabricRemoting-Example"))
        .AddServiceFabricRemotingInstrumentation(options =>
        {
            options.Filter = requestMessage =>
            {
                // Exclude remoting calls to a specific method
                IServiceRemotingRequestMessageHeader requestMessageHeader = requestMessage?.GetHeader();
                if (requestMessageHeader?.MethodName == "SomeMethodToIgnore")
                {
                    return false;
                }
                return true;
            };
        })
        .AddOtlpExporter()
        .Build();

• EnrichAtClientFromRequest - A function that can be used to enrich the span created for the client side of the remoting call. The function takes a Activity and a ServiceRemotingRequest and returns the Activity. By default, the client span is enriched with the service interface name and method name.

    TracerProvider tracerProvider = Sdk.CreateTracerProviderBuilder()
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("ServiceFabricRemoting-Example"))
        .AddServiceFabricRemotingInstrumentation(options =>
        {
            options.EnrichAtClientFromRequest = (activity, requestMessage) =>
            {
                // Add custom attributes to the client span
                activity.SetTag("CustomAttribute", "CustomValue");
                return activity;
            };
        })
        .AddOtlpExporter()
        .Build();

• EnrichAtServerFromRequest - A function that can be used to enrich the span created for the server side of the remoting call. The function takes a Activity and a ServiceRemotingRequest and returns the Activity. By default, the server span is enriched with the service interface name and method name.

    TracerProvider tracerProvider = Sdk.CreateTracerProviderBuilder()
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("ServiceFabricRemoting-Example"))
        .AddServiceFabricRemotingInstrumentation(options =>
        {
            options.EnrichAtServerFromRequest = (activity, requestMessage) =>
            {
                // Add custom attributes to the server span
                activity.SetTag("CustomAttribute", "CustomValue");
                return activity;
            };
        })
        .AddOtlpExporter()
        .Build();

• AddExceptionAtClient - Gets or sets a value indicating whether the exception will be recorded at the client as an ActivityEvent or not.

    TracerProvider tracerProvider = Sdk.CreateTracerProviderBuilder()
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("ServiceFabricRemoting-Example"))
        .AddServiceFabricRemotingInstrumentation(options =>
        {
            options.AddExceptionAtClient = true;
        })
        .AddOtlpExporter()
        .Build();

• AddExceptionAtServer - Gets or sets a value indicating whether the exception will be recorded at the server as an ActivityEvent or not

    TracerProvider tracerProvider = Sdk.CreateTracerProviderBuilder()
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("ServiceFabricRemoting-Example"))
        .AddServiceFabricRemotingInstrumentation(options =>
        {
            options.AddExceptionAtServer = true;
        })
        .AddOtlpExporter()
        .Build();

References

• Azure Service Fabric documentation
• OpenTelemetry Project