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

Use service.namespace in Jager's service name if present #1710

Closed

Conversation

bogdandrutu
Copy link
Member

@bogdandrutu bogdandrutu commented May 18, 2021

OpenQuestion: There is a note in the https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#service about not concatenating, but I think (🤔) for cases where only one value is passed like Jaeger it would be important to concatenate them.

Signed-off-by: Bogdan Drutu bogdandrutu@gmail.com

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
@bogdandrutu
Copy link
Member Author

Some extra comments related to this #1677 (comment)

@Oberon00
Copy link
Member

Good point, but I think we should change Zipkin at the same time (there is no reason for this to apply only to Jaeger). Actually, I just noticed we have a document https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk_exporters/non-otlp.md, probably this should be moved there.

The semantic convention should also be changed to mention the preferred separator in cases where concatenation is needed.

[default](../../resource/sdk.md#sdk-provided-resource-attributes) `Resource`.
* If `service.namespace` is not present, Jaeger's field MUST be populated from the `service.name` attribute.
Copy link
Member

Choose a reason for hiding this comment

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

These points are a bit hard to read. IMHO a better structure would be:

  • If service.name and service.namespace, ...
  • Otherwise if just service.name, ...
  • Otherwise (irrespective of service.namespace), ...

Also, the current wording leaves the case where service.namespace is present but service.name is not undefined. With the suggestion above it would be ignored but using {service.namespace}/{default service name} might make sense.

[default](../../resource/sdk.md#sdk-provided-resource-attributes) `Resource`.
* If `service.namespace` is not present, Jaeger's field MUST be populated from the `service.name` attribute.
* If both `service.namespace` and `service.name` attribute are present then that field
MUST be populated as `{service.namespace} + "/" + {service.name}`
Copy link
Member

Choose a reason for hiding this comment

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

I think this is not a bad idea but would be good to hear from Jaeger experts. Maybe there is a commonly accepted way to model service namespaces or teams this in Jaeger? @yurishkuro do you know?

Copy link
Member

Choose a reason for hiding this comment

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

Jaeger backend does not support the notion of namespaces. Does any backend do? What is the specific functionality that applies to namespace only and not the FQ service name?

Back at Uber we had several thousand services and did not come across a need for a namespace as a first class entity, although various teams did use certain prefixes for service names like jaeger_indexer, jaeger_ingester.

Regarding the concatenation, using slash makes many Jaeger URLs quite ugly since slash must be URL-encoded.

Copy link
Member

@SergeyKanzhelev SergeyKanzhelev left a comment

Choose a reason for hiding this comment

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

Let's change it for Zipkin and also for resource labels description here: https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#service

this kind of inconsistency is bothersome

@github-actions
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label May 26, 2021
@github-actions
Copy link

github-actions bot commented Jun 2, 2021

Closed as inactive. Feel free to reopen if this PR is still being worked on.

@github-actions github-actions bot closed this Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants