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

Обзор

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

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

Важно!

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

Совет

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

Общие сведения о сценарии

Сценарии клиентов, в которых эта особенность будет иметь наибольшее влияние:

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

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

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

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

Начало работы

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

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

Строка подключения в колонке "Обзор"

схема

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

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

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

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

Синтаксис

  • InstrumentationKey (например: 00000000-0000-0000-0000-000000000000). Строка подключения является обязательным полем.
  • 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

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

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

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

Минимальная допустимая строка подключения

InstrumentationKey=00000000-0000-0000-0000-000000000000;

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

  • По умолчанию используется схема авторизации ikey.
  • Ключ инструментирования: 00000000-0000-0000-0000-000000000000
  • Универсальные коды ресурса (URI) региональных служб основаны на стандартных значениях для SDK и позволяют подключаться к общедоступному глобальному серверу Azure:
    • Прием: https://dc.services.visualstudio.com/
    • Интерактивные метрики: https://rt.services.visualstudio.com/
    • Профилировщик: https://profiler.monitor.azure.com/
    • Отладчик: https://snapshot.monitor.azure.com/

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

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/

Как задать строку подключения

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

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

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

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

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

Примеры кода

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

Явное указание для .NET:

var configuration = new TelemetryConfiguration
{
    ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000;"
};

Файл конфигурации для .NET:

<?xml version="1.0" encoding="utf-8"?>
<ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings">
    <ConnectionString>InstrumentationKey=00000000-0000-0000-0000-000000000000</ConnectionString>
</ApplicationInsights>

Явное указание для NetCore:

public void ConfigureServices(IServiceCollection services)
{
    var options = new ApplicationInsightsServiceOptions { ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000;" };
    services.AddApplicationInsightsTelemetry(options: options);
}

Файл config.json для NetCore:

{
  "ApplicationInsights": {
    "ConnectionString" : "InstrumentationKey=00000000-0000-0000-0000-000000000000;"
    }
  }

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

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

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