Skip to content

Commit c75ecb4

Browse files
authored
Merge pull request #86118 from DawgFan/mmccbranch
Update Agent Naming and Improve Deployment Instructions for VM, VMSS, and On-Prem
2 parents 560e335 + 70b082f commit c75ecb4

15 files changed

+120
-94
lines changed

articles/azure-monitor/app/azure-vm-vmss-apps.md

Lines changed: 41 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,35 @@ author: mrbullwinkle
77
manager: carmonm
88
ms.service: application-insights
99
ms.topic: conceptual
10-
ms.date: 06/27/2019
10+
ms.date: 08/26/2019
1111
ms.author: mbullwin
1212

1313
---
14-
# Monitor application performance hosted on Azure VM and Azure virtual machine scale sets
14+
# Deploy the Azure Monitor Application Insights Agent on Azure virtual machines and Azure virtual machine scale sets
1515

16-
Enabling monitoring on your .NET based web applications running on [Azure Virtual Machines](https://azure.microsoft.com/services/virtual-machines/) and [Azure Virtual Machine Scale Sets](https://docs.microsoft.com/azure/virtual-machine-scale-sets/) is now easier than ever. Get all the benefits of using Application Insights without modifying your code.
16+
Enabling monitoring on your .NET based web applications running on [Azure virtual machines](https://azure.microsoft.com/services/virtual-machines/) and [Azure virtual machine scale sets](https://docs.microsoft.com/azure/virtual-machine-scale-sets/) is now easier than ever. Get all the benefits of using Application Insights without modifying your code.
1717

18-
This article will walk you through enabling Application Insights monitoring using the ApplicationMonitoringWindows extension and provide preliminary guidance for automating the process for large-scale deployments.
18+
This article walks you through enabling Application Insights monitoring using the Application Insights Agent and provides preliminary guidance for automating the process for large-scale deployments.
1919

2020
> [!IMPORTANT]
21-
> Azure ApplicationMonitoringWindows extension is currently in public preview.
21+
> Azure Application Insights Agent for .NET is currently in public preview.
2222
> This preview version is provided without a service-level agreement, and we don't recommend it for production workloads. Some features might not be supported, and some might have constrained capabilities.
2323
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
2424
2525
## Enable Application Insights
2626

27-
There are two ways to enable application monitoring for Azure VM and Azure virtual machine scale set hosted applications:
27+
There are two ways to enable application monitoring for Azure virtual machines and Azure virtual machine scale sets hosted applications:
2828

29-
* **Agent-based application monitoring** (ApplicationMonitoringWindows extension).
30-
* This method is the easiest to enable, and no advanced configuration is required. It is often referred to as "runtime" monitoring. For Azure VMs and Azure virtual machine scale sets we recommend at a minimum enabling this level of monitoring. After that, based on your specific scenario, you can evaluate whether manual instrumentation is needed.
31-
* Currently only .Net IIS-hosted applications are supported.
29+
* **Codeless** via Application Insights Agent
30+
* This method is the easiest to enable, and no advanced configuration is required. It is often referred to as "runtime" monitoring.
3231

33-
* **Manually instrumenting the application through code** by installing the Application Insights SDK.
32+
* For Azure virtual machines and Azure virtual machine scale sets we recommend at a minimum enabling this level of monitoring. After that, based on your specific scenario, you can evaluate whether manual instrumentation is needed.
33+
34+
* The Application Insights Agent auto-collects the same dependency signals out-of-the-box as the .NET SDK. See [Dependency auto-collection](https://docs.microsoft.com/azure/azure-monitor/app/auto-collect-dependencies#net) to learn more.
35+
> [!NOTE]
36+
> Currently only .Net IIS-hosted applications are supported. Use an SDK to instrument ASP.NET Core, Java, and Node.js applications hosted on an Azure virtual machines and virtual machine scale sets.
37+
38+
* **Code-based** via SDK
3439

3540
* This approach is much more customizable, but it requires [adding a dependency on the Application Insights SDK NuGet packages](https://docs.microsoft.com/azure/azure-monitor/app/asp-net). This method, also means you have to manage the updates to the latest version of the packages yourself.
3641

@@ -39,9 +44,15 @@ There are two ways to enable application monitoring for Azure VM and Azure virtu
3944
> [!NOTE]
4045
> 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.
4146
42-
## Manage agent-based monitoring for .NET applications on VM using PowerShell
47+
## Manage Application Insights Agent for .NET applications on Azure virtual machines using PowerShell
48+
49+
> [!NOTE]
50+
> Before installing the Application Insights Agent, you'll need an instrumentation key. [Create a new Application Insights Resource](https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource) or copy the instrumentation key from an existing application insights resource.
51+
52+
> [!NOTE]
53+
> New to powershell? Check out the [Get Started Guide](https://docs.microsoft.com/powershell/azure/get-started-azureps?view=azps-2.5.0).
4354
44-
Install or update the application monitoring extension for VM
55+
Install or update the Application Insights Agent as an extension for Azure virtual machines
4556
```powershell
4657
$publicCfgJsonString = '
4758
{
@@ -62,20 +73,23 @@ $publicCfgJsonString = '
6273
';
6374
$privateCfgJsonString = '{}';
6475
65-
Set-AzVMExtension -ResourceGroupName "<myVmResourceGroup>" -VMName "<myVmName>" -Location "South Central US" -Name "ApplicationMonitoring" -Publisher "Microsoft.Azure.Diagnostics" -Type "ApplicationMonitoringWindows" -Version "2.8" -SettingString $publicCfgJsonString -ProtectedSettingString $privateCfgJsonString
76+
Set-AzVMExtension -ResourceGroupName "<myVmResourceGroup>" -VMName "<myVmName>" -Location "<myVmLocation>" -Name "ApplicationMonitoring" -Publisher "Microsoft.Azure.Diagnostics" -Type "ApplicationMonitoringWindows" -Version "2.8" -SettingString $publicCfgJsonString -ProtectedSettingString $privateCfgJsonString
6677
```
6778

68-
Uninstall application monitoring extension from VM
79+
> [!NOTE]
80+
> You may install or update the Application Insights Agent as an extension across multiple Virtual Machines at-scale using a Powershell loop.
81+
82+
Uninstall Application Insights Agent extension from Azure virtual machine
6983
```powershell
7084
Remove-AzVMExtension -ResourceGroupName "<myVmResourceGroup>" -VMName "<myVmName>" -Name "ApplicationMonitoring"
7185
```
7286

73-
Query application monitoring extension status for VM
87+
Query Application Insights Agent extension status for Azure virtual machine
7488
```powershell
7589
Get-AzVMExtension -ResourceGroupName "<myVmResourceGroup>" -VMName "<myVmName>" -Name ApplicationMonitoring -Status
7690
```
7791

78-
Get list of installed extensions for VM
92+
Get list of installed extensions for Azure virtual machine
7993
```powershell
8094
Get-AzResource -ResourceId "/subscriptions/<mySubscriptionId>/resourceGroups/<myVmResourceGroup>/providers/Microsoft.Compute/virtualMachines/<myVmName>/extensions"
8195
@@ -85,10 +99,14 @@ Get-AzResource -ResourceId "/subscriptions/<mySubscriptionId>/resourceGroups/<my
8599
# Location : southcentralus
86100
# ResourceId : /subscriptions/<mySubscriptionId>/resourceGroups/<myVmResourceGroup>/providers/Microsoft.Compute/virtualMachines/<myVmName>/extensions/ApplicationMonitoring
87101
```
102+
You may also view installed extensions in the [Azure virtual machine blade](https://docs.microsoft.com/azure/virtual-machines/extensions/overview) in the Portal.
103+
104+
> [!NOTE]
105+
> Verify installation by clicking on Live Metrics Stream within the Application Insights Resource associated with the instrumentation key you used to deploy the Application Insights Agent Extension. If you are sending data from multiple Virtual Machines, select the target Azure virtual machines under Server Name. It may take up to a minute for data to begin flowing.
88106
89-
## Manage agent-based monitoring for .NET applications on Azure virtual machine scale set using powershell
107+
## Manage Application Insights Agent for .NET applications on Azure virtual machine scale sets using powershell
90108

91-
Install or update the application monitoring extension for Azure virtual machine scale set
109+
Install or update the Application Insights Agent as an extension for Azure virtual machine scale set
92110
```powershell
93111
$publicCfgHashtable =
94112
@{
@@ -117,7 +135,7 @@ Update-AzVmss -ResourceGroupName $vmss.ResourceGroupName -Name $vmss.Name -Virtu
117135
# Note: depending on your update policy, you might need to run Update-AzVmssInstance for each instance
118136
```
119137

120-
Uninstall application monitoring extension from Azure virtual machine scale set
138+
Uninstall application monitoring extension from Azure virtual machine scale sets
121139
```powershell
122140
$vmss = Get-AzVmss -ResourceGroupName "<myResourceGroup>" -VMScaleSetName "<myVmssName>"
123141
@@ -128,12 +146,12 @@ Update-AzVmss -ResourceGroupName $vmss.ResourceGroupName -Name $vmss.Name -Virtu
128146
# Note: depending on your update policy, you might need to run Update-AzVmssInstance for each instance
129147
```
130148

131-
Query application monitoring extension status for Azure virtual machine scale set
149+
Query application monitoring extension status for Azure virtual machine scale sets
132150
```powershell
133151
# Not supported by extensions framework
134152
```
135153

136-
Get list of installed extensions for Azure virtual machine scale set
154+
Get list of installed extensions for Azure virtual machine scale sets
137155
```powershell
138156
Get-AzResource -ResourceId /subscriptions/<mySubscriptionId>/resourceGroups/<myResourceGroup>/providers/Microsoft.Compute/virtualMachineScaleSets/<myVmssName>/extensions
139157
@@ -146,10 +164,10 @@ Get-AzResource -ResourceId /subscriptions/<mySubscriptionId>/resourceGroups/<myR
146164

147165
## Troubleshooting
148166

149-
Below is our step-by-step troubleshooting guide for extension-based monitoring for .NET applications running on Azure VM and Azure virtual machine scale sets.
167+
Find troubleshooting tips for Application Insights Monitoring Agent Extension for .NET applications running on Azure virtual machines and virtual machine scale sets.
150168

151169
> [!NOTE]
152-
> .NET Core, Java, and Node.js applications are only supported on Azure VM and Azure virtual machine scale sets via manual SDK based instrumentation and therefore the steps below do not apply to these scenarios.
170+
> .NET Core, Java, and Node.js applications are only supported on Azure virtual machines and Azure virtual machine scale sets via manual SDK based instrumentation and therefore the steps below do not apply to these scenarios.
153171
154172
Extension execution output is logged to files found in the following directories:
155173
```Windows

articles/azure-monitor/app/monitor-performance-live-website-now.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,14 @@ ms.service: application-insights
1010
ms.workload: tbd
1111
ms.tgt_pltfrm: ibiza
1212
ms.topic: conceptual
13-
ms.date: 05/24/2019
13+
ms.date: 08/26/2019
1414
ms.author: mbullwin
1515
---
1616
# Instrument web apps at runtime with Application Insights Codeless Attach
1717

18+
> [!IMPORTANT]
19+
> Status Monitor is no longer recommended for use. It has been replaced by the Azure Monitor Application Insights Agent (formerly named Status Monitor v2). See our documentation for [on-premises server deployments](https://docs.microsoft.com/azure/azure-monitor/app/status-monitor-v2-overview) or [Azure virtual machine and virtual machine scale set deployments](https://docs.microsoft.com/azure/azure-monitor/app/azure-vm-vmss-apps).
20+
1821
You can instrument a live web app with Azure Application Insights, without having to modify or redeploy your code. You need a [Microsoft Azure](https://azure.com) subscription.
1922

2023
Status Monitor is used to instrument a .NET application hosted in IIS either on-premises or in a VM.
@@ -33,7 +36,7 @@ You have a choice of two routes to apply Application Insights to your .NET web a
3336
* **Run time:** Instrument your web app on the server, as described below, without rebuilding and redeploying the code.
3437

3538
> [!NOTE]
36-
> If you use build time instrumentation, run time instrumention will not work even if it is turned on.
39+
> If you use build time instrumentation, run time instrumentation will not work even if it is turned on.
3740
3841
Here's a summary of what you get by each route:
3942

articles/azure-monitor/app/status-monitor-v2-api-disable-instrumentation-engine.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Azure Status Monitor v2 API reference: Disable instrumentation engine | Microsoft Docs"
3-
description: Status Monitor v2 API reference. Disable-InstrumentationEngine. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
2+
title: "Azure Application Insights Agent API reference: Disable instrumentation engine | Microsoft Docs"
3+
description: Application Insights Agent API reference. Disable-InstrumentationEngine. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
44
services: application-insights
55
documentationcenter: .net
66
author: TimothyMothra
@@ -13,7 +13,7 @@ ms.topic: conceptual
1313
ms.date: 04/23/2019
1414
ms.author: tilee
1515
---
16-
# Status Monitor v2 API: Disable-InstrumentationEngine
16+
# Application Insights Agent API: Disable-InstrumentationEngine
1717

1818
This article describes a cmdlet that's a member of the [Az.ApplicationMonitor PowerShell module](https://www.powershellgallery.com/packages/Az.ApplicationMonitor/).
1919

@@ -51,5 +51,5 @@ Configuring registry for instrumentation engine...
5151

5252
## Next steps
5353

54-
Do more with Status Monitor v2:
55-
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Status Monitor v2.
54+
Do more with Application Insights Agent:
55+
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Application Insights Agent.

articles/azure-monitor/app/status-monitor-v2-api-disable-monitoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Azure Status Monitor v2 API reference: Disable monitoring | Microsoft Docs"
3-
description: Status Monitor v2 API reference. Disable-ApplicationInsightsMonitoring. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
2+
title: "Azure Application Insights Agent API reference: Disable monitoring | Microsoft Docs"
3+
description: Application Insights Agent API reference. Disable-ApplicationInsightsMonitoring. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
44
services: application-insights
55
documentationcenter: .net
66
author: TimothyMothra
@@ -13,7 +13,7 @@ ms.topic: conceptual
1313
ms.date: 04/23/2019
1414
ms.author: tilee
1515
---
16-
# Status Monitor v2 API: Disable-ApplicationInsightsMonitoring
16+
# Application Insights Agent API: Disable-ApplicationInsightsMonitoring
1717

1818
This article describes a cmdlet that's a member of the [Az.ApplicationMonitor PowerShell module](https://www.powershellgallery.com/packages/Az.ApplicationMonitor/).
1919

@@ -65,5 +65,5 @@ Successfully disabled Application Insights Status Monitor
6565

6666
## Next steps
6767

68-
Do more with Status Monitor v2:
69-
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Status Monitor v2.
68+
Do more with Application Insights Agent:
69+
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Application Insights Agent.

articles/azure-monitor/app/status-monitor-v2-api-enable-instrumentation-engine.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Azure Status Monitor v2 API reference: Enable instrumentation engine | Microsoft Docs"
3-
description: Status Monitor v2 API reference. Enable-InstrumentationEngine. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
2+
title: "Azure Application Insights Agent API reference: Enable instrumentation engine | Microsoft Docs"
3+
description: Application Insights Agent API reference. Enable-InstrumentationEngine. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
44
services: application-insights
55
documentationcenter: .net
66
author: TimothyMothra
@@ -13,7 +13,7 @@ ms.topic: conceptual
1313
ms.date: 04/23/2019
1414
ms.author: tilee
1515
---
16-
# Status Monitor v2 API: Enable-InstrumentationEngine
16+
# Application Insights Agent API: Enable-InstrumentationEngine
1717

1818
This article describes a cmdlet that's a member of the [Az.ApplicationMonitor PowerShell module](https://www.powershellgallery.com/packages/Az.ApplicationMonitor/).
1919

@@ -73,7 +73,7 @@ Configuring registry for instrumentation engine...
7373
- [Add web client telemetry](../../azure-monitor/app/javascript.md) to see exceptions from web page code and to enable trace calls.
7474
- [Add the Application Insights SDK to your code](../../azure-monitor/app/asp-net.md) so you can insert trace and log calls.
7575

76-
Do more with Status Monitor v2:
77-
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Status Monitor v2.
76+
Do more with Application Insights Agent:
77+
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Application Insights Agent.
7878
- [Get the config](status-monitor-v2-api-get-config.md) to confirm that your settings were recorded correctly.
7979
- [Get the status](status-monitor-v2-api-get-status.md) to inspect monitoring.

articles/azure-monitor/app/status-monitor-v2-api-enable-monitoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Azure Status Monitor v2 API reference: Enable monitoring | Microsoft Docs"
3-
description: Status Monitor v2 API reference. Enable-ApplicationInsightsMonitoring. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
2+
title: "Azure Application Insights Agent API reference: Enable monitoring | Microsoft Docs"
3+
description: Application Insights Agent API reference. Enable-ApplicationInsightsMonitoring. Monitor website performance without redeploying the website. Works with ASP.NET web apps hosted on-premises, in VMs, or on Azure.
44
services: application-insights
55
documentationcenter: .net
66
author: TimothyMothra
@@ -13,7 +13,7 @@ ms.topic: conceptual
1313
ms.date: 04/23/2019
1414
ms.author: tilee
1515
---
16-
# Status Monitor v2 API: Enable-ApplicationInsightsMonitoring
16+
# Application Insights Agent API: Enable-ApplicationInsightsMonitoring
1717

1818
This article describes a cmdlet that's a member of the [Az.ApplicationMonitor PowerShell module](https://www.powershellgallery.com/packages/Az.ApplicationMonitor/).
1919

@@ -159,7 +159,7 @@ Successfully enabled Application Insights Status Monitor
159159
- [Add web client telemetry](../../azure-monitor/app/javascript.md) to see exceptions from web page code and to enable trace calls.
160160
- [Add the Application Insights SDK to your code](../../azure-monitor/app/asp-net.md) so you can insert trace and log calls.
161161

162-
Do more with Status Monitor v2:
163-
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Status Monitor v2.
162+
Do more with Application Insights Agent:
163+
- Use our guide to [troubleshoot](status-monitor-v2-troubleshoot.md) Application Insights Agent.
164164
- [Get the config](status-monitor-v2-api-get-config.md) to confirm that your settings were recorded correctly.
165165
- [Get the status](status-monitor-v2-api-get-status.md) to inspect monitoring.

0 commit comments

Comments
 (0)