Dashboard: Update query group options #63138

songhn233 · 2023-02-08T19:13:43Z

What is this feature?

In the dashboard, tooltips have been added to some of the options in , see Grafana's documentation for a description of these options
Minutiae: The switch component is centered in the row
Modified the placeholder for Relative time and Time shift, the exact values may need to be discussed, my modifications are what I think is appropriate.

Why do we need this feature?

Modified the placeholder

Max data points and Min interval (or all fields except for the time-related field) are real values, otherwise, they are a null text description (No limit is displayed when Min interval is missing)

So two fields about time originally set to 1h may lead to the interpretation that they take exactly 1h (but are null) in this context, and such a placeholder setting may lead to misunderstandings, so it can be set to a null literal like No limit.

For Time shift set to 0h because it runs as 0h when it is null, and also implies the format of the input (math string)

Before:

After:

tooltip and center styles

Other fields have corresponding descriptions, while the meaning of the time-related fields is not quite easy to understand, so some of the descriptions are quoted from the documentation.

CLAassistant · 2023-02-08T19:13:51Z

All committers have signed the CLA.

songhn233 · 2023-02-13T09:07:55Z

@dprokop Hello, would you mind assisting with reviewing this change?

grafanabot · 2023-03-16T01:59:19Z

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!

songhn233 · 2023-03-20T13:48:58Z

@JoaoSilvaGrafana @kaydelaney. Hey, Would you be able to take a look and provide some feedback? Thank you for the time.

grafanabot · 2023-04-22T01:54:11Z

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!

grafanabot · 2023-05-24T01:58:12Z

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!

dprokop

Thanks for your contibution @songhn233, and sorry for such a long wait time!

I've left some nits to fix, other than that the PR looks good!

public/app/features/query/components/QueryGroupOptions.tsx

songhn233 · 2023-05-27T03:01:14Z

@dprokop Thanks for your reply and code review. I have committed the changes according to your suggestions.

I also added a comment. Could you please review to see if any further modifications are necessary?

axelavargas

Hey @songhn233 👋🏾, thank you for your contribution. I've reviewed the PR and it looks good to me. However, there's a minor change that needs to be addressed. Also, please make sure to merge this branch with the latest main branch. :D

axelavargas · 2023-06-13T09:31:33Z

public/app/features/query/components/QueryGroupOptions.tsx

