[Uptime] Show troubleshoot guide on missing monitors #128527

shahzad31 · 2022-03-24T18:12:31Z

Summary

It shows the troubleshoot guide in case user has data in pings over time chart and none in monitor list.

Testing

Start heartbeat or connector remote_cluster:heartbeat using oblt cli cluster
Change your system clock to 5-6 mins in future
You will see many monitors will disappear, search for Elasticsearch monitor.
This will show the exact state and trouble shoot guide

shahzad31 · 2022-03-28T17:46:39Z

i added one more condition in the query, in case last date range is now in that case instead of converting timespan range to absolute value, it will keep it as now and now-5m, this means, even if kibana clock is out of sync, queries should work fine, since now will be calculated at elasticsearch, though it will not solve heartbeat clock issue, for that user will be show that trouble shoot guide

hbharding · 2022-03-29T21:12:36Z

x-pack/plugins/uptime/public/components/overview/monitor_list/troubleshoot_popover.tsx

+      <div style={{ width: '300px' }}>
+        <EuiText size="s">
+          <p>
+            <FormattedMessage


See note on improving text

elasticmachine · 2022-03-29T21:12:40Z

Pinging @elastic/uptime (Team:uptime)

hbharding · 2022-03-29T21:13:14Z

x-pack/plugins/uptime/public/components/overview/monitor_list/troubleshoot_popover.tsx

+        </EuiText>
+      </div>
+      <EuiPopoverFooter>
+        <EuiButton


Add the "calendar" icon to the button so its associated with the date time picker

hbharding · 2022-03-29T21:24:07Z

x-pack/plugins/uptime/public/components/overview/monitor_list/troubleshoot_popover.tsx

+  return (
+    <EuiPopover
+      button={
+        <EuiButtonEmpty iconType="arrowDown" iconSide="right" onClick={onButtonClick}>


remove icon from button. Could be confused as an accordion since it appears in the context of a table.

hbharding

Thanks @shahzad31,

I wasn't able to test this locally, but I have a few suggestions. I recall seeing you demo this, so I'm picturing this in my head and recreated in Figma from memory. Apologies if I missed something.

We might not be able to address everything I'm proposing before FF, but I suggest we at least improve the popover text. Overall, great job!

Your last comment about a new condition

i added one more condition in the query, in case last date range is now in that case instead of converting timespan range to absolute value, it will keep it as now and now-5m, this means, even if kibana clock is out of sync, queries should work fine, since now will be calculated at elasticsearch, though it will not solve heartbeat clock issue, for that user will be show that trouble shoot guide

I'm not sure if I understand fully, but I want to confirm if this new condition impacts the text that we provide to the user. I'm assuming no.

Improve popover text

There are a few grammar and sentence structure mistakes I think we should improve in this PR. Overall, I also think we can shorten the text a bit. Copying @ollyhowell and @colleenmcginnis in case they have any input. But given the time and unless there are concerns, I propose we go with:

Element	Currently	Change to
Popover button	Troubleshoot	Where are my monitors?
Popover title	Troubleshoot out of sync clock	System clock may be out of sync
Popover text	If there is data in the pings over time chart and you dont see any monitors in monitor list. There might be an issue with your system clock, either on the system heartbeat is running or where kibana is running. You can try the absolute date range, if that shows missing monitors, then make sure to check out of sync system clock.	Try using an absolute date range. If monitors still do not appear afterwards, there may be an issue with the system clock where Heartbeat or Kibana is installed.
Popover action	Try absolute date range	Apply absolute date range

Figma screenshot:

Additional notes:

For the popover action button, add the 'calendar' icon so that the action is associated with the date time picker
I don't think we need the "arrowDown" icon for the popover button. Since this appears in the context of a table, it could be confused as an accordion.
Ideally we could point the user in the right direction if it is indeed a system clock issue.
- If there is a troubleshooting guide that exists, we should point them there by adding: "For more information, read our (link)troubleshooting guide(/link)." at the end.
- If no documentation exists, we could say something more generic like: "Please consult your system administrator."

Consider not using a popover

The popover makes the "quick fix" button and information unnecessarily difficult to find and access. I haven't considered any reason why we should "hide" this, so please speak up if you had something in mind. Instead, we could simply use an EuiEmptyPrompt inside the table when the condition is met. Something like:

This seems more consistent with how we handle empty prompts in other places in Kibana. If this is too much to do before FF or there is disagreement, we can address this later.

dominiqueclarke · 2022-03-30T19:05:33Z

I'm a little wary of making the content so definite. There are a few reasons why this behavior can happen, one of which is time clock, but it may also not be time clock. So I'd prefer having a title that was closer to System clock may be out of sync. Thoughts @hbharding?

hbharding · 2022-03-30T20:53:07Z

@dominiqueclarke sounds good to me. I updated the copy in the table from my previous comment to reflect that.

shahzad31 · 2022-04-01T09:35:28Z

I have updated the UI, i think using an empty state might be too strong here, Since this will only happen as an edge case, i feel like there might be other scenerio where there will be no monitors, so making it a definitive statement might be not correct here.

I think we can have a more complete trouble shoot guide after this iteration , where we can cover some other things.

awahab07

LGTM

Code review only

kibana-ci · 2022-04-04T12:05:38Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`uptime`	742	744	+2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`uptime`	772.5KB	774.4KB	+1.9KB

History

💚 Build #35461 succeeded d0506a8
💚 Build #34092 succeeded 4ab1820
💔 Build #34032 failed dbc3e57
💔 Build #33631 failed ebe72e12efde3643376f9b03d67e4065a6316edb

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

cc @shahzad31

hbharding

Thanks @shahzad31. LGTM!

(cherry picked from commit e05b216)

kibanamachine · 2022-04-04T15:43:11Z

💔 Some backports could not be created

Status	Branch	Result
✅	8.2
❌	8.1	Backport failed because of merge conflicts
❌	7.17	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 128527

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

(cherry picked from commit e05b216) Co-authored-by: Shahzad <[email protected]>

…#129566) * [Uptime] Show troubleshoot guide on missing monitors (#128527) (cherry picked from commit e05b216) * Update troubleshoot_popover.tsx

shahzad31 changed the title ~~update~~ [Uptime] Show troubleshoot guide on missing monitors Mar 24, 2022

add trouble shoot guide

dbc3e57

shahzad31 force-pushed the clock-out-of-sync branch from ebe72e1 to dbc3e57 Compare March 28, 2022 14:04

update test

4ab1820

shahzad31 marked this pull request as ready for review March 28, 2022 17:08

shahzad31 requested a review from a team as a code owner March 28, 2022 17:08

shahzad31 self-assigned this Mar 28, 2022

shahzad31 added v8.2.0 v8.1.1 v7.17.2 release_note:skip Skip the PR/issue when compiling release notes labels Mar 28, 2022

hbharding reviewed Mar 29, 2022

View reviewed changes

botelastic bot added the Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability label Mar 29, 2022

hbharding reviewed Mar 29, 2022

View reviewed changes

hbharding suggested changes Mar 29, 2022

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into clock-out-of-sync

e63413a

dominiqueclarke self-requested a review March 30, 2022 14:53

shahzad31 added 2 commits March 31, 2022 17:46

Merge branch 'main' of github.com:elastic/kibana into clock-out-of-sync

4f20b84

pr feedback

bf1985c

revert

d0506a8

awahab07 approved these changes Apr 1, 2022

View reviewed changes

shahzad31 requested a review from hbharding April 1, 2022 14:53

Merge branch 'main' into clock-out-of-sync

0e3aabc

hbharding approved these changes Apr 4, 2022

View reviewed changes

shahzad31 merged commit e05b216 into elastic:main Apr 4, 2022

shahzad31 deleted the clock-out-of-sync branch April 4, 2022 15:39

shahzad31 added v8.3.0 auto-backport Deprecated - use backport:version if exact versions are needed labels Apr 4, 2022

kibanamachine mentioned this pull request Apr 4, 2022

[8.2] [Uptime] Show troubleshoot guide on missing monitors (#128527) #129370

Merged

kibanamachine pushed a commit that referenced this pull request Apr 4, 2022

[Uptime] Show troubleshoot guide on missing monitors (#128527)

2fcd6ee

(cherry picked from commit e05b216)

kibanamachine added a commit that referenced this pull request Apr 5, 2022

[Uptime] Show troubleshoot guide on missing monitors (#128527) (#129370)

fdff6f5

(cherry picked from commit e05b216) Co-authored-by: Shahzad <[email protected]>

shahzad31 removed the v8.1.1 label Apr 6, 2022

shahzad31 mentioned this pull request Apr 6, 2022

[7.17] [Uptime] Show troubleshoot guide on missing monitors (#128527) #129566

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uptime] Show troubleshoot guide on missing monitors #128527

[Uptime] Show troubleshoot guide on missing monitors #128527

shahzad31 commented Mar 24, 2022

shahzad31 commented Mar 28, 2022

hbharding Mar 29, 2022

elasticmachine commented Mar 29, 2022

hbharding Mar 29, 2022

hbharding Mar 29, 2022

hbharding left a comment •

edited

Loading

dominiqueclarke commented Mar 30, 2022

hbharding commented Mar 30, 2022

shahzad31 commented Apr 1, 2022

awahab07 left a comment

kibana-ci commented Apr 4, 2022

hbharding left a comment

kibanamachine commented Apr 4, 2022

[Uptime] Show troubleshoot guide on missing monitors #128527

[Uptime] Show troubleshoot guide on missing monitors #128527

Conversation

shahzad31 commented Mar 24, 2022

Summary

Testing

shahzad31 commented Mar 28, 2022

hbharding Mar 29, 2022

Choose a reason for hiding this comment

elasticmachine commented Mar 29, 2022

hbharding Mar 29, 2022

Choose a reason for hiding this comment

hbharding Mar 29, 2022

Choose a reason for hiding this comment

hbharding left a comment • edited Loading

Choose a reason for hiding this comment

Your last comment about a new condition

Improve popover text

Consider not using a popover

dominiqueclarke commented Mar 30, 2022

hbharding commented Mar 30, 2022

shahzad31 commented Apr 1, 2022

awahab07 left a comment

Choose a reason for hiding this comment

kibana-ci commented Apr 4, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

hbharding left a comment

Choose a reason for hiding this comment

kibanamachine commented Apr 4, 2022

💔 Some backports could not be created

Manual backport

Questions ?

hbharding left a comment •

edited

Loading