UTF-8 Content Negotiation #1102
Conversation
| @@ -37,7 +37,7 @@ | |||
| 'write_to_textfile', | |||
| ) | |||
|
|
|||
| CONTENT_TYPE_LATEST = 'text/plain; version=0.0.4; charset=utf-8' | |||
| CONTENT_TYPE_PLAIN = 'text/plain; version=0.0.4; charset=utf-8' | |||
There was a problem hiding this comment.
text/plain v 0.0.4 is not the latest, so I thought it best to rename this
There was a problem hiding this comment.
Though I agree with you, this will be a breaking change as other programs use CONTENT_TYPE_LATEST. Perhaps we should update this to version=1.0.0 instead?
|
TODO need more openmetrics/exposition tests |
ywwg
force-pushed
the
owilliams/utf8-02
branch
2 times, most recently
from
33ea581 to
630fb65
Compare
|
|
||
|
|
||
| def _escape(s: str) -> str: | ||
| def _escape(s: str, escaping: str, is_labelname: bool) -> str: |
There was a problem hiding this comment.
I don't love how messy this function signature is getting...
There was a problem hiding this comment.
Yeah, it is internal only so not the end of the world. Would it help at all to have a second function for specifically escaping label names?
There was a problem hiding this comment.
I tried another approach that looks better
ywwg
changed the title
Signed-off-by: Owen Williams <[email protected]>
| @@ -37,7 +37,7 @@ | |||
| 'write_to_textfile', | |||
| ) | |||
|
|
|||
| CONTENT_TYPE_LATEST = 'text/plain; version=0.0.4; charset=utf-8' | |||
| CONTENT_TYPE_PLAIN = 'text/plain; version=0.0.4; charset=utf-8' | |||
There was a problem hiding this comment.
Though I agree with you, this will be a breaking change as other programs use CONTENT_TYPE_LATEST. Perhaps we should update this to version=1.0.0 instead?
prometheus_client/exposition.py
Outdated
| escaping = _get_escaping(toks) | ||
| # Only return an escaping header if we have a good version and | ||
| # mimetype. | ||
| if version == '1.0.0': |
There was a problem hiding this comment.
Should this test that the version is at least 1.0.0? I imagine at least anything in 1.x should be ok?
There was a problem hiding this comment.
looks like there's a python lib for that!
There was a problem hiding this comment.
lmk if I should just test for major version versus any >= version
There was a problem hiding this comment.
(I think any greater version should be fine)
|
|
||
|
|
||
| def _escape(s: str) -> str: | ||
| def _escape(s: str, escaping: str, is_labelname: bool) -> str: |
There was a problem hiding this comment.
Yeah, it is internal only so not the end of the world. Would it help at all to have a second function for specifically escaping label names?
tools/simple_client.py
Outdated
There was a problem hiding this comment.
Is this used anywhere? Or just a nice example for testing locally?
There was a problem hiding this comment.
but is also pretty nice for people to get off the ground
we do still need a 0.0.4 constant as the fallback when all else fails. What I could do is update LATEST to be 1.0.0 and then create the new PLAIN constant for 0.0.4 |
Part of #1013
The remaining piece is configuration to force escaping even if a scraper does not request it