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.

Sign up for GitHub

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

Jump to bottom

stabilise spanNames #12487

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

stabilise spanNames #12487

wants to merge 8 commits into from

Conversation

AlchemyDing
Copy link
Member

resolve issue
move SpanNames from instrumentation-api-incubator to instrumentation-api

@AlchemyDing AlchemyDing requested a review from a team as a code owner October 21, 2024 16:14
steverao
steverao approved these changes Oct 22, 2024
View reviewed changes
Copy link
Contributor

@steverao steverao left a comment •
edited
Loading

Choose a reason for hiding this comment

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

It looks good! But I am curious about if there are any other documents or discussions to support this migration apart from quarkusio/quarkus#41521 (comment)? Because I am not sure whether other classes in instrumentation-api-incubator exist similar problem. @trask

trask
trask reviewed Oct 25, 2024
View reviewed changes
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.

@open-telemetry/java-instrumentation-approvers @jack-berg @brunobat any thoughts about committing to this as a stable API? thanks

brunobat
brunobat approved these changes Oct 25, 2024
View reviewed changes
Copy link

@brunobat brunobat left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks!

jack-berg
jack-berg approved these changes Oct 25, 2024
View reviewed changes
Copy link
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

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

Seems ok to me. One day we could end up with semantic conventions for these types of situations, but: 1. I think this is a good way to name spans which will be highly defensible. 2. This is just a utility method.

...tor/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/util/SpanNames.java Show resolved Hide resolved
...mentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/util/SpanNames.java
Map<String, String> spanNameCache =
spanNameCaches.computeIfAbsent(clazz, c -> new ConcurrentHashMap<>());

// not using computeIfAbsent, because it would require a capturing (allocating) lambda
Copy link
Member

Choose a reason for hiding this comment

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

That shouldn't be the case if you use a method reference.

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure how you would use a method reference here?

...mentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/util/SpanNames.java
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

public final class SpanNames {
Copy link
Member

Choose a reason for hiding this comment

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

Javadoc?

@trask trask added this to the v2.10.0 milestone Oct 26, 2024
breedx-splk
breedx-splk reviewed Nov 8, 2024
View reviewed changes
Copy link
Contributor

@breedx-splk breedx-splk left a comment

Choose a reason for hiding this comment

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

This seems fine to me. I think Jack's point about delegating to the stable class should be addressed, and I was surprised to learn that there weren't any unit tests on this very testable code. 😭

@trask trask modified the milestones: v2.10.0, v2.11.0 Nov 13, 2024
@AlchemyDing
Merge branch 'main' into stabilise-spanNames
94738e3 
# Conflicts:
#	docs/apidiffs/current_vs_latest/opentelemetry-instrumentation-api.txt
@AlchemyDing
add javadoc,unit test
e014cbf
@AlchemyDing
Copy link
Member Author

AlchemyDing commented Nov 21, 2024 •
edited
Loading

This seems fine to me. I think Jack's point about delegating to the stable class should be addressed, and I was surprised to learn that there weren't any unit tests on this very testable code. 😭

@breedx-splk done

@AlchemyDing
Copy link
Member Author

AlchemyDing commented Nov 21, 2024 •
edited
Loading

@trask @jack-berg @breedx-splk I have fixed the above problems, please help me review it, Thank you.

trask
trask approved these changes Nov 21, 2024
View reviewed changes
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.

thanks @AlchemyDing!

@trask trask mentioned this pull request Dec 17, 2024
Merged
@trask trask modified the milestones: v2.11.0, v2.12.0 Dec 23, 2024
@trask
Copy link
Member

trask commented Dec 23, 2024

@laurit do you think #6595 is still an issue?

@laurit
Copy link
Contributor

laurit commented Dec 23, 2024

@laurit do you think #6595 is still an issue?

Probably, but I think that most of the instrumentations that name a span based on the executed method are disabled by default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@breedx-splk breedx-splk breedx-splk left review comments

@jack-berg jack-berg jack-berg approved these changes

@steverao steverao steverao approved these changes

@brunobat brunobat brunobat approved these changes

@trask trask trask approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.12.0
Development

Successfully merging this pull request may close these issues.

Stabilise SpanNames
7 participants
@AlchemyDing @trask @laurit @brunobat @steverao @jack-berg @breedx-splk