feat(slo): add reset api #170473

kdelemme · 2023-11-02T18:14:12Z

🌮 Summary

This PR introduces the reset api for individual SLOs. This API is used to fully reset (aka a factory reset) an SLO. It deletes the related transform if it exists, and recreates it. It also delete the rollup and summary documents related to that SLO (included all revision and all instance ids)

apmmachine · 2023-11-02T18:14:29Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
/oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

…te --fix'

… src/core/server/integration_tests/ci_checks'

kdelemme · 2023-11-03T13:13:30Z

x-pack/plugins/observability/server/saved_objects/slo.ts

@@ -38,6 +37,21 @@ export const slo: SavedObjectsType = {
  name: SO_SLO_TYPE,
  hidden: false,
  namespaceType: 'multiple-isolated',
+  switchToModelVersionAt: '8.10.0',


💬 I tried setting this to 8.12.0 but the framework was complaining.

You effectively don't need to set this option, as it gets applied with the default/max value (8.10.0) if unspecified . It was exposed for type owners that wanted to switch before 8.10.0 (and for testing purposes)

simianhacker · 2023-11-03T16:17:31Z

x-pack/plugins/observability/server/services/slo/reset_slo.ts

+    try {
+      await this.transformManager.install(slo);
+    } catch (err) {
+      // what can we do in this case?
+      throw err;
+    }


I think throwing the error is the best thing we can do at this point. As long as we bubble up the actual error message from ES so they can understand what the problem is. My guess is that if this failed (missing transform permissions OR missing transform node) the two previous calls (stop and uninstall) would have failed too.

Maybe we don't need the try/catch since we're just going to throw at this point and there is nothing to rollback. The SLO model version will still be 1, so once they've resolved the issue that prevented the install call, they could just reset again.

…fix'

elasticmachine · 2023-11-06T16:44:54Z

Pinging @elastic/actionable-observability (Team: Actionable Observability)

simianhacker

LGTM

pgayvallet

slo SO type changes LGTM

pgayvallet · 2023-11-07T07:12:33Z

x-pack/plugins/observability/server/saved_objects/slo.ts

@@ -38,6 +37,21 @@ export const slo: SavedObjectsType = {
  name: SO_SLO_TYPE,
  hidden: false,
  namespaceType: 'multiple-isolated',
+  switchToModelVersionAt: '8.10.0',


You effectively don't need to set this option, as it gets applied with the default/max value (8.10.0) if unspecified . It was exposed for type owners that wanted to switch before 8.10.0 (and for testing purposes)

kdelemme · 2023-11-08T13:33:53Z

x-pack/plugins/observability/server/assets/constants.ts

+export const SLO_MODEL_VERSION = 2;
 export const SLO_RESOURCES_VERSION = 2;
 export const SLO_SUMMARY_TRANSFORMS_VERSION = 3;


@simianhacker Let's sync with the value we want to use. So we don't have different version to keep track

Good question, whatever value we use, any time that changes, it will trigger the need to reset the SLO definitions. What's the harm in leaving it "as is" other than the complexity of having three values?

What if we added a comment to above SLO_MODEL_VERSION that says:

Anytime we increment SLO_MODEL_VERSION, this will notify the user to "RESET" their SLO definitions which in turn re-indexes the SLI values and SLO summaries. Be judicious about changing this value.

elasticmachine · 2023-11-09T19:53:01Z

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

kibana-ci · 2023-11-15T22:56:33Z

💚 Build Succeeded

Buildkite Build
Commit: fe200da

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`observability`	480	501	+21

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/slo-schema`	128	144	+16

Async chunks

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

id	before	after	diff
`observability`	1.1MB	1.0MB	-15.1KB

Page load bundle

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

id	before	after	diff
`observability`	100.4KB	100.4KB	+22.0B

Saved Objects .kibana field count

Every field in each saved object type adds overhead to Elasticsearch. Kibana needs to keep the total field count below Elasticsearch's default limit of 1000 fields. Only specify field mappings for the fields you wish to search on or query. See https://www.elastic.co/guide/en/kibana/master/saved-objects-service.html#_mappings

id	before	after	diff
`slo`	10	11	+1

Unknown metric groups

API count

id	before	after	diff
`@kbn/slo-schema`	131	144	+13

async chunk count

id	before	after	diff
`observability`	15	16	+1

History

💚 Build #173984 succeeded 5d227b8
💔 Build #173854 failed 5e367be
💔 Build #173835 failed 6738450
💔 Build #173633 failed 4e9c639
💔 Build #173565 failed 3cdc74c
💔 Build #173539 failed 40a8a8d

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

cc @kdelemme

This reverts commit af1ad47.

- Revert "feat(slo): add reset api (#170473)" - Revert "[SLO] Use enrich policy to add SLO details to summary (#169993)"

kdelemme added 3 commits November 2, 2023 12:36

Use version 2 for creating SLOs

edab7f9

Add safeguard against so migration issue

1e61ae4

do not trust migration

5cb1e9a

kdelemme added 2 commits November 2, 2023 14:15

Add reset api

145eb14

Add reset test

969ec8c

kdelemme force-pushed the slo-reset-api branch from e31f3cc to 969ec8c Compare November 2, 2023 19:08

kibanamachine added 2 commits November 2, 2023 19:27

[CI] Auto-commit changed files from 'node scripts/check_mappings_upda…

1240a99

…te --fix'

[CI] Auto-commit changed files from 'node scripts/jest_integration -u…

884b137

… src/core/server/integration_tests/ci_checks'

kdelemme commented Nov 3, 2023

View reviewed changes

kdelemme added 2 commits November 3, 2023 11:01

Fix tests

7e54dba

Make definitions api not internal

4cf4d1d

simianhacker reviewed Nov 3, 2023

View reviewed changes

kdelemme and others added 6 commits November 3, 2023 13:09

Add includeOutdatedOnly option

67bec46

Add test

75e3c7c

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

56b7a58

…fix'

Update doc

c688135

Fix type

40a8a8d

dd definitions api

3cdc74c

kdelemme marked this pull request as ready for review November 6, 2023 16:44

kdelemme requested review from a team as code owners November 6, 2023 16:44

kdelemme self-assigned this Nov 6, 2023

kdelemme added release_note:skip Skip the PR/issue when compiling release notes Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" v8.12.0 labels Nov 6, 2023

kdelemme added 2 commits November 6, 2023 14:16

Fix test

7b9ac1d

Merge branch 'main' into slo-reset-api

4e9c639

simianhacker approved these changes Nov 7, 2023

View reviewed changes

pgayvallet approved these changes Nov 7, 2023

View reviewed changes

Merge branch 'main' into slo-reset-api

6738450

kdelemme changed the title ~~feat(slo): reset api~~ feat(slo): add reset api Nov 7, 2023

kdelemme added 2 commits November 7, 2023 10:14

Fix locator test

5e367be

Merge branch 'main' into slo-reset-api

5d227b8

kdelemme commented Nov 8, 2023

View reviewed changes

kdelemme added the Team:obs-ux-management Observability Management User Experience Team label Nov 9, 2023

kdelemme removed the Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" label Nov 9, 2023

Merge branch 'main' into slo-reset-api

fe200da

kdelemme requested a review from a team as a code owner November 15, 2023 21:47

simianhacker approved these changes Nov 15, 2023

View reviewed changes

kdelemme merged commit af1ad47 into elastic:main Nov 16, 2023
26 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Nov 16, 2023

kdelemme deleted the slo-reset-api branch November 16, 2023 12:58

kdelemme added a commit to kdelemme/kibana that referenced this pull request Nov 16, 2023

Revert "feat(slo): add reset api (elastic#170473)"

0430a4b

This reverts commit af1ad47.

kdelemme mentioned this pull request Nov 16, 2023

revert(slo): enrich policy and reset api #171420

Merged

kdelemme added a commit that referenced this pull request Nov 16, 2023

revert(slo): enrich policy and reset api (#171420)

3791a73

- Revert "feat(slo): add reset api (#170473)" - Revert "[SLO] Use enrich policy to add SLO details to summary (#169993)"

kdelemme mentioned this pull request Nov 20, 2023

feat(slo): Add enrich policy and reset api #171555

Closed

6 tasks

kdelemme added a commit to kdelemme/kibana that referenced this pull request Nov 20, 2023

feat(slo): add reset api (elastic#170473)

054734b

kdelemme mentioned this pull request Nov 29, 2023

feat(slo): new slo architecture #172224

Merged

8 tasks

kdelemme added a commit to kdelemme/kibana that referenced this pull request Dec 4, 2023

feat(slo): add reset api (elastic#170473)

7af9763

simianhacker mentioned this pull request Dec 7, 2023

[SLO] Reset UI for updating outdated SLOs #172883

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(slo): add reset api #170473

feat(slo): add reset api #170473

kdelemme commented Nov 2, 2023 •

edited

Loading

apmmachine commented Nov 2, 2023

kdelemme Nov 3, 2023

pgayvallet Nov 7, 2023

simianhacker Nov 3, 2023 •

edited

Loading

elasticmachine commented Nov 6, 2023

simianhacker left a comment

pgayvallet left a comment

pgayvallet Nov 7, 2023

kdelemme Nov 8, 2023

simianhacker Nov 8, 2023

elasticmachine commented Nov 9, 2023

kibana-ci commented Nov 15, 2023

API count

async chunk count

feat(slo): add reset api #170473

feat(slo): add reset api #170473

Conversation

kdelemme commented Nov 2, 2023 • edited Loading

🌮 Summary

apmmachine commented Nov 2, 2023

🤖 GitHub comments

kdelemme Nov 3, 2023

Choose a reason for hiding this comment

pgayvallet Nov 7, 2023

Choose a reason for hiding this comment

simianhacker Nov 3, 2023 • edited Loading

Choose a reason for hiding this comment

elasticmachine commented Nov 6, 2023

simianhacker left a comment

Choose a reason for hiding this comment

pgayvallet left a comment

Choose a reason for hiding this comment

pgayvallet Nov 7, 2023

Choose a reason for hiding this comment

kdelemme Nov 8, 2023

Choose a reason for hiding this comment

simianhacker Nov 8, 2023

Choose a reason for hiding this comment

elasticmachine commented Nov 9, 2023

kibana-ci commented Nov 15, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

Saved Objects .kibana field count

API count

async chunk count

History

kdelemme commented Nov 2, 2023 •

edited

Loading

simianhacker Nov 3, 2023 •

edited

Loading