Skip to content

docs[open-telemetry]: Add specifications for content negotation and escaping, and docs for translation strategies for Otel metric name translation #2653

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

Merged
merged 6 commits into from
May 27, 2025

Conversation

ywwg
Copy link
Member

@ywwg ywwg commented May 21, 2025

This updates the docs to represent the current state of otel configuration options. It also creates specification files to document scraping content negotiation and escaping schemes.

@ywwg ywwg force-pushed the owilliams/translation-strategies branch 2 times, most recently from b6add48 to 19bcc8e Compare May 21, 2025 18:49
@ywwg ywwg marked this pull request as ready for review May 21, 2025 18:49
@ywwg ywwg requested review from dashpole and ArthurSens May 21, 2025 18:53
Copy link
Member

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

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

LGTM

@ywwg ywwg force-pushed the owilliams/translation-strategies branch from 19bcc8e to 3d8c0f6 Compare May 21, 2025 19:08
@ywwg ywwg requested a review from ArthurSens May 21, 2025 19:08
@ywwg ywwg force-pushed the owilliams/translation-strategies branch from 3d8c0f6 to b4873c6 Compare May 21, 2025 19:08
@ywwg ywwg marked this pull request as draft May 22, 2025 14:27
@ywwg ywwg force-pushed the owilliams/translation-strategies branch from 7bc2f3c to cba8b29 Compare May 23, 2025 12:34
@ywwg ywwg changed the title docs[open-telemetry]: Add new and future translation strategies for Otel metric name translation docs[open-telemetry]: Add specifications for content negotation and escaping, and docs for translation strategies for Otel metric name translation May 23, 2025
@ywwg ywwg requested a review from ArthurSens May 23, 2025 12:39
@ywwg ywwg marked this pull request as ready for review May 23, 2025 12:39
Copy link
Member

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

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

Thank you for the effort writing this :)

I have some suggestions 👇

@@ -82,6 +82,14 @@ setting the `escaping` header to a different value.
underscores are replaced with double underscores. This mode allows for full
round-tripping of UTF-8 names with a legacy system.

Enabling UTF-8 support in Prometheus indicates that the system is *capable* of
Copy link
Member

Choose a reason for hiding this comment

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

"the system" refers to Prometheus itself? If yes, could we adjust the wording a bit? I think using "it" is already clearer than the system

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah I can tweak that. There are cases where the spec isn't necessarily referencing prometheus, it could be referencing an endpoint like the otel SDK. So there are places where we want to be more generic. But I think this one can be switched over.

…tel metric name translation.

Signed-off-by: Owen Williams <[email protected]>
@ywwg ywwg force-pushed the owilliams/translation-strategies branch from 18594f0 to e3e35a1 Compare May 23, 2025 15:23
ywwg added 5 commits May 23, 2025 13:35
Signed-off-by: Owen Williams <[email protected]>
Signed-off-by: Owen Williams <[email protected]>
Signed-off-by: Owen Williams <[email protected]>
Signed-off-by: Owen Williams <[email protected]>
@ywwg ywwg requested a review from ArthurSens May 23, 2025 18:51
@ywwg
Copy link
Member Author

ywwg commented May 23, 2025

I did some more polishing, would appreciate one final look over

Copy link
Member

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

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

:shipit:

@ywwg ywwg merged commit ed7d977 into main May 27, 2025
5 checks passed
@ywwg ywwg deleted the owilliams/translation-strategies branch May 27, 2025 17:26
@juliusv
Copy link
Member

juliusv commented May 27, 2025

Hey hey, I just saw this as I was launching the new prometheus.io homepage at the Berlin Prometheus meetup and had to merge it into my PR branch for that. I noticed a few things:

  • The sort_rank frontmatter fields need to be adjusted relative to their existing sibling documents in the same folder, I took the liberty to fix those in 60c4d88
  • The documents are currently under "Concepts", but that top-level menu point is meant for basic Prometheus concepts that every Prometheus beginner should familiarize themselves with. The new docs are more detailed specifications that only some experts need to know, and not something a new Prometheus user should be confronted with. I talked with @beorn7 about it at the meetup as well - how about moving these to "Instrumenting", since they are both about that, and there are similar docs like that already under there? It almost sounds like the two docs are related to the existing "Exposition Formats" doc under there. I wonder if opening a new subsection under "Instrumenting" for all three would make sense, or otherwise combining them somehow?
  • The titles of the documents are quite long - that's fine for the page itself, but nav and prev/next pagination buttons weren't really made with such long titles in mind. You can set an alternate title to be shown in the side nav using the nav_title frontmatter field, which could be shorter.

@juliusv
Copy link
Member

juliusv commented May 27, 2025

I'll make a PR with a beginning of a move to the "Instrumenting" section. It does seem like both new sections should be referenced from (if not merged with) https://prometheus.io/docs/instrumenting/exposition_formats/.

juliusv added a commit that referenced this pull request May 27, 2025
See #2653 (comment)

Also change the titles:

* "Prometheus" is redundant in the context of Prometheus, let's make it
  more about UTF-8
* Make the nav titles shorter so they fit nicer into the nav (title
  on the page itself can still be long)

Signed-off-by: Julius Volz <[email protected]>
juliusv added a commit that referenced this pull request May 27, 2025
See #2653 (comment)

Also change the titles:

* "Prometheus" is redundant in the context of Prometheus, let's make it
  more about UTF-8
* Make the nav titles shorter so they fit nicer into the nav (title
  on the page itself can still be long)
* We don't use title casing (at least in the "Instrumenting" section), so
  lower-casing the titles

Signed-off-by: Julius Volz <[email protected]>
@juliusv
Copy link
Member

juliusv commented May 27, 2025

See: #2657

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.

4 participants