+            tooltip={
+              <>
+                Overrides the relative time range for individual panels, which causes them to be different than what is
+                selected in the dashboard time picker in the top-right corner of the dashboard.


🤔 I think we could add an example of values that we support. This will help the user to know what is possible and what kind of relative format they should put. Maybe, something like:

For example to configure the Last 5 minutes the Relative time should be now-5m

Hey, I made some minor changes including adding examples and updating the time shift placeholder to match the other configurations.

Co-authored-by: Dominik Prokop <[email protected]>

songhn233 · 2023-06-13T17:25:52Z

Hey @axelavargas, Thanks for your review. I have added some additional explanations for interval field, because its calculation is not exactly equal to the Time range / max data points described on the right.

axelavargas

Hey @songhn233 👋🏾, thank you once again for implementing the updates. I dedicated some time to review the modifications you made concerning the placeholders and have left a few comments 😄.

public/app/features/query/components/QueryGroupOptions.tsx

Co-authored-by: Dominik Prokop <[email protected]>

axelavargas

Hey @songhn233 , thanks for the updates on the changes – they look fantastic! 🌟 From my perspective, this PR is ready. We just need @dprokop to grant approval (since he requested changes earlier, and we can't merge without it 🙂).

* Dashboard: update query group options * chore: remove unused `console` Co-authored-by: Dominik Prokop <[email protected]> * fix: update placeholder Co-authored-by: Dominik Prokop <[email protected]> * feat(QueryGroupOptions): add tooltip example values * feat(QueryGroupOptions): update interval tooltip * Update public/app/features/query/components/QueryGroupOptions.tsx Co-authored-by: Dominik Prokop <[email protected]> * Update QueryGroupOptions.tsx --------- Co-authored-by: Dominik Prokop <[email protected]>

songhn233 requested a review from a team as a code owner February 8, 2023 19:13

songhn233 requested review from dprokop and kaydelaney and removed request for a team February 8, 2023 19:13

grafanabot added area/frontend pr/external This PR is from external contributor labels Feb 8, 2023

grafanabot added stale Issue with no recent activity and removed stale Issue with no recent activity labels Mar 16, 2023

grafanabot added stale Issue with no recent activity and removed stale Issue with no recent activity labels Apr 22, 2023

grafanabot added stale Issue with no recent activity and removed stale Issue with no recent activity labels May 24, 2023

dprokop requested changes May 26, 2023

View reviewed changes

public/app/features/query/components/QueryGroupOptions.tsx Outdated Show resolved Hide resolved

public/app/features/query/components/QueryGroupOptions.tsx Outdated Show resolved Hide resolved

dprokop added the backport v10.0.x label May 26, 2023

dprokop added this to the 10.0.x milestone May 26, 2023

dprokop added the no-changelog Skip including change in changelog/release notes label May 26, 2023

This comment was marked as resolved.

Sign in to view

grafanabot added the missing-labels label May 26, 2023

dprokop added no-backport Skip backport of PR product-approved Pull requests that are approved by product/managers and are allowed to be backported and removed backport v10.0.x missing-labels labels May 26, 2023

songhn233 requested a review from dprokop May 27, 2023 03:01

axelavargas reviewed Jun 13, 2023

View reviewed changes

axelavargas added add to changelog and removed add to changelog labels Jun 13, 2023

songhn233 and others added 4 commits June 13, 2023 23:54

Dashboard: update query group options

05f84fe

chore: remove unused console

f6501b2

Co-authored-by: Dominik Prokop <[email protected]>

fix: update placeholder

e0ad79c

Co-authored-by: Dominik Prokop <[email protected]>

feat(QueryGroupOptions): add tooltip example values

500c5d3

songhn233 force-pushed the feat-query-group branch from 7100516 to 500c5d3 Compare June 13, 2023 15:54

axelavargas changed the title ~~Dashboard: update query group options~~ Dashboards: update query group options Jun 13, 2023

axelavargas changed the title ~~Dashboards: update query group options~~ Dashboard: Update query group options Jun 13, 2023

songhn233 changed the title ~~Dashboard: Update query group options~~ Dashboard: Optimize query group options tooltips and placeholder Jun 13, 2023

songhn233 changed the title ~~Dashboard: Optimize query group options tooltips and placeholder~~ Dashboard: Update query group options tooltips and placeholder Jun 13, 2023

songhn233 changed the title ~~Dashboard: Update query group options tooltips and placeholder~~ Dashboard: Update query group options Jun 13, 2023

songhn233 requested a review from axelavargas June 13, 2023 17:12

feat(QueryGroupOptions): update interval tooltip

befaec2

axelavargas reviewed Jun 14, 2023

View reviewed changes

public/app/features/query/components/QueryGroupOptions.tsx Outdated Show resolved Hide resolved

public/app/features/query/components/QueryGroupOptions.tsx Outdated Show resolved Hide resolved

songhn233 and others added 2 commits June 15, 2023 03:10

Update public/app/features/query/components/QueryGroupOptions.tsx

456fe60

Co-authored-by: Dominik Prokop <[email protected]>

Update QueryGroupOptions.tsx

cee478a

natellium added the area/panel/edit label Jun 16, 2023

ivanortegaalba assigned dprokop Jun 16, 2023

axelavargas approved these changes Jun 20, 2023

View reviewed changes

dprokop approved these changes Jun 22, 2023

View reviewed changes

dprokop removed the backport v10.0.x label Jun 22, 2023

dprokop merged commit c455b01 into grafana:main Jun 22, 2023

ricky-undeadcoders modified the milestones: 10.1.x, 10.1.0 Aug 1, 2023

chenrui333 mentioned this pull request Aug 24, 2023

grafana 10.1.0 Homebrew/homebrew-core#140321

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dashboard: Update query group options #63138

Dashboard: Update query group options #63138

songhn233 commented Feb 8, 2023

CLAassistant commented Feb 8, 2023 •

edited

Loading

songhn233 commented Feb 13, 2023

grafanabot commented Mar 16, 2023

songhn233 commented Mar 20, 2023 •

edited

Loading

grafanabot commented Apr 22, 2023

grafanabot commented May 24, 2023

dprokop left a comment

This comment was marked as resolved.

songhn233 commented May 27, 2023

axelavargas left a comment

axelavargas Jun 13, 2023

songhn233 Jun 13, 2023 •

edited

Loading

songhn233 commented Jun 13, 2023 •

edited

Loading

axelavargas left a comment

axelavargas left a comment

Dashboard: Update query group options #63138

Dashboard: Update query group options #63138

Conversation

songhn233 commented Feb 8, 2023

CLAassistant commented Feb 8, 2023 • edited Loading

songhn233 commented Feb 13, 2023

grafanabot commented Mar 16, 2023

songhn233 commented Mar 20, 2023 • edited Loading

grafanabot commented Apr 22, 2023

grafanabot commented May 24, 2023

dprokop left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

songhn233 commented May 27, 2023

axelavargas left a comment

Choose a reason for hiding this comment

axelavargas Jun 13, 2023

Choose a reason for hiding this comment

songhn233 Jun 13, 2023 • edited Loading

Choose a reason for hiding this comment

songhn233 commented Jun 13, 2023 • edited Loading

axelavargas left a comment

Choose a reason for hiding this comment

axelavargas left a comment

Choose a reason for hiding this comment

CLAassistant commented Feb 8, 2023 •

edited

Loading

songhn233 commented Mar 20, 2023 •

edited

Loading

songhn233 Jun 13, 2023 •

edited

Loading

songhn233 commented Jun 13, 2023 •

edited

Loading