Plugins

Status: Experimental.

You can use OTEL_DOTNET_AUTO_PLUGINS environment variable to extend the configuration and overwrite options of the OpenTelemetry .NET SDK Tracer, Meter or Logs. No more than one instance of each plugin type will be created. A plugin must be a non-static, non-abstract class which has a default constructor and that implements at least one of the configuration methods below showed in an example plugin class:

public class MyPlugin 
{
    // To configure plugin, before OTel SDK configuration is called.
    public void Initializing()
    {
        // My custom logic here
    }

    // To configure plugin, after auto instrumentation is initialized.
    public void Initialized()
    {
        // My custom logic here
    }

    // To access TracerProvider right after TracerProviderBuilder.Build() is executed.
    public void TracerProviderInitialized(TracerProvider tracerProvider)
    {
        // My custom logic here
    }

    // To access MeterProvider right after MeterProviderBuilder.Build() is executed.
    public void MeterProviderInitialized(MeterProvider meterProvider)
    {
        // My custom logic here
    }

    // To configure tracing SDK before Auto Instrumentation configured SDK
    public OpenTelemetry.Trace.TracerProviderBuilder BeforeConfigureTracerProvider(OpenTelemetry.Trace.TracerProviderBuilder builder)
    {
        // My custom logic here

        return builder;
    }

    // To configure tracing SDK after Auto Instrumentation configured SDK
    public OpenTelemetry.Trace.TracerProviderBuilder AfterConfigureTracerProvider(OpenTelemetry.Trace.TracerProviderBuilder builder)
    {
        // My custom logic here

        return builder;
    }
        
    // To configure any traces options used by OpenTelemetry .NET Automatic Instrumentation
    public void ConfigureTracesOptions(OpenTelemetry.NameSpace.OptionType options)
    {
        // My custom logic here
        // Find supported options below
    }

    // To configure metrics SDK before Auto Instrumentation configured SDK
    public OpenTelemetry.Metrics.MeterProviderBuilder BeforeConfigureMeterProvider(OpenTelemetry.Metrics.MeterProviderBuilder builder)
    {
        // My custom logic here

        return builder;
    }

    // To configure metrics SDK after Auto Instrumentation configured SDK
    public OpenTelemetry.Metrics.MeterProviderBuilder AfterConfigureMeterProvider(OpenTelemetry.Metrics.MeterProviderBuilder builder)
    {
        // My custom logic here

        return builder;
    }
    
    // To configure any metrics options used by OpenTelemetry .NET Automatic Instrumentation
    public void ConfigureMetricsOptions(OpenTelemetry.NameSpace.OptionType options)
    {
        // My custom logic here
        // Find supported options below
    }

    // To configure logs SDK (the method name is the same as for other logs options)
    public void ConfigureLogsOptions(OpenTelemetry.Logs.OpenTelemetryLoggerOptions options)
    {
        // My custom logic here
    }

    // To configure any logs options used by OpenTelemetry .NET Automatic Instrumentation
    public void ConfigureLogsOptions(OpenTelemetry.NameSpace.OptionType options)
    {
        // My custom logic here
        // Find supported options below
    }

    // To configure Resource
    public OpenTelemetry.Resources.ResourceBuilder ConfigureResource(OpenTelemetry.Resources.ResourceBuilder builder)
    {
        // My custom logic here
        // Please note this method is common to set the resource for trace, logs and metrics.
        // This method could be overridden by ConfigureTracesOptions, ConfigureMeterProvider and ConfigureLogsOptions
        // by calling SetResourceBuilder with new object.

        return builder;
    }
}

public class MyOpAmpPlugin 
{
    // To configure OpAMP client
    public void ConfigureOpAmpOptions(OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings options)
    {
        // My custom logic here
    }

    // To get the OpAMP client instance after client is created and started
    public void AfterOpAmpClientStarted(OpenTelemetry.OpAmp.Client.OpAmpClient client)
    {
        // My custom logic here
    }

