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

Remove span name from stability guarantees #3995

Closed

Conversation

lmolkova
Copy link
Contributor

Changes

The context: we'd like to update span name for HTTP client spans to include HTTP route/operation name when it's available.
Today span name includes only method (e.g. GET and could instead become more useful - GET users/{user_id}).
See open-telemetry/semantic-conventions#675 and open-telemetry/semantic-conventions#923 for more details.

However, even in the general case, span name is not something dashboards and alerts should rely on:

  • span name is usually constructed from attributes that would be more reliable for queries, dashboards and alerts
  • span names can change depending on the available level of details (e.g. HTTP server span name looks like {method} {route} and route availability depends on the web framework).
  • span name format, case sensitivity could be hard to enforce and may depend on the language.

Span name should be fine in queries like "top N longest" or "top N with highest error rate" - then, when span names become more descriptive, such queries would produce even better results.

@lmolkova lmolkova requested review from a team April 16, 2024 00:12
@@ -186,7 +186,6 @@ Semantic Conventions defines the set of fields in the OTLP data model:
- Attribute values that are defined in a list of well-known values.
- [Trace](trace/api.md)
- The following data on [span](trace/api.md#span):
- The span name
Copy link
Member

Choose a reason for hiding this comment

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

This is a stable document. Can you explain the reasoning as to why this shouldn't be considered a breaking change?

@lmolkova lmolkova marked this pull request as draft April 19, 2024 19:03
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 Apr 27, 2024
@lmolkova lmolkova closed this Apr 29, 2024
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.

3 participants