Class TelemetryInterceptor

Namespace

IceRpc.Telemetry

Assembly

IceRpc.Telemetry.dll

An interceptor that starts an Activity per request, following OpenTelemetry conventions. The activity context is written in the request TraceContext field and can be restored on the server-side by installing the TelemetryMiddleware.

public class TelemetryInterceptor : IInvoker

Inheritance

object

TelemetryInterceptor

Implements

IInvoker

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

InvokerExtensions.InvokeBidiStreamingAsync<TInput, TOutput>(IInvoker, ServiceAddress, string, IAsyncEnumerable<TInput>, MessageParser<TOutput>, ProtobufEncodeOptions?, IFeatureCollection?, bool, CancellationToken)

InvokerExtensions.InvokeClientStreamingAsync<TInput, TOutput>(IInvoker, ServiceAddress, string, IAsyncEnumerable<TInput>, MessageParser<TOutput>, ProtobufEncodeOptions?, IFeatureCollection?, bool, CancellationToken)

InvokerExtensions.InvokeServerStreamingAsync<TOutput>(IInvoker, ServiceAddress, string, IMessage, MessageParser<TOutput>, ProtobufEncodeOptions?, IFeatureCollection?, bool, CancellationToken)

InvokerExtensions.InvokeUnaryAsync<TOutput>(IInvoker, ServiceAddress, string, IMessage, MessageParser<TOutput>, ProtobufEncodeOptions?, IFeatureCollection?, bool, CancellationToken)

Remarks

The activities are only created for requests using the icerpc protocol.

Constructors

TelemetryInterceptor(IInvoker, ActivitySource)

Constructs a telemetry interceptor.

public TelemetryInterceptor(IInvoker next, ActivitySource activitySource)

Parameters

next IInvoker

The next invoker in the invocation pipeline.

activitySource ActivitySource

The ActivitySource used to start the request activity.

Methods

InvokeAsync(OutgoingRequest, CancellationToken)

Sends an outgoing request and returns the corresponding incoming response.

public Task<IncomingResponse> InvokeAsync(OutgoingRequest request, CancellationToken cancellationToken)

Parameters

request OutgoingRequest

The outgoing request being sent.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task<IncomingResponse>

The corresponding IncomingResponse.

Remarks

When request is a two-way request, the returned task will not complete successfully until after the request's Payload is fully sent and the response is received from the peer. When the request is a one-way request, the returned task completes successfully with an empty response when the request's Payload is fully sent. For all requests (one-way and two-way), the sending of the request's PayloadContinuation can continue in a background task after the returned task has completed successfully.

See Also

TelemetryPipelineExtensions

TelemetryDispatcherBuilderExtensions