spring boot opentelemetry

彈簧啟動OpentElemetry

指標

Spring Boot執行器為千分尺提供了依賴性管理和自動配置，該級別為許多不同的監視系統提供了方便的外觀。其中之一是Opentelemetry。

Spring Boot Developers可以通過添加Spring Boot執行器和專用的OpentElemetry依賴性從微米到他們的項目來使其應用程序通過OTLP協議通過OTLP協議導出指標。

dependencies {
    implementation ' org.springframework.boot:spring-boot-starter-actuator '
    runtimeOnly ' io.micrometer:micrometer-registry-otlp '
    .. .
}

千分尺註冊表提供的出口商OTLP是HTTP出口商，可以通過屬性配置，這要歸功於OpentElemetry的自動配置。

 management :
  otlp :
    metrics :
      export :
        url : http://localhost:4318/v1/metrics
        step : 5s

OpentElemetry支持將包含在遙測數據中的其他密鑰/值對（稱為resource attributes ）。 Spring Boot執行器為它們提供自動配置，並可以通過屬性添加新的資源屬性。

 management :
  opentelemetry :
    resource-attributes :
      cluster : local
      " service.name " : ${spring.application.name}

我做了一個演示應用程序來展示此設置。

問題：OTLP指標出口商不可通過OpenTelemetry配置

千分尺註冊表OTLP模塊使用與OTLP兼容的HTTP客戶端將指標導出到OpenTElemetry後端。在內部， OtlpMeterRegistry使用私有HttpSender對象來配置HTTP客戶端。這種方法的好處是，該模塊是輕量級的，並且不需要對OpenTelemetry SDK的任何依賴性。它僅使用io.opentelemetry.proto庫，該庫為OpentElemetry提供了ProtoBuf配置。

另一方面，這種方法意味著：

• 不可能通過標準的OpenTelemetry配置配置指標出口商；
• 不可能配置壓縮；
• 在指標和跟踪之間，不可能在彈簧引導中共享OpenTelemetry的配置。

Spring Boot 3.2 AutoConconfiguration中新的通用OpenTelemetryAutoConfiguration使用OpenTelemetry bean，並使配置SdkMeterProvider Bean成為可能。如果千分尺可以將其用於設置OpenTelemetry指標出口商怎麼辦？

可能的解決方案：

• 更新現有的千分尺註冊表OTLP模塊以實現接受OpenTelemetry對象進行配置的MeterRegistry （類似於OpentElemetry Java Instrumentation庫中使用的OpenTelemetryMeterRegistry ）。如果需要向後兼容性，則新實現將需要與現有的實現共存（也許功能標誌可以在兩者之間切換？）；
• 創建一個新的千分尺註冊表OpenTelemetry模塊，以實現上幾點中描述的內容，但沒有向後兼容的問題。

我已經向縮影項目提交了一個問題，並分享了這些建議。建築物（或更新）這樣的模塊可以重新使用Spring Boot 3.2中引入的相同的OpenTelemetryAutoConfiguration ，用於指標和痕跡（以及將來的日誌）。

• Spring Boot項目已經存在一個問題，可以自動配置SdkMeterProvider Bean，並且通常將指標與OpenTElemetry一起使用。但是，在此之前，我們缺少千分尺的支撐。
• 它還可以使用標準的OpenTelemetry方法在HTTP和GRPC之間切換客戶端實現（即配置OtlpHttpMetricExporter或OtlpGrpcMetricExporter ）。
• 最後，這將使使用千分尺與OpenTelemetry Java代理或通常的OpenTelemetry Java儀器一起使用千分尺的開發人員更容易。這些項目目前在千分尺和opentelemetry之間保持墊片。那墊片可能不再需要了。因此，這樣的變化還可以減少維持與千分尺兼容的OpenTelemetry Java儀器的工作量。

有關當前挑戰的更多背景，請參閱Spring Boot項目上的此問題。

跡線

Spring Boot執行器為千分尺跟踪提供了依賴性管理和自動配置，可在幾個不同的分佈式跟踪後端提供方便的外牆。其中之一是Opentelemetry。

