Создание ресурса Application Insights

Внимание!

Эта статья относится к классическим ресурсам Application Insights, которые больше не рекомендуются.

Сведения в этой статье устарели и не будут обновляться.

Переходите на Application Insights на основе рабочих областей, чтобы воспользоваться новыми возможностями.

Application Insights отображает данные о приложении в ресурсе Azure. Создание нового ресурса является частью настройки Application Insights для мониторинга нового приложения. После создания нового ресурса можно получить ключ инструментирования и использовать его для настройки пакета SDK для Application Insights. Ключ инструментирования связывает телеметрию с ресурсом.

Важно!

29 февраля 2024 г. поддержка классической Application Insights завершится. Переходите на Application Insights на основе рабочих областей, чтобы воспользоваться новыми возможностями. Новые регионы, появившиеся после февраля 2021 г., не поддерживают создание классических ресурсов Application Insights.

Примечание

Поддержка приема ключей инструментирования будет завершена 31 марта 31, 2025 г. Функция продолжит работать, но не будет обновляться или поддерживаться. Перейдите на строки подключения, чтобы использовать новые возможности.

Вход в Azure

Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.

Создание ресурса Application Insights

Войдите в портал Azure и создайте ресурс Application Insights.

Параметры	Значение	Описание
имя;	Unique value	Имя, идентифицирующее отслеживаемое приложение.
Группа ресурсов	myResourceGroup	Имя новой или существующей группы ресурсов для размещения данных Application Insights.
Регион	East US	Выберите расположение рядом с вами или рядом с местом размещения приложения.
Режим ресурсов	Classic или Workspace-based	Ресурсы на основе рабочей области позволяют отправлять телеметрию Application Insights в общую рабочую область Log Analytics. Дополнительные сведения см. в статье Ресурсы Application Insights на основе рабочей области.

Примечание

Вы можете использовать одно и то же имя ресурса в разных группах ресурсов, но может быть полезно использовать глобально уникальное имя. Если вы планируете выполнять запросы между ресурсами, использование глобально уникального имени упрощает необходимый синтаксис.

Введите соответствующие значения в обязательные поля. Выберите Review + create (Просмотреть и создать).

После создания приложения в новой области отображаются данные о производительности и использовании отслеживаемого приложения.

Копирование ключа инструментирования

Ключ инструментирования идентифицирует ресурс, который необходимо связать с данными телеметрии. Необходимо скопировать ключ инструментирования и добавить его в код приложения.

Установка пакета SDK в приложении

Установите пакет SDK Application Insights в приложении. Выполнение этого шага зависит от типа приложения.

Используйте ключ инструментирования для настройки пакета SDK, который можно установить в приложении.

Пакет SDK включает стандартные модули, которые отправляют данные телеметрии, поэтому вам не нужно писать больше кода. Для более подробного отслеживания действий пользователей или диагностики неполадок отправляйте собственные данные телеметрии, используя API.

Автоматическое создание ресурса

Используйте PowerShell или Azure CLI для автоматического создания ресурса.

PowerShell

Создайте новый ресурс Application Insights.

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}

Полную документацию по PowerShell для этого командлета и сведения о том, как получить ключ инструментирования, см. в документации по Azure PowerShell.

Azure CLI (предварительная версия)

Чтобы получить доступ к командам Azure CLI для предварительной версии Application Insights, сначала необходимо выполнить следующее.

 az extension add -n application-insights

Если вы не выполните az extension add команду, появится сообщение об ошибке, в которой указано следующее: az : ERROR: az monitor: 'app-insights' is not in the 'az monitor' command group. See 'az monitor --help'.

Выполните следующую команду, чтобы создать ресурс Application Insights:

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 --resource-group demoRg --application-type web

Результаты

az monitor app-insights component create --app demoApp --location eastus --kind web --resource-group 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"
}

Полную документацию по Azure CLI для этой команды и сведения о том, как получить ключ инструментирования, см. в документации по Azure CLI.

Переопределение конечных точек по умолчанию

Предупреждение

Не изменяйте конечные точки. Перейдите на строки подключения, чтобы упростить настройку и избавиться от необходимости менять конечную точку.

Чтобы отправить данные из Application Insights в определенные регионы, необходимо переопределить адреса конечных точек по умолчанию. Каждый пакет SDK требует несколько иных изменений, и все они описаны в этой статье.

