RemyDuijkeren.OpenTelemetry.Instrumentation.DataverseServiceClient 0.9.0

Dataverse ServiceClient Instrumentation for OpenTelemetry .NET

This is an Instrumentation Library, which instruments Dataverse ServiceClient and collect traces about incoming Dataverse requests.

This component is based on the v1.23 of database semantic conventions. For details on the default set of attributes that are added, checkout Traces sections below.

Getting Started

Step 1: Install Package

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

dotnet add package RemyDuijkeren.OpenTelemetry.Instrumentation.DataverseServiceClient

Step 2: Enable Dataverse ServiceClient Instrumentation at application startup

Dataverse ServiceClient instrumentation must be enabled at application startup. This is typically done in the ConfigureServices of your Startup class. Both examples below enables OpenTelemetry by calling AddOpenTelemetry() on IServiceCollection. This extension method requires adding the package OpenTelemetry.Extensions.Hosting to the application. This ensures instrumentations are disposed when the host is shutdown.

Traces

The following example demonstrates adding Dataverse ServiceClient instrumentation with the extension method WithTracing() on OpenTelemetryBuilder. then extension method AddDataverseServiceClientInstrumentation() on TracerProviderBuilder to the application. This example also sets up the Console Exporter, which requires adding the package OpenTelemetry.Exporter.Console to the application.

using Microsoft.Extensions.DependencyInjection;
using OpenTelemetry.Trace;

public void ConfigureServices(IServiceCollection services)
{
    services.AddOpenTelemetry()
        .WithTracing(builder => builder
            .AddDataverseServiceClientInstrumentation()
            .AddConsoleExporter());
}

Following list of attributes are added by default on activity. See db-spans for more details about each individual attribute:

• db.operation
• db.sql.table
• db.statement
• db.system
• db.name
• db.connection_string
• db.user
• db.dataverse.organization_id
• db.dataverse.organization_version
• db.dataverse.geo
• error.type
• server.address
• server.port

References

• OpenTelemetry Project
• Implementing Instrumentation Library