Implement new SemConv exporter health metrics by JonasKunz · Pull Request #7265 · open-telemetry/opentelemetry-java

JonasKunz · 2025-04-10T14:44:18Z

This PR implements the new, experimental exporter health metrics defined in semantic conventions. The other metrics will be added in follow-up PRs.

We already have some experimental health metrics in the SDK, which I intend to eventually replace with the new ones from semantic conventions. I'm envisioning the replacement process as follows:

Implement the new health metrics in a series of PRs, but have them opt-in and keep reporting the legacy metrics by default
Add autoconfiguration support to configure the health metrics level: e.g. on, off, legacy and maybe in the future extended for opt-in attributes / metrics
Switch the default setting from legacy to on, this will be a breaking change
After some grace period remove support for the legacy metrics

jack-berg · 2025-04-11T14:49:53Z

Hey @JonasKunz give me a heads up when you think this is ready for review. Happy to start with a high level review while its still in draft!

JonasKunz · 2025-04-14T08:19:56Z

@jack-berg a high level review would be appreciated! I'm happy with the overall structure and would mostly polish from now on, so it would be great to get your feedback before I polish things we'll end up changing anyway.

I've updated the PR comment to give an introduction on how I envision the feature implementation in general.

# Conflicts: # exporters/common/src/main/java/io/opentelemetry/exporter/internal/ExporterMetrics.java # exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/http/metrics/OtlpHttpMetricExporterBuilder.java # exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/metrics/OtlpGrpcMetricExporterBuilder.java

jack-berg

Left a variety of comments, but this is on the right track. Thanks for working on this.

jack-berg · 2025-04-30T22:25:30Z

exporters/common/src/main/java/io/opentelemetry/exporter/internal/ExporterMetrics.java

