Строки подключения

В этой статье описано использование строк подключения.

Обзор

Примечание.

В следующей документации используется классический API приложения Аналитика. Долгосрочный план приложения Аналитика заключается в сборе данных с помощью OpenTelemetry. Дополнительные сведения см. в разделе "Включить Azure Monitor OpenTelemetry" для приложений .NET, Node.js, Python и Java.

Строки подключения определяют, куда именно отправляются данные телеметрии.

Пары "ключ — значение" предоставляют пользователям простой способ определения сочетания префикса и суффикса для каждой службы или продукта Application Insights.

Примечание.

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

Обзор сценария

Сценарии, на которые сильнее всего влияет это изменение:

• Исключения брандмауэра или перенаправления прокси-сервера:

  В случаях, когда требуется мониторинг веб-сервера интрасети, наше предыдущее решение предлагало добавить отдельные конечные точки службы в конфигурацию. Дополнительные сведения см. в разделе " Можно ли отслеживать веб-сервер интрасети?". Строки подключения предлагают лучшую альтернативу, так как настраивать нужно один параметр. Простое изменение префикса и суффикса позволяет автоматически заполнять и перенаправлять все конечные точки в нужные службы.

• Национальные или гибридные облачные среды:

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

Начать

Чтобы начать работу, просмотрите следующие разделы.

Получение строки подключения

Строка подключения отображается в разделе Обзор для ресурса Application Insights.

Схема

В следующих разделах описываются элементы схемы.

Максимальная длина

Максимальная поддерживаемая длина строки подключения составляет 4096 символов.

Пары "ключ-значение"

Строка подключения состоит из списка параметров, представленных в виде разделенных точкой с запятой пар "ключ — значение": key1=value1;key2=value2;key3=value3.

Синтаксис

