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

fix: Prevent high cardinality rack span name as a default #973

Merged
merged 3 commits into from Oct 6, 2021

Conversation

robertlaurin
Copy link
Contributor

It is possible to maintain the high cardinality behaviour by passing in a
url quantization function that simply forwards the URI path.

Instrumentation MUST NOT default to using URI path as span name, but MAY
provide hooks to allow custom logic to override the default span name.

https://github.com/open-telemetry/opentelemetry-specification/blob/v1.0.0/specification/trace/semantic_conventions/http.md#name

It is possible to maintain the high cardinality behaviour by passing in a
url quantization function that simply forwards the URI path.

> Instrumentation MUST NOT default to using URI path as span name, but MAY
> provide hooks to allow custom logic to override the default span name.

https://github.com/open-telemetry/opentelemetry-specification/blob/v1.0.0/specification/trace/semantic_conventions/http.md#name
Copy link
Contributor

@arielvalentin arielvalentin left a comment

Choose a reason for hiding this comment

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

LGTM. ✨ if you add some docs describing the behavior 🙏🏼

Copy link
Contributor

@fbogsany fbogsany left a comment

Choose a reason for hiding this comment

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

LGTM - agree we need some documentation for this, including in the release notes.

@ericmustin
Copy link
Contributor

I think the failing action controller tests just need to get hardcoded updates?

+1 to @arielvalentin's comment. Though we probably need a broader update to the automatic instrumentation section of the opentelemetry.io docs, in the meantime maybe a quick section/note in just the opentelemetry-instrumentation-rack readme would suffice?

@robertlaurin
Copy link
Contributor Author

Added some notes to the changelog and readme around this change 045a5e0

@robertlaurin robertlaurin merged commit ad27403 into main Oct 6, 2021
@fbogsany fbogsany deleted the fix-rack-span-name branch January 21, 2022 20:07
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.

None yet

4 participants