Эти изменения требуют настройки примера кода и замены значений заполнителей для QuickPulse_Endpoint_Address, TelemetryChannel_Endpoint_Addressи Profile_Query_Endpoint_address фактическими адресами конечных точек для конкретного региона. В конце этой статьи содержатся ссылки на адреса конечных точек для регионов, где требуется такая конфигурация.

Примечание

Поддержка приема ключей инструментирования будет завершена 31 марта 31, 2025 г. Функция продолжит работать, но не будет обновляться или поддерживаться. Перейдите на строки подключения, чтобы использовать новые возможности.

---

Изменения в коде SDK

.NET

Примечание

Файл applicationinsights.config автоматически перезаписывается при каждом обновлении пакета SDK. После обновления пакета SDK не забудьте повторно ввести значения конечной точки для конкретного региона.

<ApplicationInsights>
  ...
  <TelemetryModules>
    <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse.QuickPulseTelemetryModule, Microsoft.AI.PerfCounterCollector">
      <QuickPulseServiceEndpoint>Custom_QuickPulse_Endpoint_Address</QuickPulseServiceEndpoint>
    </Add>
  </TelemetryModules>
   ...
  <TelemetrySinks>
    <Add Name = "default">
      <TelemetryChannel>
         <EndpointAddress>TelemetryChannel_Endpoint_Address</EndpointAddress>
      </TelemetryChannel>
    </Add>
  </TelemetrySinks>
  ...
  <ApplicationIdProvider Type="Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId.ApplicationInsightsApplicationIdProvider, Microsoft.ApplicationInsights">
    <ProfileQueryEndpoint>Profile_Query_Endpoint_address</ProfileQueryEndpoint>
  </ApplicationIdProvider>
  ...
</ApplicationInsights>

.NET Core

Измените файл appsettings.json в проекте, чтобы настроить главную конечную точку:

"ApplicationInsights": {
    "InstrumentationKey": "instrumentationkey",
    "TelemetryChannel": {
      "EndpointAddress": "TelemetryChannel_Endpoint_Address"
    }
  }

Значения динамических метрик и конечной точки запроса профиля можно задать только с помощью кода. Чтобы переопределить значения по умолчанию для всех значений конечных точек с помощью кода, внесите следующие изменения в метод ConfigureServices файла Startup.cs:

using Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId;
using Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse; //Place at top of Startup.cs file

   services.ConfigureTelemetryModule<QuickPulseTelemetryModule>((module, o) => module.QuickPulseServiceEndpoint="QuickPulse_Endpoint_Address");

   services.AddSingleton<IApplicationIdProvider, ApplicationInsightsApplicationIdProvider>(_ => new ApplicationInsightsApplicationIdProvider() { ProfileQueryEndpoint = "Profile_Query_Endpoint_address" });

   services.AddSingleton<ITelemetryChannel>(_ => new ServerTelemetryChannel() { EndpointAddress = "TelemetryChannel_Endpoint_Address" });

    //Place in the ConfigureServices method. Place this before services.AddApplicationInsightsTelemetry("instrumentation key"); if it's present

Функции Azure

Для Функции Azure рекомендуется использовать строки подключения, заданные в параметрах приложения функции. Чтобы получить доступ к параметрам приложения для функции из области функций, выберите Параметры>Конфигурация>Параметры приложения.

Имя: APPLICATIONINSIGHTS_CONNECTION_STRING
Значение: Connection String Value

Java

Измените файл applicationinsights.xml , чтобы изменить адрес конечной точки по умолчанию:

<?xml version="1.0" encoding="utf-8"?>
<ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings">
  <InstrumentationKey>ffffeeee-dddd-cccc-bbbb-aaaa99998888</InstrumentationKey>
  <TelemetryModules>
    <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebRequestTrackingTelemetryModule"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebSessionTrackingTelemetryModule"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebUserTrackingTelemetryModule"/>
  </TelemetryModules>
  <TelemetryInitializers>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebOperationIdTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebOperationNameTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebSessionTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebUserTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebUserAgentTelemetryInitializer"/>
  </TelemetryInitializers>
  <!--Add the following Channel value to modify the Endpoint address-->
  <Channel type="com.microsoft.applicationinsights.channel.concrete.inprocess.InProcessTelemetryChannel">
  <EndpointAddress>TelemetryChannel_Endpoint_Address</EndpointAddress>
  </Channel>
</ApplicationInsights>

Spring Boot

Измените файл application.properties и добавьте:

azure.application-insights.channel.in-process.endpoint-address= TelemetryChannel_Endpoint_Address

Node.js

