spring boot opentelemetry

Spring Boot Opentelemetry

メトリック

Spring Boot Actuatorは、マイクロメートルの依存関係管理とオートコンテンションを提供します。これは、さまざまな監視システムにわたって便利なファサードを提供します。それらの1つはOpentelemetryです。

Spring Boot Developersは、Spring Boot Actuatorとマイクロメートルからプロジェクトまでの専用オペンテレメトリー依存性を追加することにより、OTLPプロトコルを介してOTLPプロトコルを介してメトリックをエクスポートできるようにすることができます。

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

Micromer Registry OTLPが提供する輸出業者はHTTP輸出業者であり、オペンテレメトリー用のAutoconfigurationのおかげでプロパティを介して構成できます。

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

Opentelemetryは、テレメトリデータに含まれる追加のキー/値ペア（ resource attributesと呼ばれる）をサポートします。 Spring Boot Actuatorは、それらにAutoconfigurationを提供し、プロパティを介して新しいリソース属性を追加することを可能にします。

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

このセットアップを紹介するためにデモアプリケーションを作成しました。

問題：OTLP Metrics Exporterは、Opentelemetryを介して構成できません

Micromer Registry OTLPモジュールは、OTLP互換のHTTPクライアントを使用して、メトリックをOpentelemetryバックエンドにエクスポートします。内部的には、 OtlpMeterRegistryプライベートHttpSenderオブジェクトを使用してHTTPクライアントを構成します。このアプローチの利点は、モジュールが軽量であり、Opentelemetry SDKに依存する必要がないことです。 io.opentelemetry.protoライブラリのみを使用します。これは、OpentelemetryにProtobuf構成を提供します。

一方、そのようなアプローチは、次のことを意味します。

• 標準のオペンテレメトリー構成を介してメトリックエクスポートを構成することはできません。
• 圧縮を構成することはできません。
• メトリックとトレースの間でSpring BootでOpentelemetryの構成を共有することはできません。

Spring Boot 3.2の新しいジェネリックOpenTelemetryAutoConfigurationは、 OpenTelemetry BeanをAutoconfigsureで構成し、 SdkMeterProvider Beanを構成することを可能にします。マイクロメーターがそれを使用してOpentelemetry Metrics Exporterをセットアップできる場合はどうなりますか？

可能な解決策：

• 既存のマイクロメーターレジストリOTLPモジュールを更新して、構成のOpenTelemetryオブジェクトを受け入れるMeterRegistryを実装します（Opentelemetry Java Instrumentation Libraryで使用されるOpenTelemetryMeterRegistryと同様）。後方互換性が必要な場合、新しい実装は既存の実装と共存する必要があります（機能フラグは2つを切り替えることができますか？）。
• 新しいマイクロメーターレジストリOpentelemetryモジュールを作成して、前のポイントで説明したものを実装しますが、後方互換性の問題はありません。

私は問題をMicrometerプロジェクトに提出し、これらの提案を共有しました。このようなモジュールの構築（または更新）により、メトリックとトレースの両方でSpring Boot 3.2に導入された同じOpenTelemetryAutoConfigurationを再利用できるようになります（および将来、ログについても）。

• Spring Bootプロジェクトには、 SdkMeterProvider BeanをAutoconfigureと、一般的にはOpentelemetryを使用してメトリックを使用するための問題がすでに存在しています。しかし、それが実行可能になる前にマイクロメーターのサポートが欠けています。
• また、標準のOpenteleMetryアプローチを使用して、HTTPとGRPCの間のクライアント実装を切り替えることができます（つまり、 OtlpHttpMetricExporterまたはOtlpGrpcMetricExporterいずれかを構成します）。
• 最後に、オペンテレメトリーJavaエージェント、または一般的にOpentelemetry Javaインストゥルメンテーションとともに、アプリケーションでマイクロメーターを使用する開発者が開発者を容易にします。これらのプロジェクトは現在、マイクロメーターとオペンテレメトリーの間のシムを維持しています。そのシムはおそらくもう必要ないでしょう。したがって、このような変更は、マイクロメーターと互換性のあるOpentelemetry Javaインストゥルメンテーションを維持する際のワークロードを減らすことになります。

現在の課題に関するより多くのコンテキストについては、Spring Boot Projectのこの問題を参照してください。

痕跡

