Skip to content

Commit 0726a74

Browse files
authored
Merge pull request #187112 from trask/sync-java-and-nodejs
Sync App Services Java and Node.js
2 parents 5853f78 + 80fba57 commit 0726a74

File tree

2 files changed

+41
-35
lines changed

2 files changed

+41
-35
lines changed

articles/azure-monitor/app/azure-web-apps-java.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ ms.custom: "devx-track-java"
99

1010
# Application Monitoring for Azure App Service and Java
1111

12-
Monitoring of your Java-based web applications running on [Azure App Services](../../app-service/index.yml) does not require any modifications to the code. This article will walk you through enabling Azure Monitor application insights monitoring as well as provide preliminary guidance for automating the process for large-scale deployments.
12+
Monitoring of your Java web applications running on [Azure App Services](../../app-service/index.yml) does not require any modifications to the code. This article will walk you through enabling Azure Monitor Application Insights monitoring as well as provide preliminary guidance for automating the process for large-scale deployments.
1313

1414
## Enable Application Insights
1515

16-
The recommended way to enable application monitoring for Java application running on Azure App Services is through Azure portal. Turning on application monitoring in Azure portal will automatically instrument your application with application insights.
16+
The recommended way to enable application monitoring for Java applications running on Azure App Services is through Azure portal.
17+
Turning on application monitoring in Azure portal will automatically instrument your application with Application Insights, and doesn't require any code changes.
18+
You can apply additional configurations, and then based on your specific scenario you [add your own custom telemetry](./java-in-process-agent.md#modify-telemetry) if needed.
1719

1820
### Auto-instrumentation through Azure portal
1921

20-
This method requires no code change or advanced configurations, making it the easiest way to get started with monitoring for Azure App Services. You can apply additional configurations, and then based on your specific scenario you can evaluate whether more advanced monitoring through [manual instrumentation](./java-2x-get-started.md?tabs=maven) is needed.
21-
22-
### Enable backend monitoring
23-
24-
You can turn on monitoring for your Java apps running in Azure App Service just with one click, no code change required. Application Insights for Java is integrated with App Service on Linux - both code-based and custom containers, and with App Service on Windows - code-based apps. It is important to know how your application will be monitored. The integration adds [Application Insights Java 3.x](./java-in-process-agent.md) and you will get the telemetry auto-collected.
22+
You can turn on monitoring for your Java apps running in Azure App Service just with one click, no code change required.
23+
Application Insights for Java is integrated with Azure App Service on Linux - both code-based and custom containers, and with App Service on Windows for code-based apps.
24+
The integration adds [Application Insights Java 3.x](./java-in-process-agent.md) and you will get the telemetry auto-collected.
2525

2626
1. **Select Application Insights** in the Azure control panel for your app service, then select **Enable**.
2727

@@ -32,9 +32,9 @@ You can turn on monitoring for your Java apps running in Azure App Service just
3232
> [!NOTE]
3333
> When you select **OK** to create the new resource you will be prompted to **Apply monitoring settings**. Selecting **Continue** will link your new Application Insights resource to your app service, doing so will also **trigger a restart of your app service**.
3434
35-
:::image type="content"source="./media/azure-web-apps/change-resource.png" alt-text="Screenshot of Change your resource dropdown.":::
35+
:::image type="content"source="./media/azure-web-apps/change-resource.png" alt-text="Screenshot of Change your resource dropdown.":::
3636

37-
3. This step is not required. After specifying which resource to use, you can configure the Java agent. If you do not configure the Java agent, default configurations will apply.
37+
3. This last step is optional. After specifying which resource to use, you can configure the Java agent. If you do not configure the Java agent, default configurations will apply.
3838

3939
The full [set of configurations](./java-standalone-config.md) is available, you just need to paste a valid [json file](./java-standalone-config.md#an-example). **Exclude the connection string and any configurations that are in preview** - you will be able to add the items that are currently in preview as they become generally available.
4040

@@ -49,17 +49,16 @@ To enable client-side monitoring for your Java application, you need to [manuall
4949

5050
## Automate monitoring
5151

52-
### Application settings
53-
5452
In order to enable telemetry collection with Application Insights, only the following Application settings need to be set:
5553

56-
|App setting name | Definition | Value |
57-
|-----------------|:------------|-------------:|
58-
|ApplicationInsightsAgent_EXTENSION_VERSION | Controls runtime monitoring | `~2` for Windows or `~3` for Linux |
59-
|XDT_MicrosoftApplicationInsights_Java | Flag to control that Java agent is included | 0 or 1 only applicable in Windows
60-
|APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL | Only use it if you need to debug the integration of Application Insights with App Service | debug
54+
:::image type="content"source="./media/azure-web-apps-java/application-settings-java.png" alt-text="Screenshot of App Service Application Settings with available Application Insights settings.":::
55+
56+
### Application settings definitions
6157

62-
:::image type="content"source="./media/azure-web-apps-java/application-settings-java.png" alt-text=" Screenshot of App Service Application Settings with available Application Insights settings.":::
58+
| App setting name | Definition | Value |
59+
|------------------|------------|------:|
60+
| ApplicationInsightsAgent_EXTENSION_VERSION | Main extension, which controls runtime monitoring. | `~2` in Windows or `~3` in Linux. |
61+
| XDT_MicrosoftApplicationInsights_Java | Flag to control if Java agent is included. | 0 or 1 (only applicable in Windows). |
6362

6463
> [!NOTE]
6564
> Profiler and snapshot debugger are not available for Java applications

articles/azure-monitor/app/azure-web-apps-nodejs.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,34 @@ ms.custom: "devx-track-js"
99

1010
# Application Monitoring for Azure App Service and Node.js
1111

12-
Enabling monitoring on your Node.js based web applications running on [Azure App Services](../../app-service/index.yml) is now easier than ever. Whereas previously you needed to manually instrument your app, the latest extension/agent is now built into the App Service image by default. This article will walk you through enabling Azure Monitor application Insights monitoring as well as provide preliminary guidance for automating the process for large-scale deployments.
12+
Monitoring of your Node.js web applications running on [Azure App Services](../../app-service/index.yml) does not require any modifications to the code. This article will walk you through enabling Azure Monitor Application Insights monitoring as well as provide preliminary guidance for automating the process for large-scale deployments.
13+
14+
## Enable Application Insights
15+
16+
The easiest way to enable application monitoring for Node.js applications running on Azure App Services is through Azure portal.
17+
Turning on application monitoring in Azure portal will automatically instrument your application with Application Insights, and doesn't require any code changes.
1318

1419
> [!NOTE]
1520
> If both agent-based monitoring and manual SDK-based instrumentation is detected, only the manual instrumentation settings will be honored. This is to prevent duplicate data from being sent. To learn more about this, check out the [troubleshooting section](#troubleshooting) below.
1621
17-
## Enable agent-based monitoring
22+
### Auto-instrumentation through Azure portal
1823

19-
You can monitor your Node.js apps running in Azure App Service without any code change, just with a couple of simple steps. Application insights for Node.js applications is integrated with App Service on Linux - both code-based and custom containers, and with App Service on Windows for code-based apps. The integration is in public preview. The integration adds Node.js SDK, which is in GA.
24+
You can turn on monitoring for your Node.js apps running in Azure App Service just with one click, no code change required.
25+
Application Insights for Node.js is integrated with Azure App Service on Linux - both code-based and custom containers, and with App Service on Windows for code-based apps.
26+
The integration is in public preview. The integration adds Node.js SDK, which is in GA.
2027

2128
1. **Select Application Insights** in the Azure control panel for your app service, then select **Enable**.
2229

2330
:::image type="content"source="./media/azure-web-apps/enable.png" alt-text="Screenshot of Application Insights tab with enable selected.":::
2431

2532
2. Choose to create a new resource, or select an existing Application Insights resource for this application.
2633

27-
> [!NOTE]
28-
> When you click **OK** to create the new resource you will be prompted to **Apply monitoring settings**. Selecting **Continue** will link your new Application Insights resource to your app service, doing so will also **trigger a restart of your app service**.
29-
34+
> [!NOTE]
35+
> When you select **OK** to create the new resource you will be prompted to **Apply monitoring settings**. Selecting **Continue** will link your new Application Insights resource to your app service, doing so will also **trigger a restart of your app service**.
36+
3037
:::image type="content"source="./media/azure-web-apps/change-resource.png" alt-text="Screenshot of Change your resource dropdown.":::
31-
32-
3. Once you have specified which resource to use, you are all set to go.
3338

39+
3. Once you have specified which resource to use, you are all set to go.
3440

3541
:::image type="content"source="./media/azure-web-apps-nodejs/app-service-node.png" alt-text="Screenshot of instrument your application.":::
3642

@@ -41,22 +47,22 @@ To enable client-side monitoring for your Node.js application, you need to [manu
4147

4248
## Automate monitoring
4349

44-
In order to enable telemetry collection with Application Insights, only the Application settings need to be set:
45-
46-
:::image type="content"source="./media/azure-web-apps-nodejs/application-settings-nodejs.png" alt-text="Screenshot ot App Service Application Settings with available Application Insights settings.":::
50+
In order to enable telemetry collection with Application Insights, only the following Application settings need to be set:
4751

52+
:::image type="content"source="./media/azure-web-apps-nodejs/application-settings-nodejs.png" alt-text="Screenshot of App Service Application Settings with available Application Insights settings.":::
4853

4954
### Application settings definitions
5055

51-
|App setting name | Definition | Value |
52-
|-----------------|:------------|-------------:|
53-
|ApplicationInsightsAgent_EXTENSION_VERSION | Main extension, which controls runtime monitoring. | `~2` in Windows or `~3` in Linux |
54-
|XDT_MicrosoftApplicationInsights_NodeJS | Flag to control if node.js Agent is included. | 0 or 1 only applicable in Windows. |
56+
| App setting name | Definition | Value |
57+
|------------------|------------|------:|
58+
| ApplicationInsightsAgent_EXTENSION_VERSION | Main extension, which controls runtime monitoring. | `~2` in Windows or `~3` in Linux. |
59+
| XDT_MicrosoftApplicationInsights_NodeJS | Flag to control if node.js agent is included. | 0 or 1 (only applicable in Windows). |
5560

61+
> [!NOTE]
62+
> Profiler and snapshot debugger are not available for Node.js applications
5663
5764
[!INCLUDE [azure-web-apps-arm-automation](../../../includes/azure-monitor-app-insights-azure-web-apps-arm-automation.md)]
5865

59-
6066
## Troubleshooting
6167

6268
Below is our step-by-step troubleshooting guide for extension/agent based monitoring for Node.js based applications running on Azure App Services.
@@ -70,7 +76,7 @@ Below is our step-by-step troubleshooting guide for extension/agent based monito
7076

7177
- Confirm that the `Application Insights Extension Status` is `Pre-Installed Site Extension, version 2.8.x.xxxx, is running.`
7278

73-
If it is not running, follow the [enable Application Insights monitoring instructions](#enable-agent-based-monitoring).
79+
If it is not running, follow the [enable Application Insights monitoring instructions](#enable-application-insights).
7480

7581
- Navigate to *D:\local\Temp\status.json* and open *status.json*.
7682

@@ -131,9 +137,10 @@ Below is our step-by-step troubleshooting guide for extension/agent based monito
131137

132138
## Release notes
133139

134-
For the latest updates and bug fixes [consult the release notes](web-app-extension-release-notes.md).
140+
For the latest updates and bug fixes, [consult the release notes](web-app-extension-release-notes.md).
135141

136142
## Next steps
143+
137144
* [Monitor Azure Functions with Application Insights](monitor-functions.md).
138145
* [Enable Azure diagnostics](../agents/diagnostics-extension-to-application-insights.md) to be sent to Application Insights.
139146
* [Monitor service health metrics](../data-platform.md) to make sure your service is available and responsive.

0 commit comments

Comments
 (0)