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 84.72222% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.97%. Comparing base (29a7fe8) to head (4b7c986).
⚠️ Report is 15 commits behind head on main.

Files with missing lines	Patch %	Lines
.../extension/incubator/ExtendedOpenTelemetrySdk.java	54.54%	5 Missing ⚠️
...ion/incubator/ExtendedOpenTelemetrySdkBuilder.java	90.90%	3 Missing ⚠️
...telemetry/api/incubator/ExtendedOpenTelemetry.java	0.00%	1 Missing ⚠️
...ension/incubator/fileconfig/SdkConfigProvider.java	0.00%	1 Missing ⚠️
...main/java/io/opentelemetry/sdk/IncubatingUtil.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #7496      +/-   ##
============================================
- Coverage     89.99%   89.97%   -0.02%     
- Complexity     7078     7093      +15     
============================================
  Files           803      807       +4     
  Lines         21405    21449      +44     
  Branches       2086     2087       +1     
============================================
+ Hits          19263    19299      +36     
- Misses         1479     1488       +9     
+ Partials        663      662       -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

jack-berg · 2025-07-18T20:08:23Z

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

+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.incubator.config.ConfigProvider;
+
+/** Extension to {@link OpenTelemetry} that supports getting {@link ConfigProvider}. */


Let's keep the language generic enough to support evolving use cases.

Suggested change

/** Extension to {@link OpenTelemetry} that supports getting {@link ConfigProvider}. */

/** Extended {@link OpenTelemetry} with experimental APIs. */

jack-berg · 2025-07-18T20:09:53Z

docs/apidiffs/current_vs_latest/opentelemetry-sdk.txt

Worth calling out attention to this, but I think this is fine.

The alternative PR doesn't need this

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

@@ -82,7 +83,7 @@ private DeclarativeConfiguration() {}
   *
   * @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 😉

jack-berg · 2025-07-18T20:20:08Z

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

+  private IncubatingUtil() {}
+
+  @Nullable
+  static OpenTelemetrySdk createExtendedOpenTelemetrySdk() {


What's going on here?

forgot to delete this

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

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

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

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

Finish remove implementation and listeners.

f917d9d

Remove assertjs helpers, update javadoc.

c5af0ef

Fix entity javadoc.

c70b63d

Fix tests.

53ec454

extract extended opentelemetry only

f66057c

extract extended opentelemetry only

06590dc

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Extended opentelemetry #7496

Extended opentelemetry #7496

Uh oh!

zeitlinger commented Jul 16, 2025

Uh oh!

codecov bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

zeitlinger commented Jul 18, 2025

Uh oh!

jack-berg Jul 18, 2025

Uh oh!

jack-berg Jul 18, 2025

Uh oh!

zeitlinger Jul 18, 2025

Uh oh!

jack-berg Jul 18, 2025

Uh oh!

zeitlinger Jul 21, 2025

Uh oh!

jack-berg Jul 18, 2025

Uh oh!

zeitlinger Jul 18, 2025

Uh oh!

jack-berg Jul 18, 2025

Uh oh!

jack-berg Jul 18, 2025

Uh oh!

jack-berg Jul 18, 2025

Uh oh!

zeitlinger Jul 21, 2025

Uh oh!

zeitlinger commented Jul 21, 2025

Uh oh!

Uh oh!

	/** Extension to {@link OpenTelemetry} that supports getting {@link ConfigProvider}. */
	/** Extended {@link OpenTelemetry} with experimental APIs. */

Extended opentelemetry #7496

Are you sure you want to change the base?

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!

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!

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!

zeitlinger commented Jul 21, 2025

Uh oh!

Uh oh!

codecov bot commented Jul 16, 2025 •

edited

Loading