Skip to content

Commit 9f2a67d

Browse files
author
Kai Nawroth
committed
Removing legacy option from docs
1 parent f31d906 commit 9f2a67d

File tree

5 files changed

+34
-123
lines changed

5 files changed

+34
-123
lines changed

articles/azure-monitor/app/asp-net-core.md

Lines changed: 12 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -166,19 +166,19 @@ If `IConfiguration` has loaded configuration from multiple providers, then `serv
166166

167167
Run your application and make requests to it. Telemetry should now flow to Application Insights. The Application Insights SDK automatically collects incoming web requests to your application, along with the following telemetry.
168168

169-
### Live Metrics
169+
### Live metrics
170170

171-
[Live Metrics](./live-stream.md) can be used to quickly verify if Application Insights monitoring is configured correctly. It might take a few minutes for telemetry to appear in the portal and analytics, but Live Metrics shows CPU usage of the running process in near real time. It can also show other telemetry like requests, dependencies, and traces.
171+
[Live metrics](./live-stream.md) can be used to quickly verify if Application Insights monitoring is configured correctly. It might take a few minutes for telemetry to appear in the portal and analytics, but live metrics shows CPU usage of the running process in near real time. It can also show other telemetry like requests, dependencies, and traces.
172172

173-
#### Enable Live Metrics by using code for any .NET application
173+
#### Enable live metrics by using code for any .NET application
174174

175175
> [!NOTE]
176-
> Live Metrics is enabled by default when you onboard it by using the recommended instructions for .NET applications.
176+
> Live metrics is enabled by default when you onboard it by using the recommended instructions for .NET applications.
177177

178-
To manually configure Live Metrics:
178+
To manually configure live metrics:
179179

180180
1. Install the NuGet package [Microsoft.ApplicationInsights.PerfCounterCollector](https://www.nuget.org/packages/Microsoft.ApplicationInsights.PerfCounterCollector).
181-
1. The following sample console app code shows setting up Live Metrics:
181+
1. The following sample console app code shows setting up live metrics:
182182

183183
```csharp
184184
using Microsoft.ApplicationInsights;
@@ -207,14 +207,14 @@ quickPulseModule.RegisterTelemetryProcessor(quickPulseProcessor);
207207

208208
// Create a TelemetryClient instance. It is important
209209
// to use the same TelemetryConfiguration here as the one
210-
// used to set up Live Metrics.
210+
// used to set up live metrics.
211211
TelemetryClient client = new TelemetryClient(config);
212212