• InstrumentationKey (например, 00000000-0000-0000-0000-000000000000). InstrumentationKeyявляется обязательным полем.
• Authorization (например, ikey). Этот параметр является необязательным, так как на сегодняшний день поддерживается только авторизация ikey.
• EndpointSuffix (например, applicationinsights.azure.cn). Установка суффикса конечной точки сообщает пакету SDK, к которому нужно подключиться в облаке Azure. Пакет SDK собирает остальную часть конечной точки для отдельных служб.
• Явные конечные точки. Любая служба может быть явно переопределена в строка подключения:
  • IngestionEndpoint (например, https://dc.applicationinsights.azure.com)
  • LiveEndpoint (например, https://live.applicationinsights.azure.com)
  • ProfilerEndpoint (например, https://profiler.monitor.azure.com)
  • SnapshotEndpoint (например, https://snapshot.monitor.azure.com)

Схема конечной точки

<prefix>.<suffix>

• Префикс определяет службу.
• Суффикс определяет общее доменное имя.

Допустимые суффиксы

• applicationinsights.azure.cn
• applicationinsights.us

Дополнительные сведения см. в разделе Регионы, требующие изменения конечных точек.

Допустимые префиксы

• Прием данных телеметрии: dc
• Интерактивные метрики: live
• Профилировщик: profiler
• Моментальный снимок: snapshot

Является ли строка подключения секретом?

Строка подключения содержит идентификатор ikey. Это уникальный идентификатор, используемый службой приема данных для связывания данных телеметрии с определенным ресурсом Application Insights. Эти уникальные идентификаторы ikey не являются маркерами безопасности или ключами безопасности. Если вы хотите защитить ресурс искусственного интеллекта от неправильного использования, конечная точка приема предоставляет проверенные параметры приема данных телеметрии на основе идентификатора Microsoft Entra.

Примечание.

Пакет SDK JavaScript для Application Insights требует передавать строку подключения во время инициализации и настройки. Ее можно просмотреть в виде обычного текста в клиентских браузерах. Нет простого способа использовать проверку подлинности на основе идентификатора Microsoft Entra для телеметрии браузера. Рекомендуется создать отдельный ресурс Application Insights для данных телеметрии браузера, если вам необходимо защитить данные телеметрии службы.

Примеры строк подключения

Далее приведены примеры строк подключения.

Строка подключения с суффиксом конечной точки

InstrumentationKey=00000000-0000-0000-0000-000000000000;EndpointSuffix=ai.contoso.com;

В этом примере строка подключения указывает суффикс конечной точки, а пакет SDK создает конечные точки службы:

• По умолчанию используется схема авторизации ikey.
• Ключ инструментирования: 00000000-0000-0000-0000-000000000000
• URI региональной службы основаны на суффиксе предоставленной конечной точки:
  • Прием: https://dc.ai.contoso.com
  • Интерактивные метрики: https://live.ai.contoso.com
  • Профилировщик: https://profiler.ai.contoso.com
  • Отладчик: https://snapshot.ai.contoso.com

Строки подключения с явно заданными переопределениями конечных точек

InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://custom.com:111/;LiveEndpoint=https://custom.com:222/;ProfilerEndpoint=https://custom.com:333/;SnapshotEndpoint=https://custom.com:444/;

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

• По умолчанию используется схема авторизации ikey.
• Ключ инструментирования: 00000000-0000-0000-0000-000000000000
• URI региональной службы основаны на явных переопределенных значениях:
  • Прием: https://custom.com:111/
  • Интерактивные метрики: https://custom.com:222/
  • Профилировщик: https://custom.com:333/
  • Отладчик: https://custom.com:444/

Строки подключения с явно заданным регионом

InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://southcentralus.in.applicationinsights.azure.com/

В этом примере строка подключения указывает регион центрально-южной части США:

• По умолчанию используется схема авторизации ikey.
• Ключ инструментирования: 00000000-0000-0000-0000-000000000000
• URI региональной службы основаны на явных переопределенных значениях:
  • Прием: https://southcentralus.in.applicationinsights.azure.com/

Выполните следующую команду в Azure CLI, чтобы получить список доступных регионов:

az account list-locations -o table

Задание строки подключения

Строки подключения поддерживаются в следующих версиях пакетов SDK:

• .NET версии 2.12.0
• для Java версий 2.5.1 и 3.0;
• для JavaScript версии 2.3.0;
• для NodeJS версии 1.5.0;
• для Python версии 1.0.0.

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

Переменная среды

Строка подключения: APPLICATIONINSIGHTS_CONNECTION_STRING

Примеры кода

.NET 5.0+

1. Задайте строка подключения в appsettings.json файле:

   {
     "ApplicationInsights": {
       "ConnectionString" : "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://{region}.in.applicationinsights.azure.com/;LiveEndpoint=https://{region}.livediagnostics.monitor.azure.com/"
       }
   }
   

2. Получите строка подключения при Program.cs регистрации ApplicationInsightsTelemetry службы:

   var options = new ApplicationInsightsServiceOptions { ConnectionString = app.Configuration["ApplicationInsights:ConnectionString"] };
   builder.Services.AddApplicationInsightsTelemetry(options: options);
   

.NET Framework

Задайте свойство TelemetryConfiguration.ConnectionString или ApplicationInsightsServiceOptions.ConnectionString.

Явно задайте строка подключения в коде:

var configuration = new TelemetryConfiguration
{
    ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://{region}.in.applicationinsights.azure.com/;LiveEndpoint=https://{region}.livediagnostics.monitor.azure.com/"
};

Задайте строка подключения с помощью файла конфигурации:

<?xml version="1.0" encoding="utf-8"?>
<ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings">
    <ConnectionString>InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://{region}.in.applicationinsights.azure.com/;LiveEndpoint=https://{region}.livediagnostics.monitor.azure.com/</ConnectionString>
</ApplicationInsights>

Java

Строку подключения можно задать в файле конфигурации applicationinsights.json:

{
  "connectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://{region}.in.applicationinsights.azure.com/;LiveEndpoint=https://{region}.livediagnostics.monitor.azure.com/"
}

Дополнительные сведения см. в разделе Конфигурация строки подключения.

JavaScript

JavaScript не поддерживает использование переменных среды. В этом случае у вас есть два варианта.

• Сведения об использовании скрипта загрузчика пакета SDK для JavaScript (Web) см. в скрипте загрузчика пакета SDK JavaScript (Web).
• Настройка вручную:

  import { ApplicationInsights } from '@microsoft/applicationinsights-web'
  
  const appInsights = new ApplicationInsights({ config: {
     connectionString: 'InstrumentationKey=00000000-0000-0000-0000-000000000000;'
     /* ...Other Configuration Options... */
  } });
  appInsights.loadAppInsights();
  appInsights.trackPageView();
  

Node.js

const appInsights = require("applicationinsights");
appInsights.setup("InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://{region}.in.applicationinsights.azure.com/;LiveEndpoint=https://{region}.livediagnostics.monitor.azure.com/");
appInsights.start();

Python

Пользователям рекомендуется использовать переменную среды.

Чтобы указать строку подключения явным образом, выполните:

from opencensus.ext.azure.trace_exporter import AzureExporter
from opencensus.trace.samplers import ProbabilitySampler
from opencensus.trace.tracer import Tracer

tracer = Tracer(exporter=AzureExporter(connection_string='InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://{region}.in.applicationinsights.azure.com/;LiveEndpoint=https://{region}.livediagnostics.monitor.azure.com/'), sampler=ProbabilitySampler(1.0))

Часто задаваемые вопросы

В этом разделы приводятся ответы на часто задаваемые вопросы.

Требуется ли использовать строки подключения для новых регионов Azure?

Новые регионы Azure требуют использования строк подключения вместо ключей инструментирования. строка Подключение ion определяет ресурс, который требуется связать с данными телеметрии. Он также позволяет изменять конечные точки, которые ресурс использует в качестве назначения для телеметрии. Скопируйте строка подключения и добавьте его в код приложения или в переменную среды.

Следует ли использовать строки подключения или ключи инструментирования?

Рекомендуется использовать строка подключения вместо ключей инструментирования.

Следующие шаги

Приступите к работе во время выполнения с помощью:

• Приложения, размещенные в IIS на виртуальной машине Azure или в масштабируемом наборе виртуальных машин Azure
• сервера IIS;
• функция веб-приложения службы приложение Azure

Приступите к работе во время разработки с помощью:

• ASP.NET
• ASP.NET Core
• Java
• Node.js
• Python