Prometheus: Add capability to filter label names by metric in template variable editor #70452
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… are failing in drone, but not locally
gtk-grafana
requested review from
a team,
grafanabot and
lwandz13
as code owners
bohandley
reviewed
Jun 21, 2023
public/app/plugins/datasource/prometheus/components/VariableQueryEditor.tsx
Outdated
Show resolved
Hide resolved
bohandley
reviewed
Jun 21, 2023
| @@ -164,15 +171,21 @@ export const PromVariableQueryEditor = ({ onChange, query, datasource }: Props) | |||
| } | |||
| }; | |||
|
|
|||
| const onLabelNamesMatchChange = (regex: string) => { | |||
There was a problem hiding this comment.
Did we want to only call onchange with the blur event?
There was a problem hiding this comment.
I would argue so, running a query on change only works on prometheus instances where you don't mind running extra or partial queries. Onblur gives you time to write whatever regex/metric names you want without pinging the server before you're ready.
bohandley
reviewed
Jun 21, 2023
| /** | ||
| * Call onchange for metric change if metrics names (regex) query type | ||
| * Debounce this because to not call the API for every keystroke. | ||
| */ | ||
| const onMetricChange = debounce((value: string) => { | ||
| const onMetricChange = (value: string) => { |
There was a problem hiding this comment.
Was the debounce not working correctly here?
There was a problem hiding this comment.
It wasn't debouncing, it would just delay each execution 300ms, so three keystrokes would cause 3 queries
bohandley
reviewed
Jun 21, 2023
| @@ -967,7 +967,7 @@ export class PrometheusDatasource | |||
| // this is used to get label keys, a.k.a label names | |||
| // it is used in metric_find_query.ts | |||
| // and in Tempo here grafana/public/app/plugins/datasource/tempo/QueryEditor/ServiceGraphSection.tsx | |||
| async getTagKeys(options?: any) { | |||
| async getTagKeys(options?: { series: string[] }) { | |||
bohandley
reviewed
Jun 22, 2023
public/app/plugins/datasource/prometheus/components/VariableQueryEditor.test.tsx
Outdated
Show resolved
Hide resolved
…eryEditor.test.tsx Co-authored-by: Brendan O'Handley <brendan.ohandley@grafana.com>
gtk-grafana
changed the title
gtk-grafana
changed the title
gtk-grafana
changed the title
gtk-grafana
changed the title
LudoVio
pushed a commit
that referenced
this pull request
Jun 26, 2023
…e variable editor (#70452) * Adds new text input in prometheus template variable UI that allows label names function to filter values by metric. Co-authored-by: Brendan O'Handley <brendan.ohandley@grafana.com>
harisrozajac
pushed a commit
that referenced
this pull request
Jun 30, 2023
…e variable editor (#70452) * Adds new text input in prometheus template variable UI that allows label names function to filter values by metric. Co-authored-by: Brendan O'Handley <brendan.ohandley@grafana.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this feature?
Currently if you want to use the label names in the variable editor, you have to use ALL of them. Which can be a tad much for many use-cases:
The "label names" function in Grafana is an interface for the prometheus /api/v1/labels endpoint. The new input field introduced in this PR provides a way to optionally provide a value for the
match[]parameter.Why do we need this feature?
To help Prometheus users build templated dashboards. People can have many thousands of labels, at which point dumping them all into a variable is not great UX. This allows folks to limit the labels returned to whatever metric names match the provided regex. Example: If I want the labels from
node_arp_entries, andprometheus_build_info, I can write a query ofnode_arp_entries|prometheus_build_infowhich will return all the labels from those metrics.Who is this feature for?
Prometheus users with lots of labels.
Which issue(s) does this PR fix?:
Fixes #70451
Special notes for your reviewer:
Also I wanted it to work with partial strings, for example
node_arp_entrwould be sent as.*node_arp_entr.*, if users want it to match multiple things likenode_arp_|prometheus_build_they'll need to build a proper regexnode_arp_.*|prometheus_build_.*, which will output.*node_arp_.*|prometheus_build_.*.*, which looks weird but still should return the proper results, except this might require folks to assert the start and end of the strings explicitly (^node_arp_.*|^prometheus_build_entries$) to prevent any metrics that containnode_arp_but don't start with it.Edit: Another UI I can imagine is we provide repeatable inputs, each with another match[] parameter.
Please check that: