Prometheus Datasource: Improve Prom query variable editor #58292

bohandley · 2022-11-05T16:19:54Z

Fixes #59559 (allow newlines in Prom query result variable query editor)
Fixes https://github.com/grafana/observability-metrics-squad/issues/48

What is this feature?
This changes the prometheus query variable editor to a group of selects and inputs to better explain the functions, arguments, and endpoint calls used in the prometheus variable queries.

Previous single input:

New function select and variable inputs:

Full proposal here.

Why do we need this feature?
This is in line with the Grafana 10 goal of "Getting Started." More clarity around creating variables in Prometheus will help onboard new customers.

Who is this feature for?
This feature is for anyone using the Prometheus datasource plugin who wants to create template variables.
This is for all users of prometheus datasource plugin, from expert to beginner.

Special notes for your reviewer:

Please create a prometheus variable in the main branch, for example, label_names()
Switch to the new branch and open the variable editor to see that the function has been correctly passed to the inputs.
Check that the variables are returned.
Look for confusing language and readability. Are the tooltips helpful?

grafanabot · 2022-11-05T16:43:30Z

Drone build failed: https://drone.grafana.net/grafana/grafana-enterprise/41131

itsmylife

After I check this locally I will approve it.

public/app/plugins/datasource/prometheus/metric_find_query.ts

itsmylife · 2022-11-07T18:29:39Z

public/app/plugins/datasource/prometheus/migrations/variableMigration.ts

+const labelNamesRegex = /^label_names\(\)\s*$/;
+const labelValuesRegex = /^label_values\((?:(.+),\s*)?([a-zA-Z_][a-zA-Z0-9_]*)\)\s*$/;
+const metricNamesRegex = /^metrics\((.+)\)\s*$/;
+const queryResultRegex = /^query_result\((.+)\)\s*$/;


Are those all the options that we can use? I remember we can use scalar() too.

While scalar() is a function provided by Prometheus, these are function created by Grafana to list variables. The scalar() function can be used in the query_result() function like so, query_result(scalar(<some prom query>))

grafanabot · 2022-11-11T18:46:04Z

Drone build failed: https://drone.grafana.net/grafana/grafana-enterprise/41931

grafanabot · 2022-11-11T19:15:59Z

Drone build failed: https://drone.grafana.net/grafana/grafana-enterprise/41935

grafanabot · 2022-11-15T13:33:48Z

This pull request was removed from the 9.3.0-beta1 milestone because 9.3.0-beta1 is currently being released.

itsmylife · 2022-11-29T20:57:19Z

For instance for the "label values" we had this before:

After this change we have this:

There is no way to get explicitly label values of one metric. Or am I missing something?

itsmylife · 2022-11-29T20:59:27Z

This is from one of my existing dashboards. It doesn't seem to handle existing variables properly.

bohandley · 2022-11-29T23:22:28Z

For instance for the "label values" we had this before:

After this change we have this:

There is no way to get explicitly label values of one metric. Or am I missing something?

Oh! This could cause a problem. I brought Galen's check for the label values endpoint into this work, so if a prometheus datasource doesn't have flavor and version defined in the configuration page, and the flavor and version specified don't have this end point, a user cannot query with this. I think I might have to remove this because it assumes people have configured their datasource page, but they don't have to do that.

bohandley · 2022-11-29T23:23:32Z

@itsmylife I think I will have to remove the flavor and version check for that function label_values!

public/app/plugins/datasource/prometheus/components/VariableQueryEditor.tsx

public/app/plugins/datasource/prometheus/migrations/variableMigration.ts

grafanabot · 2023-01-01T02:07:06Z

This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 2 weeks if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

…not set there flavor and version

…ev named getTagKeys()

…igration

…ility

…eryEditor.tsx Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>

…8292)" This reverts commit eedcd7d.

…63278) Revert "Prometheus Datasource: Improve Prom query variable editor (#58292)" This reverts commit eedcd7d.

* add prom query var editor with tests and migrations * fix migration, now query not expr * fix label_values migration * remove comments * fix label_values() variables order * update UI and use more clear language * fix tests * use null coalescing operators * allow users to query label values with label and metric if they have not set there flavor and version * use enums instead of numbers for readability * fix label&metrics switch * update type in qv editor * reuse datasource function to get all label names, getLabelNames(), prev named getTagKeys() * use getLabelNames in the query var editor * make label_values() variables label and metric more readable in the migration * fix tooltip for label_values to remove API reference * clean up tooltips and allow newlines in query_result function * change function wording and exprType to query type/qryType for readability * update prometheus query variable docs * Update public/app/plugins/datasource/prometheus/components/VariableQueryEditor.tsx Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com> --------- Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>

…63278) Revert "Prometheus Datasource: Improve Prom query variable editor (#58292)" This reverts commit eedcd7d.

bohandley added datasource/Prometheus area/frontend add to changelog no-backport Skip backport of PR labels Nov 5, 2022

bohandley added this to the 9.3.0 milestone Nov 5, 2022

bohandley self-assigned this Nov 5, 2022

bohandley requested review from a team and joshhunt as code owners November 5, 2022 16:19

grafanabot added the enterprise-failed label Nov 5, 2022

bohandley added the pr/early-feedback WIP state but looking for early feedback label Nov 7, 2022

itsmylife reviewed Nov 7, 2022

View reviewed changes

bohandley removed the pr/early-feedback WIP state but looking for early feedback label Nov 11, 2022

leandro-deveikis modified the milestones: 9.3.0, 9.3.0-beta1 Nov 14, 2022

grafanabot removed this from the 9.3.0-beta1 milestone Nov 15, 2022

bohandley added this to the 9.4.0 milestone Nov 28, 2022

bohandley added no-backport Skip backport of PR and removed no-backport Skip backport of PR labels Nov 28, 2022

gtk-grafana reviewed Nov 30, 2022

View reviewed changes

public/app/plugins/datasource/prometheus/components/VariableQueryEditor.tsx Outdated Show resolved Hide resolved

gtk-grafana reviewed Nov 30, 2022

View reviewed changes

public/app/plugins/datasource/prometheus/migrations/variableMigration.ts Outdated Show resolved Hide resolved

bohandley mentioned this pull request Nov 30, 2022

Template Variables: Query-based vars fail silently (plus other bugs & poor UX) #59495

Open

bohandley added the add to changelog label Feb 9, 2023

bohandley and others added 20 commits February 9, 2023 15:22

add prom query var editor with tests and migrations

c0fa865

fix migration, now query not expr

d5bf616

fix label_values migration

757b3cc

remove comments

3c2fd45

fix label_values() variables order

f9eb1c1

update UI and use more clear language

4fd36a7

fix tests

2044f7a

use null coalescing operators

bd52f37

allow users to query label values with label and metric if they have …

67ad83d

…not set there flavor and version

use enums instead of numbers for readability

1b2945c

fix label&metrics switch

420259f

update type in qv editor

7575792

reuse datasource function to get all label names, getLabelNames(), pr…

5064482

…ev named getTagKeys()

use getLabelNames in the query var editor

46e62aa

make label_values() variables label and metric more readable in the m…

3407154

…igration

fix tooltip for label_values to remove API reference

ed9efe8

clean up tooltips and allow newlines in query_result function

75a0eb0

change function wording and exprType to query type/qryType for readab…

6766852

…ility

update prometheus query variable docs

9158cac

Update public/app/plugins/datasource/prometheus/components/VariableQu…

f37e340

…eryEditor.tsx Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>

bohandley force-pushed the bohandley/improve-prom-query-var-editor branch from da6da15 to f37e340 Compare February 9, 2023 20:22

bohandley merged commit eedcd7d into main Feb 9, 2023

bohandley deleted the bohandley/improve-prom-query-var-editor branch February 9, 2023 20:35

bohandley added a commit that referenced this pull request Feb 10, 2023

Revert "Prometheus Datasource: Improve Prom query variable editor (#5…

61cac6b

…8292)" This reverts commit eedcd7d.

bohandley mentioned this pull request Feb 10, 2023

Revert "Prometheus Datasource: Improve Prom query variable editor" #63278

Merged

bohandley added a commit that referenced this pull request Feb 10, 2023

Revert "Prometheus Datasource: Improve Prom query variable editor" (#…

879f980

…63278) Revert "Prometheus Datasource: Improve Prom query variable editor (#58292)" This reverts commit eedcd7d.

ryantxu pushed a commit that referenced this pull request Feb 10, 2023

Revert "Prometheus Datasource: Improve Prom query variable editor" (#…

396b269

…63278) Revert "Prometheus Datasource: Improve Prom query variable editor (#58292)" This reverts commit eedcd7d.

ryantxu pushed a commit that referenced this pull request Mar 2, 2023

Revert "Prometheus Datasource: Improve Prom query variable editor" (#…

ea33156

…63278) Revert "Prometheus Datasource: Improve Prom query variable editor (#58292)" This reverts commit eedcd7d.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prometheus Datasource: Improve Prom query variable editor #58292

Prometheus Datasource: Improve Prom query variable editor #58292

bohandley commented Nov 5, 2022 •

edited

Loading

grafanabot commented Nov 5, 2022

itsmylife left a comment

itsmylife Nov 7, 2022

bohandley Nov 11, 2022

grafanabot commented Nov 11, 2022

grafanabot commented Nov 11, 2022

grafanabot commented Nov 15, 2022

itsmylife commented Nov 29, 2022

itsmylife commented Nov 29, 2022

bohandley commented Nov 29, 2022

bohandley commented Nov 29, 2022

grafanabot commented Jan 1, 2023

Prometheus Datasource: Improve Prom query variable editor #58292

Prometheus Datasource: Improve Prom query variable editor #58292

Conversation

bohandley commented Nov 5, 2022 • edited Loading

grafanabot commented Nov 5, 2022

itsmylife left a comment

Choose a reason for hiding this comment

itsmylife Nov 7, 2022

Choose a reason for hiding this comment

bohandley Nov 11, 2022

Choose a reason for hiding this comment

grafanabot commented Nov 11, 2022

grafanabot commented Nov 11, 2022

grafanabot commented Nov 15, 2022

itsmylife commented Nov 29, 2022

itsmylife commented Nov 29, 2022

bohandley commented Nov 29, 2022

bohandley commented Nov 29, 2022

grafanabot commented Jan 1, 2023

bohandley commented Nov 5, 2022 •

edited

Loading