ApplicationInsightsServiceOptions.cs

#if AI_ASPNETCORE_WEB
namespaceMicrosoft.ApplicationInsights.AspNetCore.Extensions
#else
namespaceMicrosoft.ApplicationInsights.WorkerService
#endif
{
usingSystem.Reflection;
usingMicrosoft.ApplicationInsights.DependencyCollector;

/// <summary>
/// Application Insights service options defines the custom behavior of the features to add, as opposed to the default selection of features obtained from Application Insights.
/// </summary>
publicclassApplicationInsightsServiceOptions
{
/// <summary>
/// Gets or sets a value indicating whether QuickPulseTelemetryModule and QuickPulseTelemetryProcessor are registered with the configuration.
/// Setting EnableQuickPulseMetricStream to <value>false</value>, will disable the default quick pulse metric stream. Defaults to <value>true</value>.
/// </summary>
publicboolEnableQuickPulseMetricStream{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether PerformanceCollectorModule should be enabled.
/// Defaults to <value>true</value>.
/// </summary>
publicboolEnablePerformanceCounterCollectionModule{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether AppServicesHeartbeatTelemetryModule should be enabled.
/// Defaults to <value>true</value>.
/// IMPORTANT: This setting will be ignored if either <see cref="EnableDiagnosticsTelemetryModule"/> or <see cref="EnableHeartbeat"/> are set to false.
/// </summary>
publicboolEnableAppServicesHeartbeatTelemetryModule{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether AzureInstanceMetadataTelemetryModule should be enabled.
/// Defaults to <value>true</value>.
/// IMPORTANT: This setting will be ignored if either <see cref="EnableDiagnosticsTelemetryModule"/> or <see cref="EnableHeartbeat"/> are set to false.
/// </summary>
publicboolEnableAzureInstanceMetadataTelemetryModule{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether DependencyTrackingTelemetryModule should be enabled.
/// Defaults to <value>true</value>.
/// </summary>
publicboolEnableDependencyTrackingTelemetryModule{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether EventCounterCollectionModule should be enabled.
/// Defaults to <value>true</value>.
/// </summary>
publicboolEnableEventCounterCollectionModule{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether telemetry processor that controls sampling is added to the service.
/// Setting EnableAdaptiveSampling to <value>false</value>, will disable the default adaptive sampling feature. Defaults to <value>true</value>.
/// </summary>
publicboolEnableAdaptiveSampling{get;set;}=true;

/// <summary>
/// Gets or sets the default instrumentation key for the application.
/// </summary>
publicstringInstrumentationKey{get;set;}

/// <summary>
/// Gets or sets the connection string for the application.
/// </summary>
publicstringConnectionString{get;set;}

/// <summary>
/// Gets or sets the application version reported with telemetries.
/// </summary>
publicstringApplicationVersion{get;set;}=Assembly.GetEntryAssembly()?.GetName().Version.ToString();

/// <summary>
/// Gets or sets a value indicating whether telemetry channel should be set to developer mode.
/// </summary>
publicbool?DeveloperMode{get;set;}

/// <summary>
/// Gets or sets the endpoint address of the channel.
/// </summary>
publicstringEndpointAddress{get;set;}

/// <summary>
/// Gets or sets a value indicating whether a logger would be registered automatically in debug mode.
/// </summary>
publicboolEnableDebugLogger{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether heartbeats are enabled.
/// IMPORTANT: This setting will be ignored if <see cref="EnableDiagnosticsTelemetryModule"/> is set to false.
/// IMPORTANT: Disabling this will cause the following settings to be ignored:
/// <see cref="EnableAzureInstanceMetadataTelemetryModule"/>.
/// <see cref="EnableAppServicesHeartbeatTelemetryModule"/>.
/// </summary>
publicboolEnableHeartbeat{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether AutoCollectedMetricExtractors are added or not.
/// Defaults to <value>true</value>.
/// </summary>
publicboolAddAutoCollectedMetricExtractor{get;set;}=true;

#if AI_ASPNETCORE_WEB
/// <summary>
/// Gets <see cref="RequestCollectionOptions"/> that allow to manage <see cref="RequestTrackingTelemetryModule"/>.
/// </summary>
publicRequestCollectionOptionsRequestCollectionOptions{get;}=newRequestCollectionOptions();

/// <summary>
/// Gets or sets a value indicating whether RequestTrackingTelemetryModule should be enabled.
/// Defaults to <value>true</value>.
/// </summary>
publicboolEnableRequestTrackingTelemetryModule{get;set;}=true;

/// <summary>
/// Gets or sets a value indicating whether a JavaScript snippet to track the current authenticated user should
/// be printed along with the main ApplicationInsights tracking script.
/// </summary>
publicboolEnableAuthenticationTrackingJavaScript{get;set;}=false;
#endif

/// <summary>
/// Gets or sets a value indicating whether the <see cref="Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing.DiagnosticsTelemetryModule"/> should be enabled.
/// IMPORTANT: Disabling this will cause the following settings to be ignored:
/// <see cref="EnableHeartbeat"/>.
/// <see cref="EnableAzureInstanceMetadataTelemetryModule"/>.
/// <see cref="EnableAppServicesHeartbeatTelemetryModule"/>.
/// </summary>
publicboolEnableDiagnosticsTelemetryModule{get;set;}=true;

/// <summary>
/// Gets <see cref="DependencyCollectionOptions"/> that allow to manage <see cref="DependencyTrackingTelemetryModule"/>.
/// </summary>
publicDependencyCollectionOptionsDependencyCollectionOptions{get;}=newDependencyCollectionOptions();

#if AI_ASPNETCORE_WEB
/// <summary>
/// Gets or sets a value indicating whether TelemetryConfiguration.Active should be initialized.
/// Former versions of this library had a dependency on this static instance. 
/// This dependency has been removed and we no longer initialize this by default.
/// If users depended on this behavior you should enable this.
/// However, we recommend migrating away from using TelemetryConfiguration.Active in your projects.
/// </summary>
publicboolEnableActiveTelemetryConfigurationSetup{get;set;}=false;
#endif

/// <summary>
/// Copy the properties from this <see cref="ApplicationInsightsServiceOptions"/> to a target instance.
/// </summary>
/// <param name="target">Target instance to copy properties to.</param>
internalvoidCopyPropertiesTo(ApplicationInsightsServiceOptionstarget)
{
if(this.DeveloperMode!=null)
{
target.DeveloperMode=this.DeveloperMode;
}

if(!string.IsNullOrEmpty(this.EndpointAddress))
{
target.EndpointAddress=this.EndpointAddress;
}

if(!string.IsNullOrEmpty(this.InstrumentationKey))
{
target.InstrumentationKey=this.InstrumentationKey;
}

if(!string.IsNullOrEmpty(this.ConnectionString))
{
target.ConnectionString=this.ConnectionString;
}

target.ApplicationVersion=this.ApplicationVersion;
target.EnableAdaptiveSampling=this.EnableAdaptiveSampling;
target.EnableDebugLogger=this.EnableDebugLogger;
target.EnableQuickPulseMetricStream=this.EnableQuickPulseMetricStream;
target.EnableHeartbeat=this.EnableHeartbeat;
target.AddAutoCollectedMetricExtractor=this.AddAutoCollectedMetricExtractor;
target.EnablePerformanceCounterCollectionModule=this.EnablePerformanceCounterCollectionModule;
target.EnableDependencyTrackingTelemetryModule=this.EnableDependencyTrackingTelemetryModule;
target.EnableAppServicesHeartbeatTelemetryModule=this.EnableAppServicesHeartbeatTelemetryModule;
target.EnableAzureInstanceMetadataTelemetryModule=this.EnableAzureInstanceMetadataTelemetryModule;
target.EnableDiagnosticsTelemetryModule=this.EnableDiagnosticsTelemetryModule;
target.EnableEventCounterCollectionModule=this.EnableEventCounterCollectionModule;

#if AI_ASPNETCORE_WEB
target.EnableAuthenticationTrackingJavaScript=this.EnableAuthenticationTrackingJavaScript;
target.EnableRequestTrackingTelemetryModule=this.EnableRequestTrackingTelemetryModule;
target.EnableActiveTelemetryConfigurationSetup=this.EnableActiveTelemetryConfigurationSetup;
#endif
}
}
}