Docs: Explain how to enable experimental PromQL functions #10712
Conversation
|
💻 Deploy preview available: https://deploy-preview-mimir-10712-zb444pucvq-vp.a.run.app/docs/mimir/latest/ |
56quarters
force-pushed
the
56quarters/exp-func-docs
branch
from
91a134b to
6a4a433
Compare
Related to #10660 Signed-off-by: Nick Pillitteri <nick.pillitteri@grafana.com>
56quarters
force-pushed
the
56quarters/exp-func-docs
branch
from
6a4a433 to
c7a7d51
Compare
|
|
||
| # Configure experimental PromQL functions | ||
|
|
||
| Experimental PromQL functions are disabled by default in Mimir. They can be selectively enabled per-tenant or globally for all users. |
There was a problem hiding this comment.
[nit] Could we list or link to a list of experimental PromQL functions?
Might also be useful to include the error message that is returned when an experimental PromQL function is used so that someone searching for it sees this page.
There was a problem hiding this comment.
[nit] Could we list or link to a list of experimental PromQL functions?
Yep, but there's the danger of it going out of date. Not sure how much of an issue that is in practice.
Might also be useful to include the error message that is returned when an experimental PromQL function is used so that someone searching for it sees this page.
Good idea!
|
|
||
| # Configure experimental PromQL functions | ||
|
|
||
| Experimental PromQL functions are disabled by default in Mimir. They can be selectively enabled per-tenant or globally for all users. |
There was a problem hiding this comment.
| Experimental PromQL functions are disabled by default in Mimir. They can be selectively enabled per-tenant or globally for all users. | |
| Experimental PromQL functions are disabled by default in Mimir. You can selectively enable them per-tenant or globally for all users. |
There was a problem hiding this comment.
We can use active voice here.
| # Configure experimental PromQL functions | ||
|
|
||
| Experimental PromQL functions are disabled by default in Mimir. They can be selectively enabled per-tenant or globally for all users. | ||
| All functions can be enabled using the special function name `all` or each individual function can be enabled specifically. |
There was a problem hiding this comment.
| All functions can be enabled using the special function name `all` or each individual function can be enabled specifically. | |
| You can enable all functions using the special function name `all`, or you can specifically enable individual functions. |
| enabled_promql_experimental_functions: info,sort_by_label,sort_by_label_desc | ||
| ``` | ||
|
|
||
| You can enable functions for specific tenants using [per-tenant overrides]({{< relref "./about-runtime-configuration" >}}): |
There was a problem hiding this comment.
We should use the full URL here instead of a relref.
| enabled_promql_experimental_functions: all | ||
| ``` | ||
|
|
||
| Blocking or allowing use of experimental PromQL functions is enforced on instant and range queries. |
There was a problem hiding this comment.
| Blocking or allowing use of experimental PromQL functions is enforced on instant and range queries. | |
| Blocking or allowing the use of experimental PromQL functions is enforced on instant and range queries. |
Which issue(s) this PR fixes or relates to
Related to #10660
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.