-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Conversation
b6add48
to
19bcc8e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
19bcc8e
to
3d8c0f6
Compare
3d8c0f6
to
b4873c6
Compare
7bc2f3c
to
cba8b29
Compare
There was a problem hiding this 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 👇
content/docs/guides/utf8.md
Outdated
@@ -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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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]>
18594f0
to
e3e35a1
Compare
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]>
Signed-off-by: Owen Williams <[email protected]>
I did some more polishing, would appreciate one final look over |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
|
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/. |
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]>
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]>
See: #2657 |
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.