Skip to content

Commit d0284cd

Browse files
authored
Merge pull request #284393 from AaronMaxwell/aaronmax-autoinstrumentation-update
Adding more explanation
2 parents 473f458 + d3176b5 commit d0284cd

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

articles/azure-monitor/app/codeless-overview.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,22 @@ title: Autoinstrumentation for Azure Monitor Application Insights
33
description: Overview of autoinstrumentation for Azure Monitor Application Insights codeless application performance management.
44
ms.topic: conceptual
55
ms.custom: devx-track-js
6-
ms.date: 12/15/2023
6+
ms.date: 08/12/2024
77
ms.reviewer: abinetabate
88
---
99

1010
# What is autoinstrumentation for Azure Monitor Application Insights?
1111

1212
Autoinstrumentation enables [Application Insights](app-insights-overview.md) to make [telemetry](data-model-complete.md) like metrics, requests, and dependencies available in your [Application Insights resource](create-workspace-resource.md). It provides easy access to experiences such as the [application dashboard](overview-dashboard.md) and [application map](app-map.md).
1313

14-
If your language and platform are supported, select the corresponding link in the [Supported environments, languages, and resource providers table](#supported-environments-languages-and-resource-providers) for more detailed information. In many cases, autoinstrumentation is enabled by default.
14+
The term "autoinstrumentation" is a portmanteau, a linguistic blend where parts of multiple words combine into a new word. "Autoinstrumentation" combines "auto" and "instrumentation." It sees widespread use in software observability and describes the process of adding instrumentation code to applications without manual coding by developers.
15+
16+
The autoinstrumentation process varies by language and platform, but often involves a toggle button in the Azure portal. The following example shows a toggle button for [Azure App Service](../../app-service/getting-started.md#getting-started-with-azure-app-service) autoinstrumentation.
17+
18+
:::image type="content"source="./media/azure-web-apps/enable.png" alt-text=" Screenshot that shows the Application Insights tab with Enable selected." lightbox="./media/azure-web-apps/enable.png":::
19+
20+
> [!TIP]
21+
> *We do not provide autoinstrumentation specifics for all languages and platforms in this article.* For detailed information, select the corresponding link in the [Supported environments, languages, and resource providers table](#supported-environments-languages-and-resource-providers). In many cases, autoinstrumentation is enabled by default.
1522
1623
## What are the autoinstrumentation advantages?
1724

@@ -28,7 +35,7 @@ The following table shows the current state of autoinstrumentation availability.
2835
Links are provided to more information for each supported scenario.
2936

3037
> [!NOTE]
31-
> If your hosting environment or resource provider is not listed in the following table, autoinstrumentation is not supported. You can manually instrument your code using Application Insights SDKs or Azure Monitor OpenTelemetry Distros. For more information, see [Data Collection Basics of Azure Monitor Application Insights](opentelemetry-overview.md).
38+
> If your hosting environment or resource provider is not listed in the following table, then autoinstrumentation is not supported. In this case, we recoomend manually instrumenting using the [Azure Monitor OpenTelemetry Distro](opentelemetry-enable.md). For more information, see [Data Collection Basics of Azure Monitor Application Insights](opentelemetry-overview.md).
3239
3340
|Environment/Resource provider | .NET Framework | .NET Core / .NET | Java | Node.js | Python |
3441
|-------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
@@ -52,18 +59,13 @@ Links are provided to more information for each supported scenario.
5259
> [!NOTE]
5360
> Autoinstrumentation was known as "codeless attach" before October 2021.
5461
55-
## JavaScript (Web) SDK Loader Script injection by configuration
56-
57-
When using supported Software Development Kits (SDKs), you can enable SDK injection in configuration to automatically inject JavaScript (Web) SDK Loader Script onto each page.
62+
## Frequently asked questions
5863

64+
#### Should the term "autoinstrumentation" be hyphenated?
5965

60-
| Language
61-
| :--- |
62-
| [ASP.NET Core](./asp-net-core.md?tabs=netcorenew%2Cnetcore6#enable-client-side-telemetry-for-web-applications) |
63-
| [Node.js](./nodejs.md#browser-sdk-loader) |
64-
| [Java](./java-standalone-config.md#browser-sdk-loader-preview) |
66+
We follow the [Microsoft Style Guide](/style-guide/punctuation/dashes-hyphens/hyphens#prefixes) for product documentation published to the [Microsoft Learn](/) platform.
6567

66-
For other methods to instrument your application with the Application Insights JavaScript SDK, see [Get started with the JavaScript SDK](./javascript-sdk.md).
68+
In general, we don’t include a hyphen after the "auto" prefix.
6769

6870
## Next steps
6971

articles/azure-monitor/app/javascript-sdk.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ We provide the [Debug plugin](https://github.com/microsoft/ApplicationInsights-J
3434
Follow the steps in this section to instrument your application with the Application Insights JavaScript SDK.
3535

3636
> [!TIP]
37-
> Good news! We're making it even easier to enable JavaScript. Check out where [JavaScript (Web) SDK Loader Script injection by configuration is available](./codeless-overview.md#javascript-web-sdk-loader-script-injection-by-configuration)!
37+
> Good news! We're making it even easier to enable JavaScript with JavaScript (Web) SDK Loader Script injection by configuration.
38+
>
39+
> - [ASP.NET Core](./asp-net-core.md?tabs=netcorenew%2Cnetcore6#enable-client-side-telemetry-for-web-applications)
40+
> - [Node.js](./nodejs.md#browser-sdk-loader)
41+
> - [Java](./java-standalone-config.md#browser-sdk-loader-preview)
3842
3943
### Add the JavaScript code
4044

0 commit comments

Comments
 (0)