Автоматический экспорт диапазонов Spring Cloud Sleuth с использованием клиентской библиотеки Azure Monitor OpenTelemetry Exporter для Java

Я пытаюсь использовать клиентская библиотека Azure Monitor OpenTelemetry Exporter для Java для экспорта всех трассировок / диапазонов из Spring Cloud Sleuth в Azure Monitor. Эта интеграция, похоже, работает только с новейшей версией Spring Cloud Sleuth после недавних обновлений версии зависимостей.

Однако вместо того, чтобы использовать azureMonitorExporter.export(spanData) вручную, я хотел бы автоматически экспортировать все трассы / промежутки для всего приложения, просто добавив конфигурацию для экспортера Azure. Затем это можно легко добавить в новый проект.

У меня нет большого опыта использования Spring / Sleuth / OpenTelemetry, но AzureMonitorExporter реализует SpanExporter, поэтому я подумал, что одним из вариантов может быть создание класса конфигурации, который содержит следующее.

@Bean
public SpanExporter exporter() {
    return new AzureMonitorExporterBuilder()
        .instrumentationKey("{KEY}")
        .buildExporter();
};

И затем его можно было бы использовать в основном классе, используя:

@Autowired
SpanExporter exporter;

Однако я не уверен, правильный ли это путь или как продолжить с этого момента, чтобы фактически заставить экспортера начать автоматически экспортировать трассировки / промежутки в монитор Azure.

Мой pom.xml выглядит так:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.2-SNAPSHOT</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>trace-demo-5-updated</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>trace-demo-5-updated</name>
<description>Demo project for Spring Boot</description>

<properties>
    <java.version>11</java.version>
    <spring-cloud.version>2020.0.0-SNAPSHOT</spring-cloud.version>
</properties>

<dependencies>
    <!-- Sleuth with Brave tracer implementation -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-sleuth</artifactId>

    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    
    <dependency>
      <groupId>com.azure</groupId>
      <artifactId>opentelemetry-exporters-azuremonitor</artifactId>
      <version>1.0.0-beta.1</version>
    </dependency>
    
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web-services</artifactId>
    </dependency>
    
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-sleuth-otel</artifactId>
        <version>3.0.0-M6</version>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring-cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
    </repository>
    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/snapshot</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>
<pluginRepositories>
    <pluginRepository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
    </pluginRepository>
    <pluginRepository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/snapshot</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </pluginRepository>
</pluginRepositories>

person Storm    schedule 22.12.2020    source источник


Ответы (1)


Обновление (2020-01-26):

С сегодняшним выпуском Spring Cloud Sleuth OTel (spring-cloud-sleuth-otel:1.0.0-M3) и обновить в Azure SDK исходная проблема должна исчезнуть.

Оригинальный ответ

(TL; DR: последний абзац)

Руководство по миграции Sleuth 3.0 может вам очень помочь. Sleuth поддерживает две системы отслеживания: Brave (по умолчанию) и OpenTelemetry (инкубатор).

Чтобы использовать OpenTelemetry, вам нужно удалить Brave (просто исключить spring-cloud-sleuth-brave) и добавить OpenTelemetry (spring-cloud-sleuth-otel-autoconfigure с spring-cloud-sleuth-otel-dependencies). См. Документы, которые я связал.

После этого нужно использовать свой SpanExporter. Вот созданный мной pom.xml на основе твоего. Кстати, добавление образца проекта (например: в репозиторий GitHub) может очень помочь всем, кто пытается помочь, так что им не нужно создавать его самим.

К сожалению, это все равно не сработает, вы все равно столкнетесь с этим исключением при запуске:
Caused by: java.lang.ClassNotFoundException: io.opentelemetry.common.AttributeValue

Это связано с тем, что экспортеры opentelemetry -azuremonitor: 1.0.0-beta.1 зависит от OpenTelemetry 0.8.0, а последняя версия spring-cloud-sleuth-otel (1.0.0-M2, мы выпустили его сегодня) использует последнюю версию OpenTelemetry (0.13.1). Кроме того, OpenTelemetry внесла критические изменения между второстепенными версиями, например: класс AttributeValue был удален в OpenTelemetry 0.9.1.

Sleuth поддерживает OpenTelemetry, начиная с Sleuth 3.0.0-M5, тогда версия OpenTelemetry была 0.10, поэтому нет доступной версии Sleuth, которая поддерживала бы версию OpenTelemetry, столь же старую, как opentelemetry-exporters-azuremonitor:1.0.0-beta.1.

Таким образом, решение будет заключаться в том, чтобы ваши pom.xml и opentelemetry-exporters-azuremonitor поддерживали последнюю версию OpenTelemetry.

person Jonatan Ivanov    schedule 22.12.2020
comment
Спасибо за ваш ответ! Я просто хотел бы прояснить некоторые моменты, прежде чем принимать ответ. Использованный мной pom.xml не выдавал никаких ошибок, но он также не работал, потому что на самом деле пытался использовать Brave? И теперь я ничего не могу сделать, пока opentelemetry-exporters-azuremonitor не будет поддерживать последнюю версию OpenTelemetry? - person Storm; 07.01.2021
comment
1. Да, maven смог разрешить зависимости (без ошибок), а Sleuth по умолчанию использовал Brave. Вам нужно удалить Brave и добавить Otel. 2. Вы можете открыть для них вопрос и запросить обновление, вот pom.xml, я думаю, вы можете открыть проблему в этом репо. - person Jonatan Ivanov; 07.01.2021
comment
Принял ответ и создал запрос функции github.com/Azure/azure-sdk -for-java / issues / 18512 - person Storm; 08.01.2021
comment
@Storm MS обновила OTel в Azure SDK, я также обновил и выпустил Sleuth OTel 1.0.0-M3 (см. Обновленный ответ). - person Jonatan Ivanov; 27.01.2021