mark Instrumentation Key APIs Obsolete #2592
Conversation
TimothyMothra
changed the title
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the TelemetryConfiguration class. | ||
| /// </summary> | ||
| /// <param name="instrumentationKey">The instrumentation key this configuration instance will provide.</param> | ||
| [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")] |
There was a problem hiding this comment.
@cartersocha, need to review the messaging here
| @@ -44,6 +44,7 @@ public static IApplicationBuilder UseApplicationInsightsExceptionTelemetry(this | |||
| /// <param name="services">The <see cref="IServiceCollection"/> instance.</param> | |||
| /// <param name="instrumentationKey">Instrumentation key to use for telemetry.</param> | |||
| /// <returns>The <see cref="IServiceCollection"/>.</returns> | |||
| [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")] | |||
There was a problem hiding this comment.
for an user of this API, this message is not telling how to migrate. The link is for an overall migration approach.
|
@TimothyMothra I think we should offer specific alternate for each method we are Obsoleting. |
|
@cijothomas I did both. |
| @@ -21,6 +21,7 @@ public static partial class ApplicationInsightsExtensions | |||
| /// <param name="services">The <see cref="IServiceCollection"/> instance.</param> | |||
| /// <param name="instrumentationKey">Instrumentation key to use for telemetry.</param> | |||
| /// <returns>The <see cref="IServiceCollection"/>.</returns> | |||
| [Obsolete("InstrumentationKey based global ingestion is being deprecated. Use an AddApplicationInsightsTelemetryWorkerService() overload to set ApplicationInsightsServiceOptions.ConnectionString. See https://github.com/microsoft/ApplicationInsights-dotnet/issues/2560 for more details.")] | |||
There was a problem hiding this comment.
the message is not very clear to me.
There is simply no other overload which takes ConnectionString. So suggesting to use an overload without being very clear which overload we are talking about can be confusing.
There was a problem hiding this comment.
I reviewed all the messages and added additional details.
I reworded this specific message to say Use the AddApplicationInsightsTelemetryWorkerService() overload which accepts Action<ApplicationInsightsServiceOptions> and set ApplicationInsightsServiceOptions.ConnectionString.
#2560
Changes