[Uptime] Add Settings Page #53550

andrewvc · 2019-12-19T01:54:59Z

Summary

Adds a settings page to the Uptime UI. The settings page values are per-space. The only current setting is heartbeatIndices.

To test this against alternate indices try changing setup.ilm.rollover_alias in heartbeat.yml to something like alt-prefix. See the ilm docs for more details.

This should be tested with read-only and write only roles. To test this in kibana try creating two users with two different roles in kibana. One roll should have read access to the Uptime space in kibana. The other should have all access. Both should have read permissions for the heartbeat-* index pattern.

This patch also splits API perms from just heartbeat to uptime-read and uptime-write.

This patch also refactors some of the header component functionality, using hooks for breadcrumbs, and making the top links optional.

Fixes elastic/uptime#43

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
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
This was checked for keyboard-only and screenreader accessibility

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

elasticmachine · 2019-12-19T01:55:01Z

Pinging @elastic/uptime (Team:uptime)

x-pack/legacy/plugins/uptime/index.ts

mshustov · 2019-12-19T13:13:27Z

x-pack/legacy/plugins/uptime/public/lib/adapters/source_settings/get_source_settings.ts

+ */
+export const getSourceSettings = async (basePath?: string, setter?: (data: unknown) => void) => {
+  try {
+    const { data } = await axios.get(getApiPath('/api/uptime/source_settings', basePath));


Is there a reason not to use http.fetch instead? Our Security model heavily depends on the fact that every plugin uses core provided API

Thanks for the pointer, will make the switch, this file was copied from some much older code pre NP

I think we need to do this across the whole app. We're tracking that here. I'll leave this PR as-is since we have to make a change everywhere ultimately. #56894

mshustov · 2019-12-19T13:14:16Z

x-pack/legacy/plugins/uptime/public/lib/adapters/source_settings/index.ts

+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { getSourceSettings } from './get_source_settings';


Would you mind updating https://github.com/elastic/kibana/blob/master/.github/CODEOWNERS with uptime app ?

x-pack/legacy/plugins/uptime/server/rest_api/source_settings/get_source_settings.ts

x-pack/legacy/plugins/uptime/server/lib/adapters/saved_objects/kibana_saved_objects_adapter.ts

elasticmachine · 2019-12-20T16:35:14Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 4a04c71

History

💔 Build #16838 failed 0e5cf0a
💔 Build #16688 failed 7f5e8b6
💔 Build #16613 failed 8247b21
💔 Build #16605 failed 3947cac
💔 Build #16599 failed 49665d4

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

andrewvc · 2020-03-20T03:32:59Z

@elasticmachine merge upstream

shahzad31 · 2020-03-20T17:28:19Z

x-pack/plugins/uptime/server/graphql/monitor_states/resolvers.ts

      ): Promise<MonitorSummaryResult> {
+        const dynamicSettings = await savedObjectsAdapter.getUptimeDynamicSettings(
+          savedObjectsClient,
+          undefined


why you have to pass undefined?

i see the same case in other places as well.

Good point! The type required a second argument for no reason.

shahzad31 · 2020-03-20T17:32:22Z

x-pack/legacy/plugins/uptime/public/state/reducers/dynamic_settings.ts

+      saveSucceeded: false,
+      saveError: action.payload,


seems like typing isn't working correctly here, otherwise it should have thrown error on saveSucceeded, something we can improve for redux reducer. but unrelated to this PR.

shahzad31 · 2020-03-20T17:34:02Z

x-pack/legacy/plugins/uptime/public/state/effects/dynamic_settings.ts

+  const couldNotSaveSettingsText = i18n.translate('xpack.uptime.settings.error.couldNotSave', {
+    defaultMessage: 'Could not save settings!',
+  });
+  yield takeLatest(String(setDynamicSettings), function*(action: Action<DynamicSettings>) {
+    try {
+      if (!action.payload) {
+        const err = new Error('Cannot fetch effect without a payload');
+        yield put(setDynamicSettingsFail(err));
+
+        kibanaService.core.notifications.toasts.addError(err, {
+          title: couldNotSaveSettingsText,
+        });
+        return;
+      }
+      const basePath = yield select(getBasePath);
+      yield call(setDynamicSettingsAPI, { settings: action.payload, basePath });
+      yield put(setDynamicSettingsSuccess(action.payload));
+      kibanaService.core.notifications.toasts.addSuccess('Settings saved!');
+    } catch (err) {
+      kibanaService.core.notifications.toasts.addError(err, {
+        title: couldNotSaveSettingsText,
+      });
+      yield put(setDynamicSettingsFail(err));
+    }


nice usage of toasts here.

shahzad31 · 2020-03-20T17:37:50Z

x-pack/legacy/plugins/uptime/public/state/api/dynamic_settings.ts

+  return await apiService.post(apiPath, JSON.stringify(settings), DynamicSettingsSaveType);
+};


i wonder, if you have to do JSON.stringify? doesn't kibana http post takes care of it?

Nope! Removed, good fix :)

shahzad31 · 2020-03-20T17:45:49Z

x-pack/legacy/plugins/uptime/public/hooks/use_breadcrumbs.ts

+  useEffect(() => {
+    if (setBreadcrumbs) {
+      setBreadcrumbs([makeBaseBreadcrumb(params)].concat(extraCrumbs));
+    }
+  });


you can optimize it by passing effect depencies array, that way it will be only called when extracrumbs really changes, right now this will be called each time component renders.

shahzad31

Code Looks good, just left some minor optional comments. WFG !!

kibanamachine · 2020-03-21T23:11:40Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 18a6cb6

History

💔 Build #35205 failed 8b75416
💔 Build #35196 failed b93eb0f
💔 Build #35190 failed c99d896
💔 Build #35122 failed 474d1dd
💔 Build #34782 failed 1bc87ee

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

Adds a settings page to the Uptime UI. The settings page values are per-space. The only current setting is heartbeatIndices. To test this against alternate indices try changing setup.ilm.rollover_alias in heartbeat.yml to something like alt-prefix. See the ilm docs for more details. This should be tested with read-only and write only roles. To test this in kibana try creating two users with two different roles in kibana. One roll should have read access to the Uptime space in kibana. The other should have all access. Both should have read permissions for the heartbeat-* index pattern. This patch also splits API perms from just heartbeat to uptime-read and uptime-write. This patch also refactors some of the header component functionality, using hooks for breadcrumbs, and making the top links optional. Fixes elastic/uptime#43

* [Uptime] Add Settings Page (#53550) Adds a settings page to the Uptime UI. The settings page values are per-space. The only current setting is heartbeatIndices. To test this against alternate indices try changing setup.ilm.rollover_alias in heartbeat.yml to something like alt-prefix. See the ilm docs for more details. This should be tested with read-only and write only roles. To test this in kibana try creating two users with two different roles in kibana. One roll should have read access to the Uptime space in kibana. The other should have all access. Both should have read permissions for the heartbeat-* index pattern. This patch also splits API perms from just heartbeat to uptime-read and uptime-write. This patch also refactors some of the header component functionality, using hooks for breadcrumbs, and making the top links optional. Fixes elastic/uptime#43 * Fix tests to use heartbeat-7 instead of heartbeat-8

* master: (39 commits) [APM]Create custom link from Trace summary (elastic#59648) [ML] Fixing app clean up (elastic#60853) [SIEM] Use ECS categorisation for Authentication widgets (elastic#60734) [NP] Remove kbnUrl usage in discover/dashboard/visualize (elastic#60016) Skip failing test [Uptime]Update fetch effect failed action handling (elastic#60742) [npm] upgrade elastic/maki (elastic#60829) [Uptime] Add Settings Page (elastic#53550) [APM] service maps: avoid unnecesary `useDeepObjectIdentity` (elastic#60836) [Index management] Re-enable index template tests (elastic#60780) Fixed UI/UX issues: alerts delete confirmation, combobox behaviors (elastic#60703) [SIEM] Fix patching of ML Rules (elastic#60830) [APM] Service Map - Separate overlapping edges by rotating nodes (elastic#60477) [Alerting] fix flaky test for index threshold grouping (elastic#60792) [SIEM][Detection Engine] Adds test scripts for machine learning feature Flatten child api response for resolver (elastic#60810) Change "url" to "urls" in APM agent instructions (elastic#60790) [DOCS] Updates API requests and examples (elastic#60695) [SIEM] [Cases] Create case from timeline (elastic#60711) [Lens] Resetting a layer generates new suggestions (elastic#60674) ...

andrewvc added 2 commits December 18, 2019 19:28

check

d408981

Moar

49665d4

andrewvc added WIP Work in progress enhancement New value added to drive a business result Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability labels Dec 19, 2019

andrewvc self-assigned this Dec 19, 2019

More similarity to infra

3947cac

andrewvc added release_note:skip Skip the PR/issue when compiling release notes v7.7.0 labels Dec 19, 2019

Fix syntax

8247b21

mshustov reviewed Dec 19, 2019

View reviewed changes

x-pack/legacy/plugins/uptime/index.ts Outdated Show resolved Hide resolved

mshustov reviewed Dec 19, 2019

View reviewed changes

x-pack/legacy/plugins/uptime/server/rest_api/source_settings/get_source_settings.ts Outdated Show resolved Hide resolved

Fix mappings key

7f5e8b6

rudolf reviewed Dec 19, 2019

View reviewed changes

x-pack/legacy/plugins/uptime/server/lib/adapters/saved_objects/kibana_saved_objects_adapter.ts Outdated Show resolved Hide resolved

andrewvc mentioned this pull request Dec 19, 2019

[Uptime] Uptime support for dynamic settings / index names elastic/uptime#43

Closed

andrewvc added 3 commits December 19, 2019 19:44

check

a1bc3ff

dynamic settings work

0e5cf0a

Temp

4a04c71

andrewvc mentioned this pull request Jan 2, 2020

[Uptime] NP Config / Index Pattern option #53341

Closed

7 tasks

andrewvc added 5 commits January 2, 2020 16:23

Merge remote-tracking branch 'origin/master' into source-settings

b03253d

Merge remote-tracking branch 'origin/master' into source-settings

e6af3f9

Fix type issues

ba99dd9

Merge remote-tracking branch 'origin/master' into source-settings

134018c

Rough out settings page

5150e14

andrewvc mentioned this pull request Jan 31, 2020

[Uptime] Add 'Stale' monitor state #56465

Closed

Checkpoint

29a26ca

andrewvc added 3 commits March 19, 2020 16:40

Merge remote-tracking branch 'origin/master' into source-settings

1ad5741

Merge remote-tracking branch 'avc/source-settings' into source-settings

7fe5e49

Merge remote-tracking branch 'origin/master' into source-settings

b35ef72

Merge branch 'master' into source-settings

1bc87ee

shahzad31 reviewed Mar 20, 2020

View reviewed changes

shahzad31 approved these changes Mar 20, 2020

View reviewed changes

andrewvc added 11 commits March 20, 2020 13:37

Merge remote-tracking branch 'origin/master' into source-settings

9ce1004

Fix failing tests

37d0545

Merge remote-tracking branch 'avc/source-settings' into source-settings

12c3347

Merge remote-tracking branch 'origin/master' into source-settings

bcadf4c

Fix failing tests

b794065

Fix index collision

474d1dd

Merge remote-tracking branch 'origin/master' into source-settings

e5c8298

Update snap

c99d896

Remove unused var

b93eb0f

Fetch settings lazily

8b75416

Invoke settings in test blocks only

18a6cb6

andrewvc merged commit c2e57af into elastic:master Mar 21, 2020

andrewvc deleted the source-settings branch March 21, 2020 23:13

andrewvc mentioned this pull request Mar 22, 2020

[7.x] [Uptime] Add Settings Page (#53550) #60869

Merged

andrewvc mentioned this pull request Mar 25, 2020

[Uptime] Add settings page #61343

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Uptime] Add Settings Page #53550

[Uptime] Add Settings Page #53550

andrewvc commented Dec 19, 2019 •

edited

Loading

elasticmachine commented Dec 19, 2019

mshustov Dec 19, 2019 •

edited

Loading

andrewvc Dec 19, 2019

andrewvc Mar 5, 2020 •

edited

Loading

mshustov Dec 19, 2019 •

edited

Loading

andrewvc Dec 19, 2019

elasticmachine commented Dec 20, 2019

andrewvc commented Mar 20, 2020

shahzad31 Mar 20, 2020

shahzad31 Mar 20, 2020

andrewvc Mar 20, 2020

shahzad31 Mar 20, 2020

shahzad31 Mar 20, 2020

shahzad31 Mar 20, 2020

andrewvc Mar 20, 2020

shahzad31 Mar 20, 2020

andrewvc Mar 20, 2020

shahzad31 left a comment

kibanamachine commented Mar 21, 2020

		return await apiService.post(apiPath, JSON.stringify(settings), DynamicSettingsSaveType);
		};

[Uptime] Add Settings Page #53550

[Uptime] Add Settings Page #53550

Conversation

andrewvc commented Dec 19, 2019 • edited Loading

Summary

Checklist

For maintainers

elasticmachine commented Dec 19, 2019

mshustov Dec 19, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andrewvc Mar 5, 2020 • edited Loading

Choose a reason for hiding this comment

mshustov Dec 19, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Dec 20, 2019

💔 Build Failed

History

andrewvc commented Mar 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shahzad31 left a comment

Choose a reason for hiding this comment

kibanamachine commented Mar 21, 2020

💚 Build Succeeded

History

andrewvc commented Dec 19, 2019 •

edited

Loading

mshustov Dec 19, 2019 •

edited

Loading

andrewvc Mar 5, 2020 •

edited

Loading

mshustov Dec 19, 2019 •

edited

Loading