OpenTelemetry.Exporter.OpenTelemetryProtocol v1.13.1 — nugetz

dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol

var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(options =>
    {
        options.AddOtlpExporter();
    });
});

var meterProvider = Sdk.CreateMeterProviderBuilder()
    // rest of config not shown here.
    .AddOtlpExporter()
    .Build();

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    // rest of config not shown here.
    .AddOtlpExporter()
    .Build();

appBuilder.Services.AddOpenTelemetry()
    .UseOtlpExporter();

Calling UseOtlpExporter automatically enables logging, metrics, and tracing however only telemetry which has been enabled will be exported.

There are different mechanisms available to enable telemetry:
- Logging
  
  ILogger telemetry is controlled by category filters typically set through configuration. For details see: Log Filtering and Logging in .NET.
- Metrics
  
  Metrics telemetry is controlled by calling MeterProviderBuilder.AddMeter to listen to Meters emitting metrics. Typically instrumentation packages will make this call automatically.
  
  Examples:
  appBuilder.Services.AddOpenTelemetry() .UseOtlpExporter() .WithMetrics(metrics => metrics .AddMeter(MyMeter.Name) // Listen to custom telemetry .AddAspNetCoreInstrumentation() // Use instrumentation to listen to telemetry ); appBuilder.Services.ConfigureOpenTelemetryMeterProvider(metrics => metrics .AddMeter(MyMeter.Name) // Listen to custom telemetry .AddAspNetCoreInstrumentation() // Use instrumentation to listen to telemetry ); appBuilder.Services.AddOpenTelemetry() .UseOtlpExporter();
  For details see: Meter.
  
  When using Microsoft.Extensions.Hosting v8.0.0 or greater (a standard part of ASP.NET Core) Meters and Instruments can also be enabled using configuration.
  
  appSettings.json metrics configuration example:
  { "Metrics": { "EnabledMetrics": { "Microsoft.AspNetCore.*": true, "System.*": true, "MyCompany.*": true, } } }
  For details about the built-in metrics exposed by .NET see: Built-in metrics in .NET.
- Tracing
  
  Trace telemetry is controlled by calling TracerProviderBuilder.AddSource to listen to ActivitySources emitting traces. Typically instrumentation packages will make this call automatically.
  
  Examples:
  appBuilder.Services.AddOpenTelemetry() .UseOtlpExporter() .WithTracing(tracing => tracing .AddSource(MyActivitySource.Name) // Listen to custom telemetry .AddAspNetCoreInstrumentation() // Use instrumentation to listen to telemetry ); appBuilder.Services.ConfigureOpenTelemetryTracerProvider(tracing => tracing .AddSource(MyActivitySource.Name) // Listen to custom telemetry .AddAspNetCoreInstrumentation() // Use instrumentation to listen to telemetry ); appBuilder.Services.AddOpenTelemetry() .UseOtlpExporter();
  For details see: Activity Source.
The exporter registered by UseOtlpExporter will be added as the last processor in the pipeline established for logging and tracing.
UseOtlpExporter can only be called once. Subsequent calls will result in a NotSupportedException being thrown.
UseOtlpExporter cannot be called in addition to signal-specific AddOtlpExporter methods. If UseOtlpExporter is called signal-specific AddOtlpExporter calls will result in a NotSupportedException being thrown.

appBuilder.Services.AddOpenTelemetry()
    .UseOtlpExporter(OtlpExportProtocol.HttpProtobuf, new Uri("http://localhost:4318/"));

// Set via delegate using code:
appBuilder.Services.AddOpenTelemetry()
    .WithTracing(builder => builder.AddOtlpExporter(o => {
        // ...
    }));

// Set via Options API using code:
appBuilder.Services.Configure<OtlpExporterOptions>(o => {
    // ...
});

// Set via Options API using configuration:
appBuilder.Services.Configure<OtlpExporterOptions>(
    appBuilder.Configuration.GetSection("OpenTelemetry:otlp"));

// Step 1: Register user-created configuration service.
appBuilder.Services.AddSingleton<MyOtlpConfigurationService>();

// Step 2: Use Options API to configure OtlpExporterOptions with user-created service.
appBuilder.Services.AddOptions<OtlpExporterOptions>()
    .Configure<MyOtlpConfigurationService>((o, configService) => {
        o.Endpoint = configService.ResolveOtlpExporterEndpoint();
    });

// Set via delegate using code:
appBuilder.Logging.AddOpenTelemetry(options =>
{
    options.AddOtlpExporter((exporterOptions, processorOptions) =>
    {
        processorOptions.BatchExportProcessorOptions.ScheduledDelayMilliseconds = 2000;
        processorOptions.BatchExportProcessorOptions.MaxExportBatchSize = 5000;
    });
});

// Set via Options API using code:
appBuilder.Services.Configure<LogRecordExportProcessorOptions>(o =>
{
    o.BatchExportProcessorOptions.ScheduledDelayMilliseconds = 2000;
    o.BatchExportProcessorOptions.MaxExportBatchSize = 5000;
});

// Set via Options API using configuration:
appBuilder.Services.Configure<LogRecordExportProcessorOptions>(
    appBuilder.Configuration.GetSection("OpenTelemetry:Logging"));

// Set via delegate using code:
appBuilder.Services.AddOpenTelemetry()
    .WithMetrics(builder => builder.AddOtlpExporter((exporterOptions, readerOptions) =>
    {
        readerOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 10_000;
    }));

// Set via Options API using code:
appBuilder.Services.Configure<MetricReaderOptions>(o =>
{
    o.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 10_000;
});

// Set via Options API using configuration:
appBuilder.Services.Configure<MetricReaderOptions>(
    appBuilder.Configuration.GetSection("OpenTelemetry:Metrics"));

All signals

The following environment variables can be used to override the default values of the OtlpExporterOptions:

Environment variable	`OtlpExporterOptions` property
`OTEL_EXPORTER_OTLP_ENDPOINT`	`Endpoint`
`OTEL_EXPORTER_OTLP_HEADERS`	`Headers`
`OTEL_EXPORTER_OTLP_TIMEOUT`	`TimeoutMilliseconds`
`OTEL_EXPORTER_OTLP_PROTOCOL`	`Protocol` (`grpc` or `http/protobuf`)

Logs:

The following environment variables can be used to override the default values for the batch processor configured for logging:

Environment variable	`BatchExportLogRecordProcessorOptions` property
`OTEL_BLRP_SCHEDULE_DELAY`	`ScheduledDelayMilliseconds`
`OTEL_BLRP_EXPORT_TIMEOUT`	`ExporterTimeoutMilliseconds`
`OTEL_BLRP_MAX_QUEUE_SIZE`	`MaxQueueSize`
`OTEL_BLRP_MAX_EXPORT_BATCH_SIZE`	`MaxExportBatchSize`

The following environment variables can be used to override the default values of the OtlpExporterOptions used for logging when using the UseOtlpExporter extension:

Environment variable	`OtlpExporterOptions` property	UseOtlpExporter	AddOtlpExporter
`OTEL_EXPORTER_OTLP_LOGS_ENDPOINT`	`Endpoint`	Supported	Not supported
`OTEL_EXPORTER_OTLP_LOGS_HEADERS`	`Headers`	Supported	Not supported
`OTEL_EXPORTER_OTLP_LOGS_TIMEOUT`	`TimeoutMilliseconds`	Supported	Not supported
`OTEL_EXPORTER_OTLP_LOGS_PROTOCOL`	`Protocol` (`grpc` or `http/protobuf`)	Supported	Not supported

Metrics:

The following environment variables can be used to override the default value of the TemporalityPreference setting for the reader configured for metrics when using OTLP exporter:

Environment variable	`MetricReaderOptions` property
`OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE`	`TemporalityPreference`

The following environment variables can be used to override the default values of the periodic exporting metric reader configured for metrics:

Environment variable	`PeriodicExportingMetricReaderOptions` property
`OTEL_METRIC_EXPORT_INTERVAL`	`ExportIntervalMilliseconds`
`OTEL_METRIC_EXPORT_TIMEOUT`	`ExportTimeoutMilliseconds`

The following environment variables can be used to override the default values of the OtlpExporterOptions used for metrics when using the UseOtlpExporter extension:

Environment variable	`OtlpExporterOptions` property	UseOtlpExporter	AddOtlpExporter
`OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`	`Endpoint`	Supported	Not supported
`OTEL_EXPORTER_OTLP_METRICS_HEADERS`	`Headers`	Supported	Not supported
`OTEL_EXPORTER_OTLP_METRICS_TIMEOUT`	`TimeoutMilliseconds`	Supported	Not supported
`OTEL_EXPORTER_OTLP_METRICS_PROTOCOL`	`Protocol` (`grpc` or `http/protobuf`)	Supported	Not supported

Tracing:

The following environment variables can be used to override the default values for the batch processor configured for tracing:

Environment variable	`BatchExportActivityProcessorOptions` property
`OTEL_BSP_SCHEDULE_DELAY`	`ScheduledDelayMilliseconds`
`OTEL_BSP_EXPORT_TIMEOUT`	`ExporterTimeoutMilliseconds`
`OTEL_BSP_MAX_QUEUE_SIZE`	`MaxQueueSize`
`OTEL_BSP_MAX_EXPORT_BATCH_SIZE`	`MaxExportBatchSize`

The following environment variables can be used to override the default values of the OtlpExporterOptions used for tracing when using the UseOtlpExporter extension:

Environment variable	`OtlpExporterOptions` property	UseOtlpExporter	AddOtlpExporter
`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`	`Endpoint`	Supported	Not supported
`OTEL_EXPORTER_OTLP_TRACES_HEADERS`	`Headers`	Supported	Not supported
`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT`	`TimeoutMilliseconds`	Supported	Not supported
`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL`	`Protocol` (`grpc` or `http/protobuf`)	Supported	Not supported

services.AddOpenTelemetry()
    .WithTracing(builder => builder
        .AddOtlpExporter(o =>
        {
            o.Protocol = OtlpExportProtocol.HttpProtobuf;
            o.HttpClientFactory = () =>
            {
                HttpClient client = new HttpClient();
                client.DefaultRequestHeaders.Add("X-MyCustomHeader", "value");
                return client;
            };
        }));

services.AddHttpClient(
    "OtlpTraceExporter",
    configureClient: (client) =>
        client.DefaultRequestHeaders.Add("X-MyCustomHeader", "value"));

OpenTelemetry/OpenTelemetry.Exporter.OpenTelemetryProtocolv1.13.1

Get Started

Readme

OTLP Exporter for OpenTelemetry .NET

Prerequisite

Installation

Enable Log Exporter

Enable Metric Exporter

Enable Trace Exporter

Enable OTLP Exporter for all signals

Configuring signals when using UseOtlpExporter

Configuration

OtlpExporterOptions

LogRecordExportProcessorOptions

MetricReaderOptions

Environment Variables

Exporter configuration

Attribute limits

Configure HttpClient

Experimental features

Environment variables

Troubleshooting

References