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

Should span Status description be of low cardinality? #3687

Open
jcarres-mdsol opened this issue Sep 9, 2023 · 6 comments
Open

Should span Status description be of low cardinality? #3687

jcarres-mdsol opened this issue Sep 9, 2023 · 6 comments
Labels
area:api Cross language API specification issue area:semantic-conventions Related to semantic conventions spec:trace Related to the specification/trace directory triage:accepted:ready

Comments

@jcarres-mdsol
Copy link

jcarres-mdsol commented Sep 9, 2023

Currently the spec about span status mentions that the Description SHOULD be documented and predictable. and Description that provides a descriptive message of the Status.

We are using a library which adds to the description something like "failed to connect to queue 'uuid'" where 'uuid' is the whole uuid. This creates many unique descriptions which would prevent us from using description as a metric label, something that is on the other hand desirable in http spans.

Should the spec add a note description SHOULD be of low cardinality or description cardinality should follow the guidance for span names ?

@jcarres-mdsol jcarres-mdsol added the spec:trace Related to the specification/trace directory label Sep 9, 2023
@Oberon00
Copy link
Member

You mention the span name, but you mean the description inside the span status, right?

@jcarres-mdsol
Copy link
Author

Yes sorry, I've fixed the first link, it is all about the description of the span status

@Oberon00 Oberon00 changed the title Should span description be of low cardinality? Should span Status description be of low cardinality? Sep 11, 2023
@Oberon00 Oberon00 added area:api Cross language API specification issue area:semantic-conventions Related to semantic conventions labels Sep 11, 2023
@trask
Copy link
Member

trask commented Sep 11, 2023

there's been a bit of prior discussion on this, see #3496

I have the feeling that we may need to relax the restriction on span status description based on feedback from @Oberon00 and @jsuereth

prevent us from using description as a metric label

check out the brand new error.type attribute which is approximately the metric equivalent of span status description

@jmacd
Copy link
Contributor

jmacd commented Dec 6, 2023

@trask I agree we should relax the restriction on span status -- and that some other well-specified attribute value should be used when metrics are requested.

@svrnm
Copy link
Member

svrnm commented May 6, 2024

is this still being discussed?

@trask
Copy link
Member

trask commented May 8, 2024

I think a PR would be useful to clarify that span status description does not need to be low cardinality, since this has been unclear previously.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Cross language API specification issue area:semantic-conventions Related to semantic conventions spec:trace Related to the specification/trace directory triage:accepted:ready
Projects
Status: Spec - Accepted
Development

No branches or pull requests

6 participants