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

Add component tag to tracing spans #923

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

ChenX1993
Copy link
Contributor

This PR is making a minor change to add span component tag to tracing spans. According to the OpneTracing sematic conventions, the component tag indicates the library that created the spans. At Uber, It is quite useful for the tracing team to understand the span creation distribution among libraries in order to optimize the operational cost.

The software package, framework, library, or module that generated the associated Span. E.g., "grpc", "django", "JDBI".

@@ -38,6 +38,8 @@ import (
// NB: the string value is what's actually shared between implementations
const zipkinSpanFormat = "zipkin-span-format"

const componentName = "tchannel-go"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Add -go suffix since we have tchannel library for java as well.

@cinchurge
Copy link
Collaborator

how was this tested end-to-end?

@ChenX1993
Copy link
Contributor Author

ChenX1993 commented Oct 7, 2024

how was this tested end-to-end?

If within the tchannel-go, there is already a tracing testing, and I updated the test with the new tag verification in this PR:

func TestTracingSpanAttributes(t *testing.T) {

If internally in monorepo, once I have the diff to bump the tchannel-go version, I will use our testing service to test end-to-end in staging env - checking the tag from jaeger UI.

Copy link
Collaborator

@cinchurge cinchurge left a comment

Choose a reason for hiding this comment

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

verified that the tag is present in the trace. thanks for testing it end-to-end!

@cinchurge cinchurge merged commit efa094c into uber:dev Oct 8, 2024
3 checks passed
@ChenX1993 ChenX1993 mentioned this pull request Oct 8, 2024
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.

2 participants