var appInsights = require("applicationinsights");
appInsights.setup('INSTRUMENTATION_KEY');
appInsights.defaultClient.config.endpointUrl = "TelemetryChannel_Endpoint_Address"; // ingestion
appInsights.defaultClient.config.profileQueryEndpoint = "Profile_Query_Endpoint_address"; // appid/profile lookup
appInsights.defaultClient.config.quickPulseHost = "QuickPulse_Endpoint_Address"; //live metrics
appInsights.Configuration.start();

Конечные точки можно также настроить с помощью переменных среды:

**Instrumentation Key*: "APPINSIGHTS_INSTRUMENTATIONKEY"
*Profile endpoint*: "Profile_Query_Endpoint_address"
*Live Metrics endpoint*: "QuickPulse_Endpoint_Address"

JavaScript

Текущий фрагмент кода, указанный здесь, содержит версию 5. Версия кодируется в фрагменте как sv:"#". Текущая версия также доступна на GitHub.

<script type="text/javascript">
!function(T,l,y){var S=T.location,k="script",D="instrumentationKey",C="ingestionendpoint",I="disableExceptionTracking",E="ai.device.",b="toLowerCase",w="crossOrigin",N="POST",e="appInsightsSDK",t=y.name||"appInsights";(y.name||T[e])&&(T[e]=t);var n=T[t]||function(d){var g=!1,f=!1,m={initialize:!0,queue:[],sv:"5",version:2,config:d};function v(e,t){var n={},a="Browser";return n[E+"id"]=a[b](),n[E+"type"]=a,n["ai.operation.name"]=S&&S.pathname||"_unknown_",n["ai.internal.sdkVersion"]="javascript:snippet_"+(m.sv||m.version),{time:function(){var e=new Date;function t(e){var t=""+e;return 1===t.length&&(t="0"+t),t}return e.getUTCFullYear()+"-"+t(1+e.getUTCMonth())+"-"+t(e.getUTCDate())+"T"+t(e.getUTCHours())+":"+t(e.getUTCMinutes())+":"+t(e.getUTCSeconds())+"."+((e.getUTCMilliseconds()/1e3).toFixed(3)+"").slice(2,5)+"Z"}(),iKey:e,name:"Microsoft.ApplicationInsights."+e.replace(/-/g,"")+"."+t,sampleRate:100,tags:n,data:{baseData:{ver:2}}}}var h=d.url||y.src;if(h){function a(e){var t,n,a,i,r,o,s,c,u,p,l;g=!0,m.queue=[],f||(f=!0,t=h,s=function(){var e={},t=d.connectionString;if(t)for(var n=t.split(";"),a=0;a<n.length;a++){var i=n[a].split("=");2===i.length&&(e[i[0][b]()]=i[1])}if(!e[C]){var r=e.endpointsuffix,o=r?e.location:null;e[C]="https://"+(o?o+".":"")+"dc."+(r||"services.visualstudio.com")}return e}(),c=s[D]||d[D]||"",u=s[C],p=u?u+"/v2/track":d.endpointUrl,(l=[]).push((n="SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details)",a=t,i=p,(o=(r=v(c,"Exception")).data).baseType="ExceptionData",o.baseData.exceptions=[{typeName:"SDKLoadFailed",message:n.replace(/\./g,"-"),hasFullStack:!1,stack:n+"\nSnippet failed to load ["+a+"] -- Telemetry is disabled\nHelp Link: https://go.microsoft.com/fwlink/?linkid=2128109\nHost: "+(S&&S.pathname||"_unknown_")+"\nEndpoint: "+i,parsedStack:[]}],r)),l.push(function(e,t,n,a){var i=v(c,"Message"),r=i.data;r.baseType="MessageData";var o=r.baseData;return o.message='AI (Internal): 99 message:"'+("SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details) ("+n+")").replace(/\"/g,"")+'"',o.properties={endpoint:a},i}(0,0,t,p)),function(e,t){if(JSON){var n=T.fetch;if(n&&!y.useXhr)n(t,{method:N,body:JSON.stringify(e),mode:"cors"});else if(XMLHttpRequest){var a=new XMLHttpRequest;a.open(N,t),a.setRequestHeader("Content-type","application/json"),a.send(JSON.stringify(e))}}}(l,p))}function i(e,t){f||setTimeout(function(){!t&&m.core||a()},500)}var e=function(){var n=l.createElement(k);n.src=h;var e=y[w];return!e&&""!==e||"undefined"==n[w]||(n[w]=e),n.onload=i,n.onerror=a,n.onreadystatechange=function(e,t){"loaded"!==n.readyState&&"complete"!==n.readyState||i(0,t)},n}();y.ld<0?l.getElementsByTagName("head")[0].appendChild(e):setTimeout(function(){l.getElementsByTagName(k)[0].parentNode.appendChild(e)},y.ld||0)}try{m.cookie=l.cookie}catch(p){}function t(e){for(;e.length;)!function(t){m[t]=function(){var e=arguments;g||m.queue.push(function(){m[t].apply(m,e)})}}(e.pop())}var n="track",r="TrackPage",o="TrackEvent";t([n+"Event",n+"PageView",n+"Exception",n+"Trace",n+"DependencyData",n+"Metric",n+"PageViewPerformance","start"+r,"stop"+r,"start"+o,"stop"+o,"addTelemetryInitializer","setAuthenticatedUserContext","clearAuthenticatedUserContext","flush"]),m.SeverityLevel={Verbose:0,Information:1,Warning:2,Error:3,Critical:4};var s=(d.extensionConfig||{}).ApplicationInsightsAnalytics||{};if(!0!==d[I]&&!0!==s[I]){var c="onerror";t(["_"+c]);var u=T[c];T[c]=function(e,t,n,a,i){var r=u&&u(e,t,n,a,i);return!0!==r&&m["_"+c]({message:e,url:t,lineNumber:n,columnNumber:a,error:i}),r},d.autoExceptionInstrumented=!0}return m}(y.cfg);function a(){y.onInit&&y.onInit(n)}(T[t]=n).queue&&0===n.queue.length?(n.queue.push(a),n.trackPageView({})):a()}(window,document,{
src: "https://js.monitor.azure.com/scripts/b/ai.2.min.js", // The SDK URL Source
// name: "appInsights", // Global SDK Instance name defaults to "appInsights" when not supplied.
// ld: 0, // Defines the load delay (in ms) before attempting to load the sdk. -1 = block page load and add to head (default) = 0ms load after timeout.
// useXhr: 1, // Use XHR instead of fetch to report failures (if available).
crossOrigin: "anonymous", // When supplied, this will add the provided value as the cross origin attribute on the script tag.
// onInit: null, // Once the Application Insights instance has loaded and initialized, this callback function will be called with 1 argument -- the sdk instance. (DO NOT ADD anything to the sdk.queue -- as they won't get called.)
cfg: { // Application Insights Configuration
    instrumentationKey:"INSTRUMENTATION_KEY",
    endpointUrl: "TelemetryChannel_Endpoint_Address"
}});
</script>

Примечание

Чтобы облегчить читаемость и сократить количество возможных ошибок JavaScript, все возможные параметры конфигурации перечислены на новой строке в предыдущем фрагменте кода. Если изменять значение строки с комментариями не требуется, ее можно удалить.

Python

Инструкции по изменению конечной точки приема для пакета SDK opencensus-python см. в репозитории opencensus-python.

Регионы, требующие изменения конечной точки

В настоящее время единственными регионами, в которых требуется модификация конечных точек, являются Azure для государственных организаций и Azure для Китая.

Регион	имя конечной точки;	Значение
Azure для Китая	Канал телеметрии	https://dc.applicationinsights.azure.cn/v2/track
Azure для Китая	QuickPulse (динамические метрики)	https://live.applicationinsights.azure.cn/QuickPulseService.svc
Azure для Китая	Запрос профиля	https://dc.applicationinsights.azure.cn/api/profiles/{0}/appId
Azure для государственных организаций	Канал телеметрии	https://dc.applicationinsights.us/v2/track
Azure для государственных организаций	QuickPulse (динамические метрики)	https://quickpulse.applicationinsights.us/QuickPulseService.svc
Azure для государственных организаций	Запрос профиля	https://dc.applicationinsights.us/api/profiles/{0}/appId

Если в настоящее время вы используете REST API Application Insights, доступ к которому обычно осуществляется через api.applicationinsights.io, необходимо использовать конечную точку, которая является локальной для вашего региона.

Регион	имя конечной точки;	Значение
Azure для Китая	REST API	api.applicationinsights.azure.cn
Azure для государственных организаций	REST API	api.applicationinsights.us

Дальнейшие действия

• Используйте поиск по диагностике.
• Изучите метрики.
• Написание запросов Log Analytics.
• Дополнительные сведения о пользовательских изменениях для Azure для государственных организаций см. в подробном руководстве по мониторингу и управлению Azure.
• Дополнительные сведения об Azure для Китая см. в сборнике схем Azure для Китая.