Использование Azure Monitor Application Insights с Spring Boot

Существует два варианта включения Java Application Insights с помощью Spring Boot: аргумента виртуальной машины Java (JVM) и программно.

Активация с использованием аргумента JVM

Добавьте аргумент виртуальной машины Java -javaagent:"path/to/applicationinsights-agent-3.7.1.jar" в какое-то место перед -jar, например:

java -javaagent:"path/to/applicationinsights-agent-3.7.1.jar" -jar <myapp.jar>

Spring Boot через точку входа Docker

См. документацию, связанную с контейнерами.

Настройка

См. параметры конфигурации.

Включение программным способом

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

<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>applicationinsights-runtime-attach</artifactId>
    <version>3.7.1</version>
</dependency>

И вызовите attach() метод com.microsoft.applicationinsights.attach.ApplicationInsights класса, который находится в начале строки main() метода.

Пример:

@SpringBootApplication
public class SpringBootApp {

  public static void main(String[] args) {
    ApplicationInsights.attach();
    SpringApplication.run(SpringBootApp.class, args);
  }
}

Настройка

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

Расположение файла конфигурации

По умолчанию при включении Application Insights Java программным способом файл applicationinsights.json конфигурации считывается из классаpath (src/main/resources, src/test/resources).

В версии 3.4.3 можно настроить имя JSON-файла в пути класса с помощью системного applicationinsights.runtime-attach.configuration.classpath.file свойства. Например, в -Dapplicationinsights.runtime-attach.configuration.classpath.file=applicationinsights-dev.json Application Insights для настройки используется файл applicationinsights-dev.json. Чтобы программно настроить другой файл в classpath, выполните следующие действия.

public static void main(String[] args) {
    System.setProperty("applicationinsights.runtime-attach.configuration.classpath.file", "applicationinsights-dev.json");
    ApplicationInsights.attach();
    SpringApplication.run(PetClinicApplication.class, args);
}

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

Чтобы программно настроить файл за пределами classpath, выполните следующие действия.

public static void main(String[] args) {
    System.setProperty("applicationinsights.configuration.file", "{path}/applicationinsights-dev.json");
    ApplicationInsights.attach();
    SpringApplication.run(PetClinicApplication.class, args);
}

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

Сначала добавьте applicationinsights-core зависимость:

<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>applicationinsights-core</artifactId>
    <version>3.7.1</version>
</dependency>

Затем вызовите ConnectionString.configure метод после ApplicationInsights.attach():

public static void main(String[] args) {
    ApplicationInsights.attach();
    ConnectionString.configure("<Your Connection String>");
    SpringApplication.run(PetClinicApplication.class, args);
}

Кроме того, вызовите ConnectionString.configure метод из компонента Spring.

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

{
  "connectionStringConfiguredAtRuntime": true
}

Расположение файла журнала самостоятельной диагностики

По умолчанию при включении Java Application Insights файл, содержащий журналы агента, applicationinsights.log находится в каталоге, из которого запускается JVM (каталог пользователя).

Чтобы узнать, как изменить это расположение, ознакомьтесь с параметрами конфигурации самостоятельной диагностики.