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

HTTP semantic convention table is too wide #933

Closed
Oberon00 opened this issue Sep 9, 2020 · 6 comments
Closed

HTTP semantic convention table is too wide #933

Oberon00 opened this issue Sep 9, 2020 · 6 comments
Labels
area:semantic-conventions Related to semantic conventions bug Something isn't working release:after-ga Not required before GA release, and not going to work on before GA spec:trace Related to the specification/trace directory

Comments

@Oberon00
Copy link
Member

Oberon00 commented Sep 9, 2020

See https://github.com/open-telemetry/opentelemetry-specification/blob/821118e5/specification/trace/semantic_conventions/http.md#common-attributes

The table is cut off at the right side on my 1920x1080 screen and you have to awkwardly scroll by selecting. The culprits seem to be the http.response_content_length_uncompressed and http.request_content_length_uncompressed attributes which have really long names.

image

...

image

@Oberon00 Oberon00 added bug Something isn't working area:semantic-conventions Related to semantic conventions spec:trace Related to the specification/trace directory release:after-ga Not required before GA release, and not going to work on before GA labels Sep 9, 2020
@arminru
Copy link
Member

arminru commented Sep 10, 2020

Are you sure this warrants being labeled a bug? It's more a visual/UX nuisance in my opinion.
It's rather a bug that Github is only using half of the available screen width even if there are wider tables 😉
Any suggestion on how we could make it fit without having to rename the attribute?

@Oberon00
Copy link
Member Author

Oberon00 commented Sep 11, 2020

Since we have no separate label for "minor nitpick", "bug" is the closest thing. The urgency/importance part should be covered by the "after-ga" label.

@Oberon00
Copy link
Member Author

Oberon00 commented Sep 11, 2020

Maybe we could leave out the prefix for such attributes, but just response_content_length_uncompressed would likely still cause a scrollbar.

Another solution would be to not use a table, but an enumeration like:

  • http.request_content_length_uncompressed (optional number): Brief brief.

    Note note note (no footnote-splitout required).

    Examples: 5493

An alternative would be to always move the examples to the footnote, or integrate them in the description column.

CC @thisthat

@arminru
Copy link
Member

arminru commented Sep 15, 2020

@Oberon00 It would not only cause a scrollbar but also confusion if the prefix is left out only for some attributes (or suddenly for all of them). A list should work, yes.
I, personally, however, am fine with the current tables (even if one has to scroll on this particular one when viewing it on the Github website).

@arminru
Copy link
Member

arminru commented Oct 2, 2023

@Oberon00 is this still an issue now that the table is rendered in a different manner in the new repo?

https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes

@Oberon00
Copy link
Member Author

This particular table seems fine. Closing this in favor of #1925

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions bug Something isn't working release:after-ga Not required before GA release, and not going to work on before GA spec:trace Related to the specification/trace directory
Projects
None yet
Development

No branches or pull requests

2 participants