Spring Boot Actuatorは、マイクロメートルトレースの依存関係管理と自動構成を提供します。これは、いくつかの異なる分散トレースバックエンドにわたって便利なファサードを提供します。それらの1つはOpentelemetryです。

Spring Boot Developersは、Spring Boot Actuator、Micrometer Tracing、およびMicrometerからMicrometerからプロジェクトへの専用のオペンテレメトリー依存性を追加することにより、OTLPプロトコルを介してOTLPプロトコルを介してトレースをエクスポートできるようにすることができます。

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

Spring Boot Actuator Autoconfigurationが提供する輸出業者は、HTTP Exporter（ OtlpHttpSpanExporter Bean）であり、 OtlpAutoConfigurationのトレース構成のおかげでプロパティを介して構成できます。

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

Opentelemetryは、テレメトリデータに含まれる追加のキー/値ペア（ resource attributesと呼ばれる）をサポートします。 Spring Boot Actuatorは、それらにAutoconfigurationを提供し、プロパティを介して新しいリソース属性を追加することを可能にします。標準のOpenteleMetry service.nameリソース属性はapplication spring.application.name （定義されている場合）の値に自動的に構成されます。

 management :
  opentelemetry :
    resource-attributes :
      cluster : local

このセットアップを紹介するためにデモアプリケーションを作成しました。

GRPCを介してトレースのエクスポートを発行します

Spring Boot Projectのこの号では、 OtlpHttpSpanExporter BeanのAutoconfigurationがHTTPを介してトレースをエクスポートするために追加されました。

一般的な要件は、GRPC（Opentelemetryで最も使用されるアプローチ）を介してトレースをエクスポートすることです。現在、開発者はOtlpGrpcSpanExporter Beanを自分で構成できます。 Spring Boot Actuatorがそのために自動構成を提供し、既存のOtlpAutoConfiguration強化するといいでしょう。

Spring Boot Projectには、このような自動構成を追加する問題がすでにあります。

まとめ

全体として、これらは私がこれまでに説明してきた問題と提案です。

メトリックとトレースのために、春のオペンテレメトリーサポートを統合するための最小限の変更された変更

マイクロメーター

• メトリックとトレース間で構成を共有できるように、標準アプローチを介してOpentelemetryの上に構築され、構成可能なMeterRegistry実装を紹介します。

スプリングブートアクチュエータ

• OpentelemetryメトリックのAutoconfigurationを紹介します。 OpenTelemetryとResource Beansは、既存のOpentelemetry構成から再利用できます。それに加えて、autoconfigurationは、 SdkMeterProvider 、 OtlpHttpMetricExporter 、 OtlpGrpcMetricExporterのデフォルトを定義する必要があります。
• OtlpGrpcSpanExporter BEANを定義することにより、GRPCを介してOpentelemetryトレースをエクスポートするためのオートコンチュレーションを導入します。
• メトリックとトレースにわたって、オペンテレメトリーオートコンチュレーションクラスを統合します。既存のOpenTeleMetryAutoconfigurationは、共有構成に使用できます。それに加えて、各タイプのテレメトリに特定の輸出業者を構成するには、専用のオートコンチュレーションクラスが必要です。トレースには、すでにotlpautoconfigurationにあります。

Spring Intializr

• 以前のすべての変更を行った後、Spring IntializrにOpenTelemetryオプションを簡単に追加するようになります。現在の状況でこれを追加すると、メトリックとトレースの間にOpenteLemtryを構成するさまざまな方法を考慮して、物事が混乱する可能性があります。

春にログにオペンテレメトリーサポートを拡張するための追加の変更

スプリングブートアクチュエータ

• OpentelemetryログのAutoconfigurationを紹介します。 OpenTelemetryとResource Beansは、既存のOpentelemetry構成から再利用できます。それに加えて、autoconfigurationは、 SdkLoggerProvider 、 OtlpHttpLogRecordExporter 、 OtlpGrpcLogRecordExporterのデフォルトを定義する必要があります。
• ログバック（デフォルト）とlog4j2のサポートを追加します。インスピレーションのために、Opentelemetry Java Instrumentationは、LogBackとLog4J2の付録を提供します。
• Spring Boot Projectのおそらく関連する問題。

さらなる改善

• トレースOpenTelemetryAutoConfigurationで現在利用可能な構成可能な豆の数を制限する方法を調査するために問題が開かれました（この問題は、トレース固有のものが削除されると、グローバルなOpenTelemetryAutoConfigurationについて考慮される可能性があります）。