    // To get the final callback before OpAMP client shuts down
    public void BeforeOpAmpClientStopped()
    {
        // My custom logic here
        // WARNING: This is already in application OnExit() cycle, do not add long running tasks.
    }
}

Supported Options

Tracing

Options type	NuGet package	NuGet version
OpenTelemetry.Exporter.ConsoleExporterOptions	OpenTelemetry.Exporter.Console	1.15.3
OpenTelemetry.Exporter.ZipkinExporterOptions Deprecated	OpenTelemetry.Exporter.Zipkin	1.15.3
OpenTelemetry.Exporter.OtlpExporterOptions	OpenTelemetry.Exporter.OpenTelemetryProtocol	1.15.3
OpenTelemetry.Instrumentation.AspNet.AspNetTraceInstrumentationOptions	OpenTelemetry.Instrumentation.AspNet	1.15.2
OpenTelemetry.Instrumentation.AspNetCore.AspNetCoreTraceInstrumentationOptions	OpenTelemetry.Instrumentation.AspNetCore	1.15.2
OpenTelemetry.Instrumentation.EntityFrameworkCore.EntityFrameworkInstrumentationOptions	OpenTelemetry.Instrumentation.EntityFrameworkCore	1.15.1-beta.1
OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientTraceInstrumentationOptions	OpenTelemetry.Instrumentation.GrpcNetClient	1.15.1-beta.1
OpenTelemetry.Instrumentation.Http.HttpClientTraceInstrumentationOptions	OpenTelemetry.Instrumentation.Http	1.15.1
OpenTelemetry.Instrumentation.Quartz.QuartzInstrumentationOptions	OpenTelemetry.Instrumentation.Quartz	1.15.1-beta.1
OpenTelemetry.Instrumentation.SqlClient.SqlClientTraceInstrumentationOptions	OpenTelemetry.Instrumentation.SqlClient	1.15.2
OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions	OpenTelemetry.Instrumentation.StackExchangeRedis	1.15.1-beta.1
OpenTelemetry.Instrumentation.Wcf.WcfInstrumentationOptions	OpenTelemetry.Instrumentation.Wcf	1.15.1-beta.2

Metrics

Options type	NuGet package	NuGet version
OpenTelemetry.Metrics.MetricReaderOptions	OpenTelemetry	1.15.3
OpenTelemetry.Exporter.ConsoleExporterOptions	OpenTelemetry.Exporter.Console	1.15.3
OpenTelemetry.Exporter.PrometheusExporterOptions	OpenTelemetry.Exporter.Prometheus.HttpListener	1.15.3-beta.1
OpenTelemetry.Exporter.OtlpExporterOptions	OpenTelemetry.Exporter.OpenTelemetryProtocol	1.15.3
OpenTelemetry.Instrumentation.AspNet.AspNetMetricsInstrumentationOptions	OpenTelemetry.Instrumentation.AspNet	1.15.2
OpenTelemetry.Instrumentation.Runtime.RuntimeInstrumentationOptions	OpenTelemetry.Instrumentation.Runtime	1.15.1

Logs

Options type	NuGet package	NuGet version
OpenTelemetry.Logs.OpenTelemetryLoggerOptions	OpenTelemetry	1.15.3
OpenTelemetry.Exporter.ConsoleExporterOptions	OpenTelemetry.Exporter.Console	1.15.3
OpenTelemetry.Exporter.OtlpExporterOptions	OpenTelemetry.Exporter.OpenTelemetryProtocol	1.15.3

OpAMP

Settings type	NuGet package	NuGet version
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings	OpenTelemetry.OpAmp.Client	0.3.0-alpha.1

Requirements

• The plugin must use the same version of the OpenTelemetry as the OpenTelemetry .NET Automatic Instrumentation.
• The plugin must use the same options versions as the OpenTelemetry .NET Automatic Instrumentation (found in the table above).