title | description | ms.topic | ms.date | ms.custom |
---|---|---|---|---|
Create a new Azure Application Insights resource | Microsoft Docs |
Manually set up Application Insights monitoring for a new live application. |
conceptual |
02/10/2021 |
devx-track-azurepowershell, devx-track-azurecli |
Azure Application Insights displays data about your application in a Microsoft Azure resource. Creating a new resource is therefore part of setting up Application Insights to monitor a new application. After you have created your new resource, you can get its instrumentation key and use that to configure the Application Insights SDK. The instrumentation key links your telemetry to the resource.
Important
Classic Application Insights has been deprecated. Please follow these instructions on how upgrade to workspace-based Application Insights.
If you don't have an Azure subscription, create a free account before you begin.
Sign in to the Azure portal, and create an Application Insights resource:
Settings | Value | Description |
---|---|---|
Name | Unique value |
Name that identifies the app you are monitoring. |
Resource Group | myResourceGroup |
Name for the new or existing resource group to host App Insights data. |
Region | East US |
Choose a location near you, or near where your app is hosted. |
Resource Mode | Classic or Workspace-based |
Workspace-based resources allow you to send your Application Insights telemetry to a common Log Analytics workspace. For more information, see the article on workspace-based resources. |
Note
While you can use the same resource name across different resource groups, it can be beneficial to use a globally unique name. This can be useful if you plan to perform cross resource queries as it simplifies the required syntax.
Enter the appropriate values into the required fields, and then select Review + create.
When your app has been created, a new pane opens. This pane is where you see performance and usage data about your monitored application.
The instrumentation key identifies the resource that you want to associate your telemetry data with. You will need to copy the instrumentation key and add it to your application's code.
Important
Connection Strings are recommended over instrumentation keys. New Azure regions require the use of connection strings instead of instrumentation keys. Connection string identifies the resource that you want to associate your telemetry data with. It also allows you to modify the endpoints your resource will use as a destination for your telemetry. You will need to copy the connection string and add it to your application's code or to an environment variable.
Install the Application Insights SDK in your app. This step depends heavily on the type of your application.
Use the instrumentation key to configure the SDK that you install in your application.
The SDK includes standard modules that send telemetry without you having to write any additional code. To track user actions or diagnose issues in more detail, use the API to send your own telemetry.
Create a new Application Insights resource
New-AzApplicationInsights [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> [-Kind <String>]
[-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
New-AzApplicationInsights -Kind java -ResourceGroupName testgroup -Name test1027 -location eastus
Id : /subscriptions/{subid}/resourceGroups/testgroup/providers/microsoft.insights/components/test1027
ResourceGroupName : testgroup
Name : test1027
Kind : web
Location : eastus
Type : microsoft.insights/components
AppId : 8323fb13-32aa-46af-b467-8355cf4f8f98
ApplicationType : web
Tags : {}
CreationDate : 10/27/2017 4:56:40 PM
FlowType :
HockeyAppId :
HockeyAppToken :
InstrumentationKey : 00000000-aaaa-bbbb-cccc-dddddddddddd
ProvisioningState : Succeeded
RequestSource : AzurePowerShell
SamplingPercentage :
TenantId : {subid}
For the full PowerShell documentation for this cmdlet, and to learn how to retrieve the instrumentation key consult the Azure PowerShell documentation.
To access the preview Application Insights Azure CLI commands, you first need to run:
az extension add -n application-insights
If you don't run the az extension add
command, you will see an error message that states: az : ERROR: az monitor: 'app-insights' is not in the 'az monitor' command group. See 'az monitor --help'.
Now you can run the following to create your Application Insights resource:
az monitor app-insights component create --app
--location
--resource-group
[--application-type]
[--kind]
[--tags]
az monitor app-insights component create --app demoApp --location westus2 --kind web -g demoRg --application-type web
az monitor app-insights component create --app demoApp --location eastus --kind web -g demoApp --application-type web
{
"appId": "87ba512c-e8c9-48d7-b6eb-118d4aee2697",
"applicationId": "demoApp",
"applicationType": "web",
"creationDate": "2019-08-16T18:15:59.740014+00:00",
"etag": "\"0300edb9-0000-0100-0000-5d56f2e00000\"",
"flowType": "Bluefield",
"hockeyAppId": null,
"hockeyAppToken": null,
"id": "/subscriptions/{subid}/resourceGroups/demoApp/providers/microsoft.insights/components/demoApp",
"instrumentationKey": "00000000-aaaa-bbbb-cccc-dddddddddddd",
"kind": "web",
"location": "eastus",
"name": "demoApp",
"provisioningState": "Succeeded",
"requestSource": "rest",
"resourceGroup": "demoApp",
"samplingPercentage": null,
"tags": {},
"tenantId": {tenantID},
"type": "microsoft.insights/components"
}
For the full Azure CLI documentation for this command, and to learn how to retrieve the instrumentation key consult the Azure CLI documentation.