zentol commented on a change in pull request #14326:
URL: https://github.com/apache/flink/pull/14326#discussion_r539494137
##########
File path: docs/ops/metrics.md
##########
@@ -1654,6 +1654,9 @@ Request metrics aggregated over a subset of all entities
of the respective type:
- `/jobs/metrics?jobs=D,E,F`
- `/jobs/<jobid>/vertices/<vertexid>/subtasks/metrics?subtask=1,2,3`
+<span class="label label-danger">Warning</span> Metric names can contain
special characters (`?`, `&`, `$`, `+`, `/`, `,`, `:`, `=`, `@`, `%`) that you
need to be escape when querying metrics.
Review comment:
I had hoped that the example gives users enough of a reference to find a
table.
The only _official_(?) reference I could find for which characters to escape
is this [RFC](https://tools.ietf.org/html/rfc3986#section-2.2), but it's not as
readable as I would like.
[This](https://secure.n-able.com/webhelp/NC_9-1-0_SO_en/Content/SA_docs/API_Level_Integration/API_Integration_URLEncoding.html)
page was the basis for which characters I explicitly listed, but it is not
really consistent with the RFC.
I originally did not want to list any characters at all, but with the RFC
being _eh_ and all other sources not being _official_ I couldn't find solution
I really liked.
As for how to escape, it is essentially just "% + ascii_hex(character)",
which I can add.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
