Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename library entrypoints to Telemetry #5624

Merged
merged 3 commits into from
Mar 22, 2022

Conversation

anuraaga
Copy link
Contributor

I've been wanting to solve our long standing issue of naming our entrypoints Tracing even though they are more than tracing since we should write more examples for library instrumentation and would be good to have more stable APIs. I think we liked the idea Telemetry when discussing a while back.

@anuraaga anuraaga requested a review from a team as a code owner March 18, 2022 08:22
@mateuszrzeszutek mateuszrzeszutek linked an issue Mar 18, 2022 that may be closed by this pull request
Copy link
Member

@mateuszrzeszutek mateuszrzeszutek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! 🚀

Comment on lines 25 to 29
GraphQLTelemetry tracing =
GraphQLTelemetry.builder(testing.getOpenTelemetry())
.setCaptureExperimentalSpanAttributes(true)
.build();
builder.instrumentation(tracing.newInstrumentation());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
GraphQLTelemetry tracing =
GraphQLTelemetry.builder(testing.getOpenTelemetry())
.setCaptureExperimentalSpanAttributes(true)
.build();
builder.instrumentation(tracing.newInstrumentation());
GraphQLTelemetry telemetry =
GraphQLTelemetry.builder(testing.getOpenTelemetry())
.setCaptureExperimentalSpanAttributes(true)
.build();
builder.instrumentation(telemetry.newInstrumentation());

@@ -20,8 +20,8 @@
private static final boolean CAPTURE_EXPERIMENTAL_SPAN_ATTRIBUTES =
Config.get().getBoolean("otel.instrumentation.graphql.experimental-span-attributes", false);

private static final GraphQLTracing TRACING =
GraphQLTracing.builder(GlobalOpenTelemetry.get())
private static final GraphQLTelemetry TRACING =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/TRACING/TELEMETRY/g

Comment on lines 22 to 25
ArmeriaTelemetry tracing = ArmeriaTelemetry.create(GlobalOpenTelemetry.get());

CLIENT_DECORATOR = tracing.newClientDecorator();
SERVER_DECORATOR = tracing.newServiceDecorator();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ArmeriaTelemetry tracing = ArmeriaTelemetry.create(GlobalOpenTelemetry.get());
CLIENT_DECORATOR = tracing.newClientDecorator();
SERVER_DECORATOR = tracing.newServiceDecorator();
ArmeriaTelemetry telemetry = ArmeriaTelemetry.create(GlobalOpenTelemetry.get());
CLIENT_DECORATOR = telemetry.newClientDecorator();
SERVER_DECORATOR = telemetry.newServiceDecorator();

@@ -26,8 +26,8 @@
boolean experimentalSpanAttributes =
Config.get().getBoolean("otel.instrumentation.grpc.experimental-span-attributes", false);

GrpcTracing tracing =
GrpcTracing.builder(GlobalOpenTelemetry.get())
GrpcTelemetry tracing =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/tracing/telemetry/g

Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice 👍

@anuraaga anuraaga merged commit cd528e9 into open-telemetry:main Mar 22, 2022
RashmiRam pushed a commit to RashmiRam/opentelemetry-auto-instr-java that referenced this pull request May 23, 2022
* Rename library entrypoints to Telemetry

* Renames
trask pushed a commit that referenced this pull request Jan 15, 2023
for okhttp-3.0 instrumentation, the README uses `OkHttpTracing`:
```java
import io.opentelemetry.instrumentation.okhttp.v3_0.OkHttpTracing;
...
return OkHttpTracing.builder(openTelemetry).build().newCallFactory(createClient());
```

#5624 changed `OkHttpTracing` to `OkHttpTelemetry` but the docs still
show the previous value which no longer works
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename FooTracing to FooInstrumentation or FooInstrumenter
3 participants