213213
// This sample runs indefinitely. Replace with actual application logic.
214214
while (true)
215215
{
216216
// Send dependency and request telemetry.
217-
// These will be shown in Live Metrics.
217+
// These will be shown in live metrics.
218218
// CPU/Memory Performance counter is also shown
219219
// automatically without any additional steps.
220220
client.TrackDependency("My dependency", "target", "http://sample",
@@ -225,29 +225,7 @@ while (true)
225225
}
226226
```
227227

228-
The preceding sample is for a console app, but the same code can be used in any .NET applications. If any other telemetry modules are enabled to autocollect telemetry, it's important to ensure that the same configuration used for initializing those modules is used for the Live Metrics module.
229-
230-
#### Add an API key to configuration
231-
232-
If you [create a secret API key](./live-stream.md#legacy-option-create-an-api-key) to set up an authenticated channel, you can add it to configuration.
233-
234-
> [!NOTE]
235-
> Setting up an authenticated channel by configuring a secret API key is no longer recommended. Instead, we recommend securing the live metrics channel by using [Microsoft Entra authentication](./azure-ad-authentication.md#configure-and-enable-azure-ad-based-authentication).
236-
237-
In the *Program.cs* file, add the following namespace:
238-
239-
```csharp
240-
using Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse;
241-
```
242-
243-
Then add the following service registration:
244-
245-
```csharp
246-
// Existing code which includes services.AddApplicationInsightsTelemetry() to enable Application Insights.
247-
builder.Services.ConfigureTelemetryModule<QuickPulseTelemetryModule> ((module, o) => module.AuthenticationApiKey = "YOUR-API-KEY-HERE");
248-
```
249-
250-
For more information on how to configure ASP.NET Core applications, see [Configuring telemetry modules in ASP.NET Core](#configure-or-remove-default-telemetrymodules).
228+
The preceding sample is for a console app, but the same code can be used in any .NET applications. If any other telemetry modules are enabled to autocollect telemetry, it's important to ensure that the same configuration used for initializing those modules is used for the live metrics module.
251229

252230
### ILogger logs
253231

@@ -329,7 +307,7 @@ var aiOptions = new Microsoft.ApplicationInsights.AspNetCore.Extensions.Applicat
329307
// Disables adaptive sampling.
330308
aiOptions.EnableAdaptiveSampling = false;
331309

332-
// Disables QuickPulse (Live Metrics stream).
310+
// Disables live metrics (formerly QuickPulse).
333311
aiOptions.EnableQuickPulseMetricStream = false;
334312

335313
builder.Services.AddApplicationInsightsTelemetry(aiOptions);
@@ -346,7 +324,7 @@ public void ConfigureServices(IServiceCollection services)
346324
// Disables adaptive sampling.
347325
aiOptions.EnableAdaptiveSampling = false;
348326

349-
// Disables QuickPulse (Live Metrics stream).
327+
// Disables live metrics (formerly QuickPulse).
350328
aiOptions.EnableQuickPulseMetricStream = false;
351329
services.AddApplicationInsightsTelemetry(aiOptions);
352330
}
@@ -531,7 +509,7 @@ By default, the following automatic-collection modules are enabled. These module
531509
* `RequestTrackingTelemetryModule`: Collects RequestTelemetry from incoming web requests.
532510
* `DependencyTrackingTelemetryModule`: Collects [DependencyTelemetry](./asp-net-dependencies.md) from outgoing HTTP calls and SQL calls.
533511
* `PerformanceCollectorModule`: Collects Windows PerformanceCounters.
534-
* `QuickPulseTelemetryModule`: Collects telemetry to show in the Live Metrics portal.
512+
* `QuickPulseTelemetryModule`: Collects telemetry to show in the live metrics portal.
535513
* `AppServicesHeartbeatTelemetryModule`: Collects heartbeats (which are sent as custom metrics), about the App Service environment where the application is hosted.
536514
* `AzureInstanceMetadataTelemetryModule`: Collects heartbeats (which are sent as custom metrics), about the Azure VM environment where the application is hosted.
537515
* `EventCounterCollectionModule`: Collects [EventCounters](eventcounters.md). This module is a new feature and is available in SDK version 2.8.0 and later.

articles/azure-monitor/app/asp-net.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -361,19 +361,19 @@ Although it's possible to manually add the JavaScript (Web) SDK Loader Script to
361361

362362
For the template-based ASP.NET MVC app from this article, the file that you need to edit is *_Layout.cshtml*. You can find it under **Views** > **Shared**. To add client-side monitoring, open *_Layout.cshtml* and follow the [JavaScript (Web) SDK Loader Script-based setup instructions](./javascript-sdk.md?tabs=javascriptwebsdkloaderscript#get-started) from the article about client-side JavaScript SDK configuration.
363363

364-
## Live Metrics
364+
## Live metrics
365365

366-
[Live Metrics](./live-stream.md) can be used to quickly verify if Application Insights monitoring is configured correctly. It might take a few minutes for telemetry to appear in the portal and analytics, but Live Metrics shows CPU usage of the running process in near real time. It can also show other telemetry like requests, dependencies, and traces.
366+
[Live metrics](./live-stream.md) can be used to quickly verify if Application Insights monitoring is configured correctly. It might take a few minutes for telemetry to appear in the portal and analytics, but live metrics shows CPU usage of the running process in near real time. It can also show other telemetry like requests, dependencies, and traces.
367367

368-
### Enable Live Metrics by using code for any .NET application
368+
### Enable live metrics by using code for any .NET application
369369

370370
> [!NOTE]
371-
> Live Metrics is enabled by default when you onboard it by using the recommended instructions for .NET applications.
371+
> Live metrics is enabled by default when you onboard it by using the recommended instructions for .NET applications.
372372

373-
To manually configure Live Metrics:
373+
To manually configure live metrics:
374374

375375
1. Install the NuGet package [Microsoft.ApplicationInsights.PerfCounterCollector](https://www.nuget.org/packages/Microsoft.ApplicationInsights.PerfCounterCollector).
376-
1. The following sample console app code shows setting up Live Metrics:
376+
1. The following sample console app code shows setting up live metrics:
377377

378378
```csharp
379379
using Microsoft.ApplicationInsights;
@@ -410,14 +410,14 @@ namespace LiveMetricsDemo
410410

411411
// Create a TelemetryClient instance. It is important
412412
// to use the same TelemetryConfiguration here as the one
413-
// used to set up Live Metrics.
413+
// used to set up live metrics.
414414
TelemetryClient client = new TelemetryClient(config);
415415

416416
// This sample runs indefinitely. Replace with actual application logic.
417417
while (true)
418418
{
419419
// Send dependency and request telemetry.
420-
// These will be shown in Live Metrics.
420+
// These will be shown in live metrics.
421421
// CPU/Memory Performance counter is also shown
422422
// automatically without any additional steps.
423423
client.TrackDependency("My dependency", "target", "http://sample",
@@ -431,22 +431,7 @@ namespace LiveMetricsDemo
431431
}
432432
```
433433

434-
The preceding sample is for a console app, but the same code can be used in any .NET applications. If any other telemetry modules are enabled to autocollect telemetry, it's important to ensure that the same configuration used for initializing those modules is used for the Live Metrics module.
435-
436-
### Add an API key to configuration
437-
438-
If you [create a secret API key](./live-stream.md#legacy-option-create-an-api-key) to set up an authenticated channel, you can add it to configuration.
439-
440-
> [!NOTE]
441-
> Setting up an authenticated channel by configuring a secret API key is no longer recommended. Instead, we recommend securing the live metrics channel by using [Microsoft Entra authentication](./azure-ad-authentication.md#configure-and-enable-azure-ad-based-authentication).
442-
443-
In the *applicationinsights.config* file, add `AuthenticationApiKey` to `QuickPulseTelemetryModule`:
444-
445-
```xml
446-
<Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse.QuickPulseTelemetryModule, Microsoft.AI.PerfCounterCollector">
447-
<AuthenticationApiKey>YOUR-API-KEY-HERE</AuthenticationApiKey>
448-
</Add>
449-
```
434+
The preceding sample is for a console app, but the same code can be used in any .NET applications. If any other telemetry modules are enabled to autocollect telemetry, it's important to ensure that the same configuration used for initializing those modules is used for the live metrics module.
450435

451436
## Frequently asked questions
452437

articles/azure-monitor/app/live-stream.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,24 @@ Live metrics is currently supported for ASP.NET, ASP.NET Core, Azure Functions,
3838
3939
1. Follow language-specific guidelines to enable live metrics:
4040

41-
Using OpenTelemetry (Recommended):
41+
# [OpenTelemetry (Recommended)](#tab/otel)
4242

4343
* [ASP.NET](opentelemetry-enable.md?tabs=net): Live metrics is not supported.
4444
* [ASP.NET Core](opentelemetry-enable.md?tabs=aspnetcore): Live metrics is enabled by default.
4545
* [Java](./opentelemetry-enable.md?tabs=java): Live metrics is enabled by default.
4646
* [Node.js](opentelemetry-enable.md?tabs=nodejs): Live metrics is enabled by default.
4747
* [Python](opentelemetry-enable.md?tabs=python): Live metrics is enabled by default.
4848

49-
Using Classic API:
49+
# [Classic API](#tab/classic)
5050

51-
* [ASP.NET](./asp-net.md): Live metrics is enabled by default but can also be enabled manually using code, see [Configure monitoring for ASP.NET with Azure Application Insights](./asp-net.md#enable-live-metrics-by-using-code-for-any-.net-application).
52-
* [ASP.NET Core](./asp-net-core.md): Live metrics is enabled by default but can also be enabled manually using code, see [Application Insights for ASP.NET Core applications](./asp-net-core.md#enable-live-metrics-by-using-code-for-any-.net-application).
51+
* [ASP.NET](./asp-net.md): Live metrics is enabled by default but can also be [enabled manually using code](./asp-net.md#enable-live-metrics-by-using-code-for-any-.net-application).
52+
* [ASP.NET Core](./asp-net-core.md): Live metrics is enabled by default but can also be [enabled manually using code](./asp-net-core.md#enable-live-metrics-by-using-code-for-any-.net-application).
5353
* [.NET/.NET Core Console/Worker](./worker-service.md): Live metrics is enabled by default.
5454
* [.NET Applications: Enable using code](#enable-live-metrics-by-using-code-for-any-net-application).
5555
* [Node.js](./nodejs.md#live-metrics)
5656

57+
---
58+
5759
2. In the [Azure portal](https://portal.azure.com), open the Application Insights resource for your application. Under **Investigate**, open **Live metrics**.
5860

5961
3. [Secure the control channel](#secure-the-control-channel) if you might use sensitive data like customer names in your filters.
@@ -111,10 +113,7 @@ If you want to monitor a particular server role instance, you can filter by serv
111113

112114
## Secure the control channel
113115

114-
Live metrics custom filters allow you to control which of your application's telemetry is streamed to the live metrics view in the Azure portal. The filters criteria are sent to the apps that are instrumented with the Application Insights SDK. The filter value could potentially contain sensitive information, such as the customer ID. To keep this value secured and prevent potential disclosure to unauthorized applications, you have two options:
115-
116-
- **Recommended:** Secure the live metrics channel by using [Microsoft Entra authentication](./azure-ad-authentication.md#configure-and-enable-azure-ad-based-authentication).
117-
- **Legacy (no longer recommended):** Set up an authenticated channel by configuring a secret API key as explained in the [Legacy option section](#legacy-option-create-an-api-key) below.
116+
Live metrics custom filters allow you to control which of your application's telemetry is streamed to the live metrics view in the Azure portal. The filters criteria are sent to the apps that are instrumented with the Application Insights SDK. The filter value could potentially contain sensitive information, such as the customer ID. To keep this value secured and prevent potential disclosure to unauthorized applications, secure the live metrics channel by using [Microsoft Entra authentication](./azure-ad-authentication.md#configure-and-enable-azure-ad-based-authentication).
118117

119118
> [!NOTE]
120119
> On September 30, 2025, API keys used to stream live metrics telemetry into Application Insights will be retired. After that date, applications that use API keys won't be able to send live metrics data to your Application Insights resource. Authenticated telemetry ingestion for live metrics streaming to Application Insights will need to be done with [Microsoft Entra authentication for Application Insights](./azure-ad-authentication.md).
@@ -126,25 +125,6 @@ It's possible to try custom filters without having to set up an authenticated ch
126125
127126
:::image type="content" source="media/live-stream/live-stream-auth.png" alt-text="Screenshot that shows the Authorize connected servers dialog." lightbox="media/live-stream/live-stream-auth.png":::
128127

129-
### Legacy option: Create an API key
130-
131-
1. Select the **API Access** tab and then select **Create API key**.
132-
133-
:::image type="content" source="./media/live-stream/api-key.png" lightbox="./media/live-stream/api-key.png" alt-text="Screenshot that shows selecting the API Access tab and the Create API key button.":::
134-
135-
1. Select the **Authenticate SDK control channel** checkbox and then select **Generate key**.
136-
137-
:::image type="content" source="./media/live-stream/create-api-key.png" lightbox="./media/live-stream/create-api-key.png" alt-text="Screenshot that shows the Create API key pane. Select Authenticate SDK control channel checkbox and then select Generate key.":::
138-
139-
### Add an API key to configuration
140-
141-
For ASP.NET, ASP.NET Core, WorkerService, and Azure Functions apps, you can add an API key to configuration:
142-
143-
- [.NET Core](./asp-net-core.md#add-an-api-key-to-configuration)
144-
- [.NET Framework](./asp-net.md#add-an-api-key-to-configuration)
145-
- [WorkerService](./worker-service.md#add-an-api-key-to-configuration)
146-
- [Azure Functions apps](./monitor-functions.md#add-an-api-key-to-configuration)
147-
148128
## Supported features table
149129

150130
| Language | Basic metrics | Performance metrics | Custom filtering | Sample telemetry | CPU split by process |

articles/azure-monitor/app/monitor-functions.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -176,17 +176,6 @@ def main(req: func.HttpRequest, context) -> func.HttpResponse:
176176
...
177177
```
178178

179-
## Live Metrics
180-
181-
### Add an API key to configuration
182-
183-
For Azure Functions apps (v2), you can secure the channel with an API key by using an environment variable.
184-
185-
> [!NOTE]
186-
> Setting up an authenticated channel by configuring a secret API key is no longer recommended. Instead, we recommend securing the live metrics channel by using [Microsoft Entra authentication](./azure-ad-authentication.md#configure-and-enable-azure-ad-based-authentication).
187-
188-
Create an API key from within your Application Insights resource and go to **Settings** > **Configuration** for your Azure Functions app. Select **New application setting**, enter a name of `APPINSIGHTS_QUICKPULSEAUTHAPIKEY`, and enter a value that corresponds to your API key.
189-
190179
## Next steps
191180

192181
* Read more instructions and information about [monitoring Azure Functions](../../azure-functions/functions-monitoring.md).

0 commit comments

Comments
 (0)