Spring Boot開發人員可以通過添加Spring Boot執行器，千分尺跟踪和專用的OpentElemetry依賴性從千分尺添加Spring Boot執行器，從而使其應用程序通過OTLP協議通過OTLP協議將其導出到OpenTelemetry後端。

dependencies {
    implementation ' org.springframework.boot:spring-boot-starter-actuator '
    implementation ' io.micrometer:micrometer-tracing-bridge-otel '
    implementation ' io.opentelemetry:opentelemetry-exporter-otlp '
    .. .
}

Spring Boot執行器自動配置提供的出口商是HTTP Exporter（ OtlpHttpSpanExporter BEAN），並且可以通過屬性配置，這要歸功於OtlpAutoConfiguration中的跟踪配置。

 management :
  otlp :
    tracing :
      endpoint : http://localhost:4318/v1/traces

OpentElemetry支持將包含在遙測數據中的其他密鑰/值對（稱為resource attributes ）。 Spring Boot執行器為它們提供自動配置，並可以通過屬性添加新的資源屬性。標準的OpenTelemetry service.name資源屬性自動配置為spring.application.name （如果定義）或默認application值的值。

 management :
  opentelemetry :
    resource-attributes :
      cluster : local

我做了一個演示應用程序來展示此設置。

通過GRPC出口軌蹟的問題

在Spring Boot項目上的此問題中，已經添加了OtlpHttpSpanExporter bean的自動配置，通過HTTP導出痕跡。

一個常見的要求是通過GRPC（Opentelemetry中最常用的方法）導出軌跡。當前，開發人員可以自己配置OtlpGrpcSpanExporter BEAN。如果Spring Boot執行器為此提供自動配置，從而增強現有的OtlpAutoConfiguration那將是很好的。

Spring Boot項目已經有一個問題來添加這種自動配置。

概括

總體而言，這些是我到目前為止一直在描述的問題和建議。

最小的提議更改以合併春季的Opentelemetry支持指標和痕跡

千分尺

• 介紹基於OpenTelemetry的MeterRegistry實現，並通過其標準方法進行配置，以便可以在指標和痕蹟之間共享配置。

春季啟動執行器

• 引入用於OpentElemetry指標的自動配置。可以從現有的OpenTelemetry配置中重複使用OpenTelemetry和Resource Bean。除此之外，自動配置還應定義SdkMeterProvider ， OtlpHttpMetricExporter和OtlpGrpcMetricExporter的默認值。
• 通過定義OtlpGrpcSpanExporter BEAN引入通過GRPC導出OpenTelemetry Trace的自動配置。
• 合併跨指標和痕蹟的OpenTelemetry自動配置類。現有的OpentElemetryautoconfiguration可用於共享配置。除此之外，還需要專用的自動配置類來為每種遙測類型的特定出口商配置特定的出口商。痕跡在Otlpautoconfiguration中已經具有。

春季初始化

• 經歷了所有先前的更改後，它應該變得直接地添加opentelemetry選項到彈簧初始化。立即將其添加到當前狀態，考慮到指標和痕蹟之間配置OpenTelemtry的不同方式，可能會使事情變得混亂。

其他更改以擴展彈簧中的OpenTelemetry支持到日誌

春季啟動執行器

• 引入opentelemetry日誌的自動配置。可以從現有的OpenTelemetry配置中重複使用OpenTelemetry和Resource Bean。除此之外，自動配置還應定義SdkLoggerProvider ， OtlpHttpLogRecordExporter和OtlpGrpcLogRecordExporter的默認值。
• 添加對logBack（默認）和log4j2的支持。為了獲得靈感，OpentElemetry Java儀器為logback和log4j2提供了附錄。
• 春季啟動項目可能存在相關問題。

進一步的改進

• 已經打開了一個問題，以調查如何限制跟踪OpenTelemetryAutoConfiguration中當前可用的可配置bean的數量（一旦刪除了跟踪特定的特定者，就可以考慮使用全局OpenTelemetryAutoConfiguration ）。