Skip to content

Commit 3e0f43b

Browse files
Merge pull request #209032 from AaronMaxwell/aaronmax-update-azure-web-apps-net-troubleshooting
https://github.com/MicrosoftDocs/azure-docs/issues/97059
2 parents c479dc8 + ea81618 commit 3e0f43b

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Monitor Azure app services performance ASP.NET | Microsoft Docs
33
description: Application performance monitoring for Azure app services using ASP.NET. Chart load and response time, dependency information, and set alerts on performance.
44
ms.topic: conceptual
5-
ms.date: 08/05/2021
5+
ms.date: 08/24/2022
66
ms.devlang: javascript
77
ms.custom: devx-track-dotnet
88
ms.reviewer: abinetabate
@@ -23,7 +23,7 @@ Enabling monitoring on your ASP.NET based web applications running on [Azure App
2323
## Enable auto-instrumentation monitoring
2424

2525
> [!NOTE]
26-
> The combination of APPINSIGHTS_JAVASCRIPT_ENABLED and urlCompression is not supported. For more info see the explanation in the [troubleshooting section](#appinsights_javascript_enabled-and-urlcompression-is-not-supported).
26+
> The combination of APPINSIGHTS_JAVASCRIPT_ENABLED and urlCompression is not supported. For more info see the explanation in the [troubleshooting section](#appinsights_javascript_enabled-and-urlcompression-isnt-supported).
2727
2828
1. **Select Application Insights** in the Azure control panel for your app service, then select **Enable**.
2929

@@ -89,9 +89,9 @@ In order to enable telemetry collection with Application Insights, only the Appl
8989
|App setting name | Definition | Value |
9090
|-----------------|:------------|-------------:|
9191
|ApplicationInsightsAgent_EXTENSION_VERSION | Main extension, which controls runtime monitoring. | `~2` |
92-
|XDT_MicrosoftApplicationInsights_Mode | In default mode, only essential features are enabled in order to insure optimal performance. | `default` or `recommended`. |
92+
|XDT_MicrosoftApplicationInsights_Mode | In default mode, only essential features are enabled in order to ensure optimal performance. | `default` or `recommended`. |
9393
|InstrumentationEngine_EXTENSION_VERSION | Controls if the binary-rewrite engine `InstrumentationEngine` will be turned on. This setting has performance implications and impacts cold start/startup time. | `~1` |
94-
|XDT_MicrosoftApplicationInsights_BaseExtensions | Controls if SQL & Azure table text will be captured along with the dependency calls. Performance warning: application cold start up time will be affected. This setting requires the `InstrumentationEngine`. | `~1` |
94+
|XDT_MicrosoftApplicationInsights_BaseExtensions | Controls if SQL & Azure table text will be captured along with the dependency calls. Performance warning: application cold startup time will be affected. This setting requires the `InstrumentationEngine`. | `~1` |
9595

9696
[!INCLUDE [azure-web-apps-arm-automation](../../../includes/azure-monitor-app-insights-azure-web-apps-arm-automation.md)]
9797

@@ -100,15 +100,15 @@ In order to enable telemetry collection with Application Insights, only the Appl
100100

101101
### Upgrade from versions 2.8.9 and up
102102

103-
Upgrading from version 2.8.9 happens automatically, without any additional actions. The new monitoring bits are delivered in the background to the target app service, and on application restart they will be picked up.
103+
Upgrading from version 2.8.9 happens automatically, without any extra actions. The new monitoring bits are delivered in the background to the target app service, and on application restart they'll be picked up.
104104

105-
To check which version of the extension you're running, go to `https://yoursitename.scm.azurewebsites.net/ApplicationInsights`.
105+
To check which version of the extension you're running, go to `https://scm.yoursitename.azurewebsites.net/ApplicationInsights`.
106106

107-
:::image type="content"source="./media/azure-web-apps/extension-version.png" alt-text="Screenshot of the URL path to check the version of the extension you are running." border="false":::
107+
:::image type="content"source="./media/azure-web-apps/extension-version.png" alt-text="Screenshot of the URL path to check the version of the extension you're running." border="false":::
108108

109109
### Upgrade from versions 1.0.0 - 2.6.5
110110

111-
Starting with version 2.8.9 the pre-installed site extension is used. If you are an earlier version, you can update via one of two ways:
111+
Starting with version 2.8.9 the pre-installed site extension is used. If you're an earlier version, you can update via one of two ways:
112112

113113
* [Upgrade by enabling via the portal](#enable-auto-instrumentation-monitoring). (Even if you have the Application Insights extension for Azure App Service installed, the UI shows only **Enable** button. Behind the scenes, the old private site extension will be removed.)
114114

@@ -127,40 +127,40 @@ If the upgrade is done from a version prior to 2.5.1, check that the Application
127127
Below is our step-by-step troubleshooting guide for extension/agent based monitoring for ASP.NET based applications running on Azure App Services.
128128

129129
1. Check that `ApplicationInsightsAgent_EXTENSION_VERSION` app setting is set to a value of "~2".
130-
2. Browse to `https://yoursitename.scm.azurewebsites.net/ApplicationInsights`.
130+
2. Browse to `https://scm.yoursitename.azurewebsites.net/ApplicationInsights`.
131131

132132
:::image type="content"source="./media/azure-web-apps/app-insights-sdk-status.png" alt-text="Screenshot of the link above results page."border ="false":::
133133

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

136-
If it is not running, follow the [enable Application Insights monitoring instructions](#enable-auto-instrumentation-monitoring).
136+
If it isn't running, follow the [enable Application Insights monitoring instructions](#enable-auto-instrumentation-monitoring).
137137

138138
- Confirm that the status source exists and looks like: `Status source D:\home\LogFiles\ApplicationInsights\status\status_RD0003FF0317B6_4248_1.json`
139139

140-
If a similar value is not present, it means the application is not currently running or is not supported. To ensure that the application is running, try manually visiting the application url/application endpoints, which will allow the runtime information to become available.
140+
If a similar value isn't present, it means the application isn't currently running or isn't supported. To ensure that the application is running, try manually visiting the application url/application endpoints, which will allow the runtime information to become available.
141141

142142
- Confirm that `IKeyExists` is `true`
143-
If it is `false`, add `APPINSIGHTS_INSTRUMENTATIONKEY` and `APPLICATIONINSIGHTS_CONNECTION_STRING` with your ikey guid to your application settings.
143+
If not, add `APPINSIGHTS_INSTRUMENTATIONKEY` and `APPLICATIONINSIGHTS_CONNECTION_STRING` with your ikey guid to your application settings.
144144

145145
- Confirm that there are no entries for `AppAlreadyInstrumented`, `AppContainsDiagnosticSourceAssembly`, and `AppContainsAspNetTelemetryCorrelationAssembly`.
146146

147147
If any of these entries exist, remove the following packages from your application: `Microsoft.ApplicationInsights`, `System.Diagnostics.DiagnosticSource`, and `Microsoft.AspNet.TelemetryCorrelation`.
148148

149149
#### Default website deployed with web apps does not support automatic client-side monitoring
150150

151-
When you create a web app with the `ASP.NET` runtimes in Azure App Services it deploys a single static HTML page as a starter website. The static webpage also loads a ASP.NET managed web part in IIS. This allows for testing codeless server-side monitoring, but does not support automatic client-side monitoring.
151+
When you create a web app with the `ASP.NET` runtimes in Azure App Services it deploys a single static HTML page as a starter website. The static webpage also loads a ASP.NET managed web part in IIS. This allows for testing codeless server-side monitoring, but doesn't support automatic client-side monitoring.
152152

153-
If you wish to test out codeless server and client-side monitoring for ASP.NET in an Azure App Services web app we recommend following the official guides for [creating an ASP.NET Framework web app](../../app-service/quickstart-dotnetcore.md?tabs=netframework48) and then use the instructions in the current article to enable monitoring.
153+
If you wish to test out codeless server and client-side monitoring for ASP.NET in an Azure App Services web app, we recommend following the official guides for [creating an ASP.NET Framework web app](../../app-service/quickstart-dotnetcore.md?tabs=netframework48) and then use the instructions in the current article to enable monitoring.
154154

155155

156-
### APPINSIGHTS_JAVASCRIPT_ENABLED and urlCompression is not supported
156+
### APPINSIGHTS_JAVASCRIPT_ENABLED and urlCompression isn't supported
157157

158158
If you use APPINSIGHTS_JAVASCRIPT_ENABLED=true in cases where content is encoded, you might get errors like:
159159

160160
- 500 URL rewrite error
161-
- 500.53 URL rewrite module error with message Outbound rewrite rules cannot be applied when the content of the HTTP response is encoded ('gzip').
161+
- 500.53 URL rewrite module error with message Outbound rewrite rules can't be applied when the content of the HTTP response is encoded ('gzip').
162162

163-
This is due to the APPINSIGHTS_JAVASCRIPT_ENABLED application setting being set to true and content-encoding being present at the same time. This scenario is not supported yet. The workaround is to remove APPINSIGHTS_JAVASCRIPT_ENABLED from your application settings. Unfortunately this means that if client/browser-side JavaScript instrumentation is still required, manual SDK references are needed for your webpages. Follow the [instructions](https://github.com/Microsoft/ApplicationInsights-JS#snippet-setup-ignore-if-using-npm-setup) for manual instrumentation with the JavaScript SDK.
163+
This is due to the APPINSIGHTS_JAVASCRIPT_ENABLED application setting being set to true and content-encoding being present at the same time. This scenario isn't supported yet. The workaround is to remove APPINSIGHTS_JAVASCRIPT_ENABLED from your application settings. Unfortunately this means that if client/browser-side JavaScript instrumentation is still required, manual SDK references are needed for your webpages. Follow the [instructions](https://github.com/Microsoft/ApplicationInsights-JS#snippet-setup-ignore-if-using-npm-setup) for manual instrumentation with the JavaScript SDK.
164164

165165
For the latest information on the Application Insights agent/extension, check out the [release notes](https://github.com/MohanGsk/ApplicationInsights-Home/blob/master/app-insights-web-app-extensions-releasenotes.md).
166166

@@ -178,7 +178,7 @@ The table below provides a more detailed explanation of what these values mean,
178178
|`AppAlreadyInstrumented:true` | This value can also be caused by the presence of the above dlls in the app folder from a previous deployment. | Clean the app folder to ensure that these dlls are removed. Check both your local app's bin directory, and the wwwroot directory on the App Service. (To check the wwwroot directory of your App Service web app: Advanced Tools (Kudu) > Debug console > CMD > home\site\wwwroot).
179179
|`AppContainsAspNetTelemetryCorrelationAssembly: true` | This value indicates that extension detected references to `Microsoft.AspNet.TelemetryCorrelation` in the application, and will back-off. | Remove the reference.
180180
|`AppContainsDiagnosticSourceAssembly**:true`|This value indicates that extension detected references to `System.Diagnostics.DiagnosticSource` in the application, and will back-off.| For ASP.NET remove the reference.
181-
|`IKeyExists:false`|This value indicates that the instrumentation key is not present in the AppSetting, `APPINSIGHTS_INSTRUMENTATIONKEY`. Possible causes: The values may have been accidentally removed, forgot to set the values in automation script, etc. | Make sure the setting is present in the App Service application settings.
181+
|`IKeyExists:false`|This value indicates that the instrumentation key isn't present in the AppSetting, `APPINSIGHTS_INSTRUMENTATIONKEY`. Possible causes: The values may have been accidentally removed, forgot to set the values in automation script, etc. | Make sure the setting is present in the App Service application settings.
182182

183183
## Release notes
184184

0 commit comments

Comments
 (0)