[Uptime] Redirect to error page when Heartbeat mappings are missing #110857

justinkambic · 2021-09-01T17:54:15Z

Summary

This is ~~WIP~~ code resulting from a spike. It requires design input and further refinement from a code standpoint, as well as some copy updates.

This change would add a new page, mapping error, to the Uptime app's routes list. It should include helpful information that lets the user know that they need to fix their indices when Heartbeat's mappings were not appropriately installed.

At the moment, I've only modified one component on the Overview page to perform the redirect. Essentially, we catch this specific error from Elasticsearch and return it to the client; all other errors remain in a thrown state.

Testing

Start Elasticsearch and Heartbeat
curl -u elastic:{PASSWORD} -X DELETE "http://localhost:9200/{HEARTBEAT_INDEX}"
Navigate to the Uptime UI, you should be redirected to the mapping error page
Kill Heartbeat
curl -u elastic:{PASSWORD} -X DELETE "http://localhost:9200/{HEARTBEAT_INDEX}"
Start Heartbeat
Navigate to Uptime UI, you should see the overview page per usual

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

andrewvc · 2021-09-01T19:26:30Z

x-pack/plugins/uptime/public/pages/mapping_error.tsx

+      iconType="cross"
+      // TODO: placeholder copy
+      title={<div>Heartbeat mappings are not installed</div>}
+      body={<div>You need to stop Heartbeat, delete your indices, and restart Heartbeat.</div>}


For copy WDYT of:

Incorrect mappings detected! Perhaps you forgot to run the heartbeat setup command? See the heartbeat quickstart for more information.

I'm also thinking maybe we should add a dedicated docs page for this and link to that. Thoughts?

Dedicated docs might be nice, since it's such a common issue. We could include explicit remediation instructions there, since the quick-start guide doesn't address this problem directly.

I've opened elastic/observability-docs#1018 to track the docs

i think having inline docs is always amazing, can we also keep instructions inline preferabbly with commands to run and lead to details step by step docs page,

Docs PR: elastic/observability-docs#1046

justinkambic · 2021-09-03T18:38:10Z

@elasticmachine merge upstream

elasticmachine · 2021-09-09T18:47:43Z

Pinging @elastic/uptime (Team:uptime)

justinkambic · 2021-09-13T15:49:19Z

@elasticmachine merge upstream

justinkambic · 2021-09-14T13:53:57Z

@elasticmachine merge upstream

shahzad31 · 2021-09-14T13:58:57Z

x-pack/plugins/uptime/server/rest_api/overview_filters/get_overview_filters.ts

+    try {
+      return await libs.requests.getFilterBar({
+        uptimeEsClient,
+        dateRangeStart,
+        dateRangeEnd,
+        search: parsedSearch,
+        filterOptions: objectValuesToArrays<string>({
+          locations,
+          ports,
+          schemes,
+          tags,
+        }),
+      });
+    } catch (e) {
+      /**
+       * This particular error is usually indicative of a mapping problem within the user's
+       * indices. It's relevant for the UI because we will be able to provide the user with a
+       * tailored message to help them remediate this problem on their own with minimal effort.
+       */
+      if (e.name === 'ResponseError') {
+        return response.badRequest({ body: e });
+      }
+      throw e;
+    }
  },
 });


This route has been , infact this whole API has been removed in our filters API, so i wonder if this is the correct appraoch to handle this kind of error.

Yes I overlooked that - a dedicated route may be the way to go. The inclination for this approach is, we don't want to slow down the happy path that 99% of users will experience for the sake of this one other case. While it's a common error, it's rare for people to experience it.

Perhaps we should depend on the filters PR and adjust the logic in this PR to fit the error in that one, since the error should still occur with the new fetch procedure.

justinkambic · 2021-09-15T13:08:30Z

@elasticmachine merge upstream

…kibana into 359/detect-mapping-failure

shahzad31 · 2021-09-23T08:59:07Z

@elasticmachine merge upstream

shahzad31

LGTM, Great work, it's really going to be useful for our users !!

