OpenTelemetry Instrumentation

PhenX.EntityFrameworkCore.BulkInsert has built-in support for OpenTelemetry tracing via the PhenX.EntityFrameworkCore.BulkInsert.OpenTelemetry package.

Each bulk insert operation is automatically tracked as an Activity using the PhenX.EntityFrameworkCore.BulkInsert activity source, enabling distributed tracing and performance monitoring in your application.

Installation

Install the instrumentation NuGet package:

Install-Package PhenX.EntityFrameworkCore.BulkInsert.OpenTelemetry

Configuration

Register the instrumentation when configuring your OpenTelemetry TracerProvider by calling AddPhenXEntityFrameworkCoreBulkInsertInstrumentation():

using OpenTelemetry.Trace;

builder.Services.AddOpenTelemetry()
    .WithTracing(tracing => tracing
        .AddAspNetCoreInstrumentation()
        .AddPhenXEntityFrameworkCoreBulkInsertInstrumentation() // <-- add this
        .AddOtlpExporter()
    );

TracerProviderBuilderExtensions

AddPhenXEntityFrameworkCoreBulkInsertInstrumentation

public static TracerProviderBuilder AddPhenXEntityFrameworkCoreBulkInsertInstrumentation(
    this TracerProviderBuilder builder)

Adds the PhenX.EntityFrameworkCore.BulkInsert activity source to the given TracerProviderBuilder.

Parameters

Parameter	Type	Description
builder	TracerProviderBuilder	The TracerProviderBuilder to add the instrumentation to.

Returns

The TracerProviderBuilder with the PhenX.EntityFrameworkCore.BulkInsert instrumentation registered.

Traced Operations

The following bulk insert operations produce OpenTelemetry traces:

Operation	Description
ExecuteBulkInsert	Synchronous bulk insert without entity return
ExecuteBulkInsertAsync	Asynchronous bulk insert without entity return
ExecuteBulkInsertReturnEntities	Synchronous bulk insert with entity return
ExecuteBulkInsertReturnEntitiesAsync	Asynchronous bulk insert with entity return

Activity Source

The activity source name used by this library is:

PhenX.EntityFrameworkCore.BulkInsert

You can use this name to subscribe directly to the activity source if you need lower-level access:

using System.Diagnostics;

ActivitySource.AddActivityListener(new ActivityListener
{
    ShouldListenTo = source => source.Name == "PhenX.EntityFrameworkCore.BulkInsert",
    Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllDataAndRecorded,
    ActivityStarted = activity => Console.WriteLine($"Started: {activity.DisplayName}"),
    ActivityStopped = activity => Console.WriteLine($"Stopped: {activity.DisplayName} ({activity.Duration})"),
});