-  private static final AttributeKey<Boolean> ATTRIBUTE_KEY_SUCCESS = booleanKey("success");
+  /**
+   * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+   * any time.


Out of curiosity did the build force this comment to pass?

Yes:

> Compilation failed; see the compiler output below. /Users/jonas/git/otel/opentelemetry-java/exporters/common/src/main/java/io/opentelemetry/exporter/internal/ExporterMetrics.java:29: warning: [OtelInternalJavadoc] This public internal class doesn't end with any of the applicable javadoc disclaimers: "This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.", or "This class is internal and experimental. Its APIs are unstable and can change at any time. Its APIs (or a version of them) may be promoted to the public stable API in the future, but no guarantees are made." public enum Signal { ^ (see https://errorprone.info/bugpattern/OtelInternalJavadoc) 1 error 1 warning

Is that not intentional?

sdk/common/src/main/java/io/opentelemetry/sdk/common/HealthMetricLevel.java

exporters/common/src/main/java/io/opentelemetry/exporter/internal/ExporterMetricsAdapter.java

exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporterBuilder.java

exporters/otlp/all/src/jmh/java/io/opentelemetry/exporter/otlp/trace/OltpExporterBenchmark.java

exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporterBuilder.java

exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporter.java

# Conflicts: # docs/apidiffs/current_vs_latest/opentelemetry-exporter-otlp.txt # docs/apidiffs/current_vs_latest/opentelemetry-exporter-zipkin.txt # docs/apidiffs/current_vs_latest/opentelemetry-sdk-common.txt

jack-berg

There may be opportunities to clean up some things (e.g. its not great that ExporterInstrumentation and ExporterMetrics each have an internal class/interface called Recording), but this is great start as far as I'm concerned. New public API surface area and telemetry output looks good.

A couple more non-blocking comments

exporters/common/src/test/java/io/opentelemetry/exporter/internal/http/HttpExporterTest.java

exporters/common/src/test/java/io/opentelemetry/exporter/internal/grpc/GrpcExporterTest.java

exporters/common/src/test/java/io/opentelemetry/exporter/internal/http/FakeHttpResponse.java

...rs/common/src/main/java/io/opentelemetry/exporter/internal/metrics/ServerAttributesUtil.java

.../java/io/opentelemetry/exporter/otlp/testing/internal/AbstractGrpcTelemetryExporterTest.java

…nal/grpc/GrpcExporterTest.java Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com>

…nal/http/HttpExporterTest.java Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com>

sdk/common/src/main/java/io/opentelemetry/sdk/internal/Signal.java

sdk/common/src/main/java/io/opentelemetry/sdk/internal/StandardComponentId.java

sdk/common/src/main/java/io/opentelemetry/sdk/common/InternalTelemetryVersion.java

JonasKunz added 13 commits April 9, 2025 12:35

Add implementation for new exporter health metrics

4bb3e56

Use new implementation in GRPC exporters

dd651c3

Use new implementation in HTTP exporters

20959d8

Use new implementation in zipkin exporter

4bafbfa

Merge remote-tracking branch 'otel/main' into health-metrics

67fe9ec

add javadoc since tags

073ecee

spotless

ba07867

Fix javadoc and style issues

5281d9a

Added test for HTTP Exporter

e560424

Implemented duration metric

2f29ac2

spotless

a2a78f7

Added GRPC test

0bfa4f4

Added server.* attributes

149ffbd

JonasKunz added 6 commits April 16, 2025 09:50

Added tests for server.* attribute extraction

22ba608

Adjust metric names to now merged semconv PR

8522179

Merge remote-tracking branch 'otel/HEAD' into health-metrics

d4afdc9

spotless

9adacd0

Implement status code attributes

676b66c

jack-berg reviewed Apr 30, 2025

View reviewed changes

JonasKunz added 8 commits May 5, 2025 12:02

Renames

ec686d3

Introduce interface as abstraction

ad69fa5

Complete renaming of "HealthMetricLevel"

a1cd746

Remove since tags

48b6320

Add tests for semconv attributes

32943e1

Move standard component types to enum

d2db75d

spotless

5f94bb5

Fix compilation

5b71238

JonasKunz added 11 commits May 20, 2025 13:47

Move namespace and unit to signal enum

374d214

Move signal to standalone enum

a5f3178

Inline unnecessary ComponentId.put method

7fbf2db

Add StandardComponentId to not have to pass the type around separately

66cd86e

Merge remote-tracking branch 'otel/main' into health-metrics

4202870

# Conflicts: # docs/apidiffs/current_vs_latest/opentelemetry-exporter-otlp.txt # docs/apidiffs/current_vs_latest/opentelemetry-exporter-zipkin.txt # docs/apidiffs/current_vs_latest/opentelemetry-sdk-common.txt

Rename InternalTelemetrySchemaVersion and its setters

c5051ed

Remove DISABLED telemetry schema version

1b037a5

Rename and move standard exporter types

3a89f42

Exclude profiles exporter from metrics

aa96250

apidiff

b472345

fix japicmp

7d9b16e

JonasKunz requested a review from jack-berg May 20, 2025 13:35

jack-berg approved these changes May 27, 2025

View reviewed changes

JonasKunz and others added 5 commits May 28, 2025 14:41

Update exporters/common/src/test/java/io/opentelemetry/exporter/inter…

51edc50

…nal/grpc/GrpcExporterTest.java Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com>

Update exporters/common/src/test/java/io/opentelemetry/exporter/inter…

8ff0381

…nal/http/HttpExporterTest.java Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com>

Review fixes

a52d607

Merge remote-tracking branch 'otel/main' into health-metrics

165f9a6

Use assum to early-out of test

03496e8

jkwatson reviewed May 28, 2025

View reviewed changes

sdk/common/src/main/java/io/opentelemetry/sdk/internal/Signal.java Outdated Show resolved Hide resolved

jkwatson reviewed May 28, 2025

View reviewed changes

sdk/common/src/main/java/io/opentelemetry/sdk/internal/StandardComponentId.java Outdated Show resolved Hide resolved

trask reviewed May 29, 2025

View reviewed changes

sdk/common/src/main/java/io/opentelemetry/sdk/common/InternalTelemetryVersion.java Outdated Show resolved Hide resolved

JonasKunz added 4 commits May 30, 2025 10:28

remove Signal.toString

b53cbe9

remove StandardComponentId.toString

6350dff

Remove InternalTelemetryVersion.V1_33

e307e60

spotless

00b4f2f

jack-berg approved these changes Jun 3, 2025

View reviewed changes

japicmp

8e89011

jack-berg merged commit f720735 into open-telemetry:main Jun 3, 2025
28 checks passed

JonasKunz mentioned this pull request Jun 18, 2025

Implement span started and live health metrics #7430

Closed

anuraaga mentioned this pull request Dec 5, 2025

Implement SDK metrics for trace #7895

Merged

Comments

Conversation

JonasKunz commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jack-berg commented Apr 11, 2025

Uh oh!

JonasKunz commented Apr 14, 2025

Uh oh!

jack-berg left a comment

Choose a reason for hiding this comment

Uh oh!

jack-berg Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

JonasKunz May 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jack-berg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

JonasKunz commented Apr 10, 2025 •

edited

Loading