TracingBuilderConfigurationExtensions.AddConfiguration Method

Definition

Namespace:

Microsoft.Extensions.Diagnostics.Tracing

Assembly:

Microsoft.Extensions.Diagnostics.dll

Package:

Microsoft.Extensions.Diagnostics v11.0.0-preview.7.26381.103

Source:

TracingBuilderConfigurationExtensions.cs

Reads tracing configuration from the provided IConfiguration section and configures which ActivitySource and Activity instances are enabled.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Diagnostics::Tracing::ITracingBuilder ^ AddConfiguration(Microsoft::Extensions::Diagnostics::Tracing::ITracingBuilder ^ builder, Microsoft::Extensions::Configuration::IConfiguration ^ configuration);

public static Microsoft.Extensions.Diagnostics.Tracing.ITracingBuilder AddConfiguration(this Microsoft.Extensions.Diagnostics.Tracing.ITracingBuilder builder, Microsoft.Extensions.Configuration.IConfiguration configuration);

static member AddConfiguration : Microsoft.Extensions.Diagnostics.Tracing.ITracingBuilder * Microsoft.Extensions.Configuration.IConfiguration -> Microsoft.Extensions.Diagnostics.Tracing.ITracingBuilder

<Extension()>
Public Function AddConfiguration (builder As ITracingBuilder, configuration As IConfiguration) As ITracingBuilder

Parameters

builder

ITracingBuilder

The ITracingBuilder.

configuration

IConfiguration

The IConfiguration section to load.

Returns

ITracingBuilder

The original ITracingBuilder for chaining.

Remarks

Tracing has two key levels: Name and OperationName.

• Section names: EnabledTracing (both global and local), EnabledGlobalTracing, and EnabledLocalTracing, plus the listener-specific forms {ListenerName}:....
• Within each section, supported entries are Default, {SourceName}, {SourceName}:Default, and {SourceName}:{OperationName}. Default at either level is a synonym for the level above (a source-level rule when nested under a source, a global rule at the top).
• Listener-specific rules are evaluated together with root-level rules. When both match, the most specific rule is chosen; listener-specific rules are more specific than root-level defaults.
• Values are Boolean only: true enables and false disables.

Example keys: EnabledTracing:Default=true, EnabledGlobalTracing:MyCompany.Service=false, EnabledTracing:MyCompany.Service:Checkout=true, and MyListener:EnabledLocalTracing:MyCompany.Service=true.