Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Metrics UI] Add back context variables with descriptions #67487

Merged
merged 11 commits into from
Jun 4, 2020

Conversation

phillipb
Copy link
Contributor

Summary

Add back the old context variables with clearer names and descriptions. Fixes: #65974.

Screen Shot 2020-05-27 at 9 33 09 AM

Checklist

Delete any items that are not applicable to this PR.

@phillipb phillipb added release_note:enhancement Feature:Metrics UI Metrics UI feature v8.0.0 Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v7.9.0 labels May 27, 2020
@phillipb phillipb requested a review from a team as a code owner May 27, 2020 14:37
@elasticmachine
Copy link
Contributor

Pinging @elastic/logs-metrics-ui (Team:logs-metrics-ui)

@phillipb
Copy link
Contributor Author

@elasticmachine merge upstream

@sorantis
Copy link

@phillipb From the user's perspective it's not clear that each of these context variables is followed by conditionN. Some users reported the following output, which indicated that they didn't use these variables correctly.

alertid:c6b3c440-5d14-49be-bc16-9dae92386ffe
alertName:test
spaceId:default
tags:test
alertInstanceId:304ef5a3-a6b9-4ee3-8ffb-8e2742bd3a7b-hayate
context.group:test
context.valueOf:[object Object]
context.thresholdOf:[object Object]
context.metricOf:[object Object]

Can we clarify it somehow? Maybe by default add condition0 to each context variable as soon as the user clicks on the dropdown? Thoughts?

@phillipb
Copy link
Contributor Author

phillipb commented May 27, 2020

@sorantis yeah, I added this issue to address that #67396. It's now added to 7.9 as a documentation fix.

Because the number of conditions is dynamic and the context variable list is static, not sure how we could create a better UX. We could hardcode some values in the context for example ctx.value.condition0, ctx.value.condition1, but that would fail if there were only one condition.

Unfortunately, we don't control the context variable dropdown, so we can't change what's inserted in the message when a user clicks a variable.

@sorantis
Copy link

By all means we should update our docs. I'm wondering if there's any way we could put this information on the UI too. It feels like the docs will be helpful only after the user has already struggled with making it work :)

@phillipb
Copy link
Contributor Author

phillipb commented Jun 1, 2020

@sorantis we could link to think docs from the flyout maybe? We could also file an issue with kibana-alerting to see if they have thoughts or plans around this.

@phillipb
Copy link
Contributor Author

phillipb commented Jun 1, 2020

@elasticmachine merge upstream

@phillipb
Copy link
Contributor Author

phillipb commented Jun 4, 2020

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Contributor

@Zacqary Zacqary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go

@phillipb phillipb merged commit a4549a7 into elastic:master Jun 4, 2020
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jun 8, 2020
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 67487 or prevent reminders by adding the backport:skip label.

5 similar comments
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 67487 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 67487 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 67487 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 67487 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 67487 or prevent reminders by adding the backport:skip label.

phillipb added a commit to phillipb/kibana that referenced this pull request Jun 15, 2020
)

* Add context variables for metric, value and threshold with descriptions

* Remove timestamp from this PR

* sentences are hard

* Fix lint rules

* Add more usage examples

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jun 16, 2020
phillipb added a commit that referenced this pull request Jun 16, 2020
…69216)

* Add context variables for metric, value and threshold with descriptions

* Remove timestamp from this PR

* sentences are hard

* Fix lint rules

* Add more usage examples

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Metrics UI Metrics UI feature release_note:enhancement Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v7.9.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Metrics UI] Add back metricOf and thresholdOf parameters
5 participants