Skip to content

Upgrading Microsoft.ApplicationInsights 1 to 2

Breaking1.2.3 → 2.23.0Breaking32Security3Platform1Deprecated8New71Changed101Fixed90Other8

Full comparisonBack to Microsoft.ApplicationInsights
BreakingUpgrade verdict

32 breaking changes and a platform requirement change and 3 security fixes.

In plain terms
  • ASP.NET Core apps can no longer use the old global TelemetryConfiguration.Active; configuration must be passed explicitly.
  • The setting to turn off W3C correlation was removed. To turn it off, change the Activity ID format settings instead.
  • If you relied on the processors and channel that were added to the config for you, they now live in a different section of the config file, so you may need to move your customizations there.
  • A metrics method has a new name, so code that calls the old name will no longer compile.
Must act Top 5 of 44 that need code or config changes

Target frameworks requirement changed in 2.15.0-beta3: .NETFramework4.0, .NETFramework4.5, WindowsPhone8.0 → .NETFramework4.5.2, .NETFramework4.6, .NETStandard2.0.

Adds system.diagnostics.diagnosticsource 5.0.0.

Drops microsoft.bcl.async, microsoft.diagnostics.tracing.eventsource.redist.

What you must change

Breaking32
Removes legacy TelemetryConfiguration.Active from the ASP.NET Core SDK.
TelemetryConfiguration.Active
2.15.0-beta3GitHub ReleaseSummarizedView source
Removes TelemetryConfiguration.EnableW3CCorrelation; disable W3C format via Activity.DefaultIdFormat and Activity.ForceDefaultIdFormat instead.
TelemetryConfiguration.EnableW3CCorrelationActivity.DefaultIdFormatActivityIdFormat.HierarchicalActivity.ForceDefaultIdFormat
2.11.0-beta2GitHub ReleaseSummarizedView source
TelemetryProcessors and ServerTelemetryChannel added automatically to the default ApplicationInsights.config are moved under the default telemetry sink.
TelemetryProcessorsTelemetryChannelServerTelemetryChannelApplicationInsights.config
2.8.0-beta2GitHub ReleaseSummarizedView source
Renames Metrics TryTrackValue(..) to TrackValue(..).
TryTrackValueTrackValue
2.7.2CHANGELOG.mdSummarizedView source
Removes some superfluous public constants from Metrics.
2.7.2CHANGELOG.mdSummarizedView source
Sanitize on ITelemetry implementations no longer modifies TelemetryContext fields, though serialized JSON and ETW events still have context tags sanitized.
SanitizeITelemetryTelemetryContext
2.5.0-beta1GitHub ReleaseSummarizedView source
Removes metric aggregation functionality because there is not enough feedback on the API surface yet.
2.4.0-beta2GitHub ReleaseSummarizedView source
Request.Success is no longer populated from ResponseCode and must be set explicitly.
Request.SuccessResponseCode
2.4.0-beta1GitHub ReleaseSummarizedView source
Removes the metric aggregation functionality that was added in the 2.3.0-beta1 release.
2.3.0GitHub ReleaseSummarizedView source
TelemetryConfiguration no longer disposes user provided ITelemetryChannel instances; users must dispose channels they create.
TelemetryConfigurationITelemetryChannel
2.3.0-beta2GitHub ReleaseSummarizedView source
Removes the DependencyTelemetry.Async property.
DependencyTelemetry.Async
2.0.0-rc1GitHub ReleaseSummarizedView source
Removes the DependencyTelemetry.Count property.
DependencyTelemetry.Count
2.0.0-rc1GitHub ReleaseSummarizedView source
Removes the UserContext.AcquisitionDate property.
UserContext.AcquisitionDate
2.0.0-rc1GitHub ReleaseSummarizedView source
Removes the UserContext.StoreRegion property.
UserContext.StoreRegion
2.0.0-rc1GitHub ReleaseSummarizedView source
Removes InMemoryChannel.DataUploadIntervalInSeconds; use SendingInterval instead.
InMemoryChannel.DataUploadIntervalInSecondsSendingInterval
2.0.0-rc1GitHub ReleaseSummarizedView source
Removes DeviceContext.RoleName; use DeviceContext.Cloud.RoleName instead.
DeviceContext.RoleNameDeviceContext.Cloud.RoleName
2.0.0-rc1GitHub ReleaseSummarizedView source
Removes DeviceContext.RoleInstance; use DeviceContext.Cloud.RoleInstance instead.
DeviceContext.RoleInstanceDeviceContext.Cloud.RoleInstance
2.0.0-rc1GitHub ReleaseSummarizedView source
Removes the TelemetryConfiguration.GetTelemetryProcessorChainBuilder extension method in favor of the TelemetryProcessorChainBuilder instance method.
TelemetryConfiguration.GetTelemetryProcessorChainBuilderTelemetryConfiguration.TelemetryProcessorChainBuilder
2.0.0-beta4GitHub ReleaseSummarizedView source
Removes TimestampTelemetryInitializer; Timestamp is now added automatically by TelemetryClient.
TimestampTelemetryInitializerTelemetryClient
2.0.0-beta3GitHub ReleaseSummarizedView source
Stops collecting User Agent by default by removing the User Agent telemetry initializer.
2.0.0-beta3GitHub ReleaseSummarizedView source
Removes support for the IContextInitializer interface and the ContextInitializers collection from TelemetryConfiguration.
IContextInitializerTelemetryConfiguration.ContextInitializers
2.0.0-beta2CHANGELOG.mdSummarizedView source
Renames the Name property of OperationContext to RootName.
OperationContext.NameOperationContext.RootName
2.0.0-beta2CHANGELOG.mdSummarizedView source
Removes the Id property of RequestTelemetry.
RequestTelemetry.Id
2.0.0-beta2CHANGELOG.mdSummarizedView source
RequestTelemetry Id and Context.Operation.Id are no longer initialized when creating a new RequestTelemetry.
RequestTelemetry.IdOperationContext.Id
2.0.0-beta2CHANGELOG.mdSummarizedView source
CredentialEnvelope.GetToken() now returns AuthToken instead of string, exposing the token's Expiration value.
CredentialEnvelope.GetToken()AuthToken
2.18.0-beta3GitHub ReleaseSummarizedView source
Reverts the namespace change for SamplingPercentageEstimatorSettings and AdaptiveSamplingPercentageEvaluatedCallback.
SamplingPercentageEstimatorSettingsAdaptiveSamplingPercentageEvaluatedCallback
2.6.4GitHub ReleaseSummarizedView source
Changes the signature of TelemetryClient.TrackDependency.
TelemetryClient.TrackDependency
2.6.0-beta2GitHub ReleaseSummarizedView source
Makes the Metric class private and fixes various metrics related issues.
Metric
2.4.0-beta4GitHub ReleaseSummarizedView source
StartOperation now starts a new System.Diagnostics.Activity and overwrites OperationTelemetry.Id set before or during initialization.
StartOperationSystem.Diagnostics.ActivityOperationTelemetry.Id
2.4.0-beta1GitHub ReleaseSummarizedView source
Local storage folder name changed, so telemetry saved by the old SDK is not sent after upgrading.
2.2.0-beta2GitHub ReleaseSummarizedView source
Requires calling ServerTelemetryChannel.Initialize() when the channel is created programmatically, or persistent storage is not initialized.
ServerTelemetryChannel.Initialize()
2.0.0-beta4GitHub ReleaseSummarizedView source
Moves internal types from the Shared namespace to the Microsoft namespace.
SharedMicrosoft
2.21.0-beta2GitHub ReleaseSummarizedView source
Security3
Upgrades System.Diagnostics.PerformanceCounter to version 6.0.0 to address CVE-2021-24112.
System.Diagnostics.PerformanceCounter
2.22.0-beta2GitHub ReleaseSummarizedView source
Addresses a vulnerability in Newtonsoft.Json (GHSA-5crp-9r3c-p9vr) by upgrading dependencies in Microsoft.ApplicationInsights.AspNetCore.
Newtonsoft.JsonMicrosoft.ApplicationInsights.AspNetCore
2.21.0-beta3GitHub ReleaseSummarizedView source
Adds payload sanitization for RichPayloadEventSource.
RichPayloadEventSource
2.2.0-beta4GitHub ReleaseSummarizedView source
Platform1
Ends support for .NET Framework 4.5 and 4.5.1 and adds support for .NET Framework 4.5.2.
2.15.0-beta3GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated8
Marks Instrumentation Key based APIs as Obsolete.
2.21.0-beta2GitHub ReleaseSummarizedView source
Deprecates TelemetryConfiguration.Active on .NET Core in favor of the dependency injection pattern.
TelemetryConfiguration.Active
2.11.0-beta1GitHub ReleaseSummarizedView source
Adds a distinct GlobalProperties collection on TelemetryContext and obsoletes the Properties collection on TelemetryContext.
TelemetryContext.GlobalPropertiesTelemetryContext.Properties
2.8.0-beta1GitHub ReleaseSummarizedView source
Marks context properties NetworkType, ScreenResolution and Language as obsolete in favor of custom properties.
NetworkTypeScreenResolutionLanguage
2.2.0-beta4GitHub ReleaseSummarizedView source
Marks SessionStateTelemetry as obsolete; use the IsFirst flag in SessionContext instead.
SessionStateTelemetryIsFirstSessionContext
2.2.0-beta4GitHub ReleaseSummarizedView source
Marks PerformanceCounterTelemetry as obsolete; use MetricTelemetry instead.
PerformanceCounterTelemetryMetricTelemetry
2.2.0-beta4GitHub ReleaseSummarizedView source
Marks RequestTelemetry.HttpMethod as obsolete; put the HTTP verb in the name and use custom properties for the dimension.
RequestTelemetry.HttpMethod
2.2.0-beta4GitHub ReleaseSummarizedView source
Marks RequestTelemetry.StartTime as obsolete; use TimeStamp instead.
RequestTelemetry.StartTimeTimeStamp
2.2.0-beta4GitHub ReleaseSummarizedView source