kibanamachine · 2021-09-23T10:55:40Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`uptime`	640	642	+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`	558.7KB	560.8KB	+2.1KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`uptime`	24.2KB	24.2KB	+53.0B

History

💚 Build #154779 succeeded c011e76
💔 Build #154665 failed be3ad06
💔 Build #154611 failed 03e9ae1
💔 Build #154598 failed 8b96641
💚 Build #153527 succeeded dab934e

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

cc @justinkambic

…lastic#110857) * Initial PoC of redirect on mapping error is working. * Update copy. Add comments. * Include headline element for page title. * Create mappings for failing functional tests. * Add functional test for mappings error page. * Add mapping for certs check.

kibanamachine · 2021-09-23T10:58:39Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

…110857) (#112951) * Initial PoC of redirect on mapping error is working. * Update copy. Add comments. * Include headline element for page title. * Create mappings for failing functional tests. * Add functional test for mappings error page. * Add mapping for certs check. Co-authored-by: Justin Kambic <[email protected]>

justinkambic added enhancement New value added to drive a business result v8.0.0 Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v7.16.0 labels Sep 1, 2021

justinkambic self-assigned this Sep 1, 2021

andrewvc reviewed Sep 1, 2021

View reviewed changes

justinkambic changed the title ~~Initial PoC of redirect on mapping error is working.~~ [Uptime] Redirect to error page when mappings are wrong Sep 1, 2021

justinkambic changed the title ~~[Uptime] Redirect to error page when mappings are wrong~~ [Uptime] Redirect to error page when Heartbeat mappings are missing Sep 1, 2021

andrewvc mentioned this pull request Sep 2, 2021

[Uptime] Add obs-docs page on mapping errors elastic/observability-docs#1018

Closed

justinkambic added the release_note:enhancement label Sep 2, 2021

justinkambic force-pushed the 359/detect-mapping-failure branch 2 times, most recently from 8ae8789 to 8c58cc5 Compare September 8, 2021 17:03

justinkambic marked this pull request as ready for review September 9, 2021 18:47

justinkambic requested a review from a team as a code owner September 9, 2021 18:47

justinkambic added 6 commits September 9, 2021 15:11

Initial PoC of redirect on mapping error is working.

fb6826c

Update copy. Add comments.

96b8de9

Include headline element for page title.

630618a

Create mappings for failing functional tests.

64ed589

Add functional test for mappings error page.

f6a4159

Add mapping for certs check.

1cb42f8

justinkambic force-pushed the 359/detect-mapping-failure branch from d69da0b to 1cb42f8 Compare September 9, 2021 19:12

justinkambic enabled auto-merge (squash) September 10, 2021 19:30

justinkambic added 2 commits September 10, 2021 15:31

Add docs link.

160b0e8

Add missing word to copy.

d259608

Merge branch 'master' into 359/detect-mapping-failure

aa4e63e

Merge branch 'master' into 359/detect-mapping-failure

93bfe76

shahzad31 requested changes Sep 14, 2021

View reviewed changes

kibanamachine and others added 8 commits September 15, 2021 09:08

Merge branch 'master' into 359/detect-mapping-failure

dab934e

Merge master.

a43034c

Add conditional redirect hook for monitor list.

50d82af

Merge branch '359/detect-mapping-failure' of github.com:justinkambic/…

3783242

…kibana into 359/detect-mapping-failure

Delete obsolete files from bad merge.

8b96641

Remove useless comment.

03e9ae1

Fix broken code style due to prettier update.

be3ad06

Fix import name.

c011e76

Merge branch 'master' into 359/detect-mapping-failure

3045223

shahzad31 approved these changes Sep 23, 2021

View reviewed changes

shahzad31 added the auto-backport Deprecated - use backport:version if exact versions are needed label Sep 23, 2021

justinkambic merged commit 26d19e7 into elastic:master Sep 23, 2021

kibanamachine mentioned this pull request Sep 23, 2021

[7.x] [Uptime] Redirect to error page when Heartbeat mappings are missing (#110857) #112951

Merged

justinkambic deleted the 359/detect-mapping-failure branch September 27, 2021 15:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uptime] Redirect to error page when Heartbeat mappings are missing #110857

[Uptime] Redirect to error page when Heartbeat mappings are missing #110857

justinkambic commented Sep 1, 2021 •

edited

Loading

andrewvc Sep 1, 2021

justinkambic Sep 1, 2021

andrewvc Sep 2, 2021

shahzad31 Sep 6, 2021

justinkambic Sep 8, 2021

justinkambic commented Sep 3, 2021

elasticmachine commented Sep 9, 2021

justinkambic commented Sep 13, 2021

justinkambic commented Sep 14, 2021

shahzad31 Sep 14, 2021

justinkambic Sep 14, 2021

justinkambic commented Sep 15, 2021

shahzad31 commented Sep 23, 2021

shahzad31 left a comment

kibanamachine commented Sep 23, 2021

kibanamachine commented Sep 23, 2021

[Uptime] Redirect to error page when Heartbeat mappings are missing #110857

[Uptime] Redirect to error page when Heartbeat mappings are missing #110857

Conversation

justinkambic commented Sep 1, 2021 • edited Loading

Summary

Testing

Checklist

Risk Matrix

For maintainers

andrewvc Sep 1, 2021

Choose a reason for hiding this comment

justinkambic Sep 1, 2021

Choose a reason for hiding this comment

andrewvc Sep 2, 2021

Choose a reason for hiding this comment

shahzad31 Sep 6, 2021

Choose a reason for hiding this comment

justinkambic Sep 8, 2021

Choose a reason for hiding this comment

justinkambic commented Sep 3, 2021

elasticmachine commented Sep 9, 2021

justinkambic commented Sep 13, 2021

justinkambic commented Sep 14, 2021

shahzad31 Sep 14, 2021

Choose a reason for hiding this comment

justinkambic Sep 14, 2021

Choose a reason for hiding this comment

justinkambic commented Sep 15, 2021

shahzad31 commented Sep 23, 2021

shahzad31 left a comment

Choose a reason for hiding this comment

kibanamachine commented Sep 23, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

kibanamachine commented Sep 23, 2021

💚 Backport successful

justinkambic commented Sep 1, 2021 •

edited

Loading