Extended opentelemetry #7496

zeitlinger · 2025-07-16T10:45:04Z

- Create Entity/EntityBuilder class in internal package - Update serialization code Need to discuss how to work with Resource going forward.

- Remove ResourceWithEntity, no way to keep bincompat that way - Update toString tests to be a lot more forgiving, but preserve intent

- fix reflective method lookup - also add unit test in the right project.

- Creates an API matching EntityProvider OTEP - Updates EntityDetector to be ResourceDetector - Creates synchronous "update resource with this entity" method. - Adds wiring for incubating API + incubating SDK Note: Still have some thoughts and ideas about a formal API, this may still change.

- Remove `Entity` and only expose `EntityBuilder` similar to how we do `LogRecord`s. - Have methods on `Resource` which determine if you're attaching the entity, simplify "remove" or just ignore for now.

…OpenTelemetry API. - Update shared state in SDK to use Supplier<Resource> instead of Resource - Add helper utils to expose private methods to supply the supplier - Create new ExtendedOpenTelemetry* API/SDK and end-to-end test.

…internal/otlp/EntityRefMarshaler.java Co-authored-by: jack-berg <[email protected]>

…iderBuilder.java Co-authored-by: jack-berg <[email protected]>

- Hide more methods (no incubating methods in public APIs that are not internal) - Update builder API to use attributes directly - Use static instances in Noop API

…lemetrySdk.getOpenTelemetrySdk() to return the extended instance

codecov · 2025-07-16T14:17:56Z

Codecov Report

❌ Patch coverage is 87.50000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.03%. Comparing base (54e8209) to head (e2584f8).
⚠️ Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
.../extension/incubator/ExtendedOpenTelemetrySdk.java	88.88%	2 Missing ⚠️
...telemetry/api/incubator/ExtendedOpenTelemetry.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #7496      +/-   ##
============================================
+ Coverage     90.01%   90.03%   +0.02%     
- Complexity     7090     7101      +11     
============================================
  Files           803      805       +2     
  Lines         21444    21484      +40     
  Branches       2092     2093       +1     
============================================
+ Hits          19302    19343      +41     
+ Misses         1477     1475       -2     
- Partials        665      666       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

zeitlinger · 2025-07-18T08:17:45Z

Alternative is #7500

api/incubator/src/main/java/io/opentelemetry/api/incubator/ExtendedOpenTelemetry.java

docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt

jack-berg · 2025-07-18T20:13:14Z

...cubator/src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdk.java

+import javax.annotation.concurrent.ThreadSafe;
+
+/** A new interface for creating OpenTelemetrySdk that supports getting {@link ConfigProvider}. */
+public class ExtendedOpenTelemetrySdk extends OpenTelemetrySdk


Alternatively, we could skip extending OpenTelemetrySdk and avoid awkwardness of trying to figure mesh together builder and constructors. OpenTelemetrySdk doesn't do much anyway so not much to repeat.

Maybe do something like have ExtendedOpenTelemetrySdk accept a delegate OpenTelemetrySdk instance during initialization and skip the builder pattern? Usage could be something like:

ExtendedOpenTelemetrySdk sdk = ExtendedOpenTelemetrySdk.create(OpenTelemetrySdk, SdkConfigProvider);

The goal (IMO) is to have AutoConfiguredOpenTelemetrySdk.getOpenTelemetrySdk() return the instance that we can work with - so that library users don't have to jump through hoops to have the correct instance.

jack-berg · 2025-07-18T20:15:37Z

.../src/main/java/io/opentelemetry/sdk/extension/incubator/ExtendedOpenTelemetrySdkBuilder.java

+   * @param configurator A callback fleshing out tracers.
+   * @return this
+   */
+  public ExtendedOpenTelemetrySdkBuilder withTracerProvider(


What do we get from these withers?

This is from the entity PR where it's actually needed

jack-berg · 2025-07-18T20:18:25Z

.../main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/DeclarativeConfiguration.java

   * @throws DeclarativeConfigException if unable to parse or interpret
   */
-  public static OpenTelemetrySdk parseAndCreate(InputStream inputStream) {
+  public static ExtendedOpenTelemetrySdk parseAndCreate(InputStream inputStream) {


This is cool - frees up callers from needing to worry about initializing SdkConfigProvider

jack-berg · 2025-07-18T20:19:40Z

sdk/all/src/test/java/io/opentelemetry/sdk/OpenTelemetrySdkTest.java

+        .matches("OpenTelemetrySdk\\{tracerProvider=SdkTracerProvider\\{.*}.*}")
+        .matches("OpenTelemetrySdk\\{.*, meterProvider=SdkMeterProvider\\{.*}.*}")
+        .matches("OpenTelemetrySdk\\{.*, loggerProvider=SdkLoggerProvider\\{.*}.*}")
+        .matches("OpenTelemetrySdk\\{.*, propagators=DefaultContextPropagators\\{.*}}");


Meh yeah this is probably an overdue improvement 😉

sdk/all/src/main/java/io/opentelemetry/sdk/IncubatingUtil.java

zeitlinger · 2025-07-21T08:39:56Z

@jack-berg please check if you like the alternative without API changes better: #7500

…y-java into jack-extended-opentelemetry

…ds final

jack-berg · 2025-09-11T19:12:10Z

Ok I pulled this down and started tweaking some things to see how they would work out, and eventually concluded that it would be better to commit / push my changes rather than leave a bunch of comments. I do like the overall direction of this.

Changes available for review here: https://github.com/open-telemetry/opentelemetry-java/compare/main...jack-berg:opentelemetry-java:jack-extended-opentelemetry?expand=1

Summary:

Get rid of ExtendedOpenTelemetrySdkBuilder
Introduce simple method for instantiating instances: ExtendedOpenTelemetry#create(OpenTelemetrySdk, SdkConfigProvider)
Make all methods of OpenTelemetrySdk final except shutdown, close, and toString
Adjust ExtendedOpenTelemetry#toString
Remove / cleanup other bits
Merge main and resolve conflicts

Let me know what you think. If you like it, consider merge my changes into your branch and mark ready for review.

zeitlinger · 2025-09-12T10:09:17Z

@jack-berg great - I like it! I merged your changes 😄

The builder is from joshs PR where he needs it for the entities - but I guess we can tackle that in a later PR.

jack-berg

@jkwatson take a look at the change to the public API when you have a chance

jkwatson · 2025-09-15T16:40:39Z

docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt

+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.sdk.logs.SdkLoggerProvider getSdkLoggerProvider()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.sdk.metrics.SdkMeterProvider getSdkMeterProvider()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.sdk.trace.SdkTracerProvider getSdkTracerProvider()
+	***  MODIFIED METHOD: PUBLIC FINAL (<- NON_FINAL) io.opentelemetry.api.trace.TracerProvider getTracerProvider()


These changes are technically breaking changes, yeah? If someone had implemented their own extension to OpenTelemetrySdk? I don't know how likely that is to be the case, but I could imagine a vendor doing it. How concerned are we about making all of these methods (and the class) final breaking someone's custom implementation?

The class was final before, so it was not possible to extend OpenTelemetrySdk before

the class itself was final previously

Doesn't that top line in the api diff say it's being made final? Am I reading that wrong?

oh! it's the opposite. 🤦🏽

So, this, then, I guess, is the only thing that's possible a concern to think about...now people will be able to extend OpenTelemetrySdk, which could potentially cause future breaking changes, if we add methods and they collide with ones that have been added externally. 🤔

That's true. But I believe we're already exposed to similar risk: Consider the OpenTelemetry interface: People can extend it, implement the extended methods, and later we could extend OpenTelemetry with conflicting methods.

jkwatson · 2025-09-16T15:50:59Z

@jkwatson take a look at the change to the public API when you have a chance

👍🏽 Seems ok to me.

zeitlinger · 2025-09-16T16:25:55Z

Thanks!

trask · 2025-09-16T16:43:47Z

this is awesome, thanks all!

jsuereth and others added 30 commits July 16, 2025 09:18

Reboot the entity prototype

4e5b156

- Create Entity/EntityBuilder class in internal package - Update serialization code Need to discuss how to work with Resource going forward.

Add base entity class, merge logic and test

869b4d8

Move Entity and EntityBuilder to be pure interfaces

9f9dc92

Add more merge helper methods and tests

fb8e571

Added test for merging raw attributes

f182ad2

Cleanups and reverting silly changes

30c578a

fix minor style issue

01a9383

Actually wire entities into resource

fb08d7d

- Remove ResourceWithEntity, no way to keep bincompat that way - Update toString tests to be a lot more forgiving, but preserve intent

Fix typo

1f00dcb

Remove all publicly accessible references to Entity from stable packages

cfd444b

Add incubating EntityProvider API for specification work

0e0bc4e

Fix refactoring that broke reflection.

c8bfbd4

- fix reflective method lookup - also add unit test in the right project.

Fix schema url and test, now that we proved it works

e93fceb

Further simplify the API and SDK for entities

1147733

- Remove `Entity` and only expose `EntityBuilder` similar to how we do `LogRecord`s. - Have methods on `Resource` which determine if you're attaching the entity, simplify "remove" or just ignore for now.

Fix javadoc issues

00829e7

Update exporters/otlp/common/src/main/java/io/opentelemetry/exporter/…

ecd9c7b

…internal/otlp/EntityRefMarshaler.java Co-authored-by: jack-berg <[email protected]>

Update sdk/logs/src/main/java/io/opentelemetry/sdk/logs/SdkLoggerProv…

802c056

…iderBuilder.java Co-authored-by: jack-berg <[email protected]>

Fixes from review.

fed1754

- Hide more methods (no incubating methods in public APIs that are not internal) - Update builder API to use attributes directly - Use static instances in Noop API

Remove methods we don't need yet.

6924bf5

Remove redundant visibility.

fe34bb1

More cleanups from review.

552dea2

Simplify prototype of SdkResource.

92848a4

Fix typo.

fa6c704

More cleanups from review.

698b753

Add more tests for ResourceProvider.

612c2c0

Fix stylecheck.

41c92ee

More checkstyle fixes.

7a69952

Rename prototype to more closely match OTEP 4316.

30a0fe7

zeitlinger added 5 commits July 16, 2025 10:18

extract extended opentelemetry only

d5f2ce5

return extended otel sdk

2ff74e2

return extended otel sdk

10d7c47

return extended otel sdk

215f832

obfuscate sdk config provider

c3e86da

zeitlinger requested a review from a team as a code owner July 16, 2025 10:45

This was referenced Jul 16, 2025

use extended opentelemetry open-telemetry/opentelemetry-java-instrumentation#14251

Draft

use InstrumentationConfig where possible open-telemetry/opentelemetry-java-instrumentation#14192

Open

extended otel must extend otel - because we need AutoConfiguredOpenTe…

4b7c986

…lemetrySdk.getOpenTelemetrySdk() to return the extended instance

zeitlinger marked this pull request as draft July 18, 2025 08:17

zeitlinger self-assigned this Jul 18, 2025

jack-berg reviewed Jul 18, 2025

View reviewed changes

jack-berg added 3 commits September 11, 2025 10:54

Remove ExtendedOpenTelemetrySdkBuilder

a719606

Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…

c272687

…y-java into jack-extended-opentelemetry

Revise ExtendedOpenTelemetrySdk#toString, make OpenTelemetrySdk metho…

f73aab1

…ds final

zeitlinger mentioned this pull request Sep 12, 2025

Extended opentelemetry (alternative) #7500

Closed

zeitlinger marked this pull request as ready for review September 12, 2025 10:07

format

e2584f8

jack-berg approved these changes Sep 13, 2025

View reviewed changes

jkwatson reviewed Sep 15, 2025

View reviewed changes

jkwatson merged commit 1c5dd50 into open-telemetry:main Sep 16, 2025
29 checks passed

zeitlinger deleted the extended-opentelemetry branch September 16, 2025 16:25

Extended opentelemetry #7496

Extended opentelemetry #7496

Uh oh!

Conversation

zeitlinger commented Jul 16, 2025

Uh oh!

codecov bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

zeitlinger commented Jul 18, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zeitlinger commented Jul 21, 2025

Uh oh!

jack-berg commented Sep 11, 2025

Uh oh!

zeitlinger commented Sep 12, 2025

Uh oh!

jack-berg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jkwatson commented Sep 16, 2025

Uh oh!

Uh oh!

zeitlinger commented Sep 16, 2025

Uh oh!

trask commented Sep 16, 2025

Uh oh!

Uh oh!

codecov bot commented Jul 16, 2025 •

edited

Loading