spring boot opentelemetry

Spring Boot Opentelemetry

Metriken

Spring Boot Actuator bietet ein Abhängigkeitsmanagement und eine Autokonfiguration für Micrometer, die eine bequeme Fassade über viele verschiedene Überwachungssysteme bietet. Einer von ihnen ist Opentelemetrie.

Spring -Boot -Entwickler können ihre Anwendungen ermöglichen, Metriken über das OTLP -Protokoll in ein OpenTelemetry -Backend zu exportieren, indem Spring -Boot -Aktuator und die dedizierte OpenTelemetry -Abhängigkeit vom Mikrometer zu ihren Projekten hinzugefügt werden.

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

Der vom Micrometer Registry OTLP bereitgestellte Exporteur ist ein HTTP -Exporteur und kann dank der Autokonfiguration für Opentelemetrie über Eigenschaften konfiguriert werden.

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

OpenTelemetry unterstützt zusätzliche Schlüssel-/Wertpaare (als resource attributes ), die in die Telemetriedaten aufgenommen werden. Spring Boot Actuator bietet für diese eine Autokonfiguration und ermöglicht es, neue Ressourcenattribute über Eigenschaften hinzuzufügen.

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

Ich habe eine Demo -Bewerbung gestellt, um dieses Setup zu präsentieren.

Problem: OTLP -Metrikenexporteur ist nicht über Opentelemetrie konfigurierbar

Das OTLP-Modul von Micrometer Registry verwendet einen OTLP-kompatiblen HTTP-Client, um Metriken in ein OpenTelemetry-Backend zu exportieren. Intern verwendet die OtlpMeterRegistry ein privates HttpSender -Objekt, um den HTTP -Client zu konfigurieren. Der Vorteil dieses Ansatzes besteht darin, dass das Modul leicht ist und keine Abhängigkeit von der Opentelemetrie -SDK benötigt. Es verwendet nur die Bibliothek io.opentelemetry.proto , die die Protobuf -Konfiguration für Opentelemetry bietet.

Andererseits bedeutet ein solcher Ansatz::

• Es ist nicht möglich, den Metrikenexporteur über Standard -OpenTelemetry -Konfiguration zu konfigurieren.
• Es ist nicht möglich, die Komprimierung zu konfigurieren.
• Es ist nicht möglich, die Opentelemetrie -Konfiguration im Federschuh zwischen Metriken und Spuren zu teilen.

Die neue generische OpenTelemetryAutoConfiguration in Spring Boot 3.2 kann eine OpenTelemetry -Bohne automatisch vorstellt und es ermöglicht, eine SdkMeterProvider -Bohne zu konfigurieren. Was wäre, wenn Mikrometer das verwenden könnte, um den Opentelemetry -Metriken -Exporteur einzurichten?

Mögliche Lösungen:

• Aktualisieren Sie das vorhandene OTLP -Modul vorhandenen Micrometer -Registrierung, um eine MeterRegistry zu implementieren, die ein OpenTelemetry -Objekt für die Konfiguration akzeptiert (ähnlich der OpenTelemetryMeterRegistry die von der Opentelemetry Java Instrumentation Library verwendet wird). Wenn die Rückwärtskompatibilität erforderlich ist, müsste die neue Implementierung mit dem vorhandenen nebeneinander existieren (möglicherweise ein Feature-Flag könnte zwischen den beiden wechseln?).
• Erstellen Sie ein neues Micrometer -Registrierungsmodul OpenTelemetry -Modul, um das zu implementieren, was im vorherigen Punkt beschrieben wurde, ohne jedoch Probleme mit Rückwärtskompatibilität zu haben.

Ich habe ein Problem an das Micometer -Projekt eingereicht und diese Vorschläge geteilt. Aufbau (oder Aktualisierung) eines solchen Moduls würde es ermöglichen, dieselbe OpenTelemetryAutoConfiguration wiederzuverwenden, die sowohl für Metriken als auch für Spuren (und in Zukunft auch für Protokolle) in Spring Boot 3.2 eingeführt wurden.

• Es gibt bereits ein Problem im Spring -Boot -Projekt, um eine SdkMeterProvider -Bohne und im Allgemeinen zur Verwendung von Metriken mit Opentelemetrie zu automatisieren. Wir fehlen jedoch den Mikrometerunterstützung, bevor dies machbar ist.
• Es wäre auch möglich, die Client -Implementierung zwischen HTTP und GRPC unter Verwendung des Standard -OpenTelemetry -Ansatzes zu wechseln (dh konfiguriert entweder ein OtlpHttpMetricExporter oder OtlpGrpcMetricExporter ).
• Schließlich würde es es den Entwicklern erleichtern, Mikrometer in Anwendungen zusammen mit dem Opentelemetry Java -Agenten oder im Allgemeinen der Opentelemetrie -Java -Instrumentierung zu verwenden. Diese Projekte halten derzeit einen Schim zwischen Mikrometer und Opentelemetrie. Dieser Shim würde wahrscheinlich nicht mehr gebraucht werden. Eine solche Änderung würde also auch die Arbeitsbelastung bei der Aufrechterhaltung der OpenTelemetry -Java -Instrumentierung verringern, die mit dem Mikrometer kompatibel ist.

Weitere Kontext über die aktuellen Herausforderungen finden Sie in diesem Problem im Spring Boot -Projekt.

Spuren

Spring Boot Actuator bietet eine Abhängigkeitsmanagement und Autokonfiguration für die Micrometer -Verfolgung, die eine bequeme Fassade über einige verschiedene verteilte Spuren -Backends bietet. Einer von ihnen ist Opentelemetrie.

Spring -Boot -Entwickler können ihre Anwendungen ermöglichen, Spuren über das OTLP -Protokoll zu einem OpenTelemetry -Backend zu exportieren, indem Federschuh -Aktuator, Mikrometerverfolgung und die dedizierte OpenTelemetrie -Abhängigkeit von Mikrometer zu ihren Projekten hinzugefügt werden.

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

Der vom Spring Boot Actuator Autoconfiguration bereitgestellte Exporteur ist ein HTTP -Exporteur (ein OtlpHttpSpanExporter -Bean) und kann dank der Verfolgungskonfiguration in OtlpAutoConfiguration über Eigenschaften konfiguriert werden.

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

OpenTelemetry unterstützt zusätzliche Schlüssel-/Wertpaare (als resource attributes ), die in die Telemetriedaten aufgenommen werden. Spring Boot Actuator bietet für diese eine Autokonfiguration und ermöglicht es, neue Ressourcenattribute über Eigenschaften hinzuzufügen. Das Standard -Attribut für OpenTelemetry service.name Resource -Attribut wird automatisch für den Wert von spring.application.name (falls definiert) oder an einem Standard application konfiguriert.

 management :
  opentelemetry :
    resource-attributes :
      cluster : local

Ich habe eine Demo -Bewerbung gestellt, um dieses Setup zu präsentieren.

Ausgeben von Exportierspuren über GRPC

In dieser Ausgabe im Spring Boot -Projekt wurde eine Autokonfiguration für eine OtlpHttpSpanExporter -Bean über HTTP zu exportieren.

Eine häufige Anforderung besteht darin, Spuren über GRPC zu exportieren (der am häufigsten verwendete Ansatz in der Opentelemetrie). Derzeit können Entwickler eine OtlpGrpcSpanExporter -Bean selbst konfigurieren. Es wäre schön, wenn der Spring -Boot -Aktuator dafür eine Autokonfiguration liefern würde und die vorhandene OtlpAutoConfiguration verbessert würde.

Es gibt bereits ein Problem im Spring Boot -Projekt, um eine solche Autokonfiguration hinzuzufügen.

Zusammenfassung

Insgesamt sind dies die Probleme und Vorschläge, die ich bisher beschrieben habe.

Minimal vorgeschlagene Änderungen zur Konsolidierung von Opentelemetrieunterstützung im Frühjahr für Metriken und Spuren

Mikrometer

• Führen Sie eine MeterRegistry -Implementierung ein, die auf OpenTelemetry basiert und über ihre Standardansätze konfiguriert werden kann, damit die Konfiguration zwischen Metriken und Spuren freigegeben werden kann.

Federschuh Aktuator

• Einführung einer Autokonfiguration für Opentelemetrie -Metriken. Die OpenTelemetry und Resource können aus der vorhandenen Opentelemetriekonfiguration wiederverwendet werden. Außerdem sollte die Autokonfiguration Standardeinstellungen für SdkMeterProvider , OtlpHttpMetricExporter und OtlpGrpcMetricExporter definieren.
• Führen Sie die Autokonfiguration zum Exportieren von Opentelemetrie -Spuren über GRPC durch, indem eine OtlpGrpcSpanExporter -Bean definiert wird.
• Konsolidieren Sie Opentelemetrie -Autokonfigurationsklassen über Metriken und Spuren. Die vorhandene OpentelemetryAutokonfiguration könnte für die gemeinsame Konfiguration verwendet werden. Abgesehen davon sind dedizierte Autokonfigurationsklassen erforderlich, um die spezifischen Exporteure für jede Telemetrieart zu konfigurieren. Spuren haben das bereits in der OTLPAutoconfiguration.

Spring Initializr

• Nachdem alle vorherigen Änderungen durchlaufen wurden, sollte es einfach eine Opentelemetrie -Option zum Spring Initializr hinzufügen. Wenn Sie es jetzt mit dem aktuellen Stand der Dinge hinzufügen, kann es die Dinge verwirrend machen, wenn man die unterschiedlichen Möglichkeiten zur Konfiguration von Opentelemtry zwischen Metriken und Spuren berücksichtigt.

Zusätzliche Änderungen zur Erweiterung der Opentelemetrieunterstützung im Frühjahr auf Protokolle

Federschuh Aktuator

• Führen Sie die Autokonfiguration für Opentelemetrie -Protokolle ein. Die OpenTelemetry und Resource können aus der vorhandenen Opentelemetriekonfiguration wiederverwendet werden. Außerdem sollte die Autokonfiguration Standardeinstellungen für SdkLoggerProvider , OtlpHttpLogRecordExporter und OtlpGrpcLogRecordExporter definieren.
• Fügen Sie Unterstützung für Logback (Standard) und Log4J2 hinzu. Zur Inspiration bietet die OpenTelemetry Java Instrumentation Appendern für Logback und Log4J2.
• Möglicherweise verwandte Ausgabe im Spring Boot -Projekt.

Weitere Verbesserungen

• Es wurde ein Problem eröffnet, um zu untersuchen, wie die Anzahl der in der Verfolgung OpenTelemetryAutoConfiguration derzeit verfügbaren konfigurierbaren Bohnen begrenzt werden kann (dieses Problem könnte für die globale OpenTelemetryAutoConfiguration berücksichtigt werden, sobald die nachverfolgte Spezifikation gelöscht wird).