feat(slo): allow configuration of advanced settings from UI #200822

kdelemme · 2024-11-19T21:38:51Z

Resolves #200041

🐎 Summary

This PR adds an advanced settings section at the end of the objective section in the SLO form. This section can be used to configure the following settings fields: syncField, syncDelay, frequency and preventInitialBackfill.

syncField is a new settings. The other fields were already defined at the API level.
Except for preventInitialBackfill, the other fields were not available on the form.

syncField is optional, therefore current usage of the create/update APIs won't break if this field is not specified. A null value is used to specifically unset the field when updating an SLO.

I've also taken the opportunity to close #194957 by fixing the index row label state when the form is invalid.

Note

While implementing this feature, I've noticed some bugs in the form state when changing the DataView / selected index. The dependant fields like groupBy and the new syncField were not cleared from the previously selected values, but the UI was hidding them.

The form was keeping the previous selected fields in its state, while hiding them from the combobox selection. This could lead to subtle bugs where user would edit an existing SLO, changing the DataView and hitting save, thinking the groupBy/syncField were cleared.

I've fixed this in this PR as well.

🧬 Testing

Creating an SLO should:
- Use the syncField, syncDelay, Frequency provided values to build the rollup transform
- Use default values if not provided
Editing an SLO should
- Use the syncField, syncDelay, Frequency provided values to build the rollup transform
- Keep the previous settings if not overridden

Release Note

Adds syncField, syncDelay and frequency settings in the API and SLO form. Allow customer to fine tune their SLO settings directly from the UI.

…-fix'

kdelemme · 2024-11-22T15:59:22Z

.../observability_solution/slo/server/services/transform_generators/apm_transaction_duration.ts

@@ -42,7 +42,7 @@ export class ApmTransactionDurationTransformGenerator extends TransformGenerator
      this.buildDestination(slo),
      this.buildGroupBy(slo, slo.indicator),
      this.buildAggregations(slo, slo.indicator),
-      this.buildSettings(slo),
+      this.buildSettings(slo, '@timestamp'),


APM always uses @timestamp

kdelemme · 2024-11-22T16:01:32Z

x-pack/plugins/observability_solution/slo/server/services/slo_repository.ts

+      settings: merge(
+        { preventInitialBackfill: false, syncDelay: '1m', frequency: '1m' },
+        storedSLO.settings
+      ),


merge() simplifies the backward compatibility management of the settings

kdelemme · 2024-11-22T16:02:12Z

x-pack/plugins/observability_solution/slo/server/services/create_slo.ts

+      settings: merge(
+        {
+          syncDelay: new Duration(1, DurationUnit.Minute),
+          frequency: new Duration(1, DurationUnit.Minute),
+          preventInitialBackfill: false,
+        },
+        params.settings
+      ),


We set default values, and override with the provided values

kdelemme · 2024-11-22T16:03:34Z

...ugins/observability_solution/slo/public/pages/slo_edit/shared_flyout/slo_add_form_flyout.tsx

-              : undefined
-          }
-        />
+        <SloEditForm onSave={onClose} initialValues={initialValues} />


Let the Form handles the merging of the provided values with default values

kdelemme · 2024-11-22T16:08:52Z

...slo/public/pages/slo_edit/components/indicator_section/timeslice_metric/metric_indicator.tsx

-                    'xpack.slo.sloEdit.sliType.timesliceMetric.deleteLabel',
-                    { defaultMessage: 'Delete metric' }
-                  )}
+            <EuiFlexGroup direction="column" gutterSize="xs">


🖌️ Mostly UI change

kdelemme · 2024-11-22T16:09:33Z

...slo/public/pages/slo_edit/components/indicator_section/custom_common/use_adhoc_data_views.ts


-export const getDataViewPattern = ({
+export const getDataViewPatternOrId = ({


The name was confusing me

kdelemme · 2024-11-22T16:10:47Z

...ion/slo/public/pages/slo_edit/components/indicator_section/custom_common/index_selection.tsx

+  const updateDataViewDependantFields = (indexPattern?: string, timestampField?: string) => {
+    setValue(INDEX_FIELD, indexPattern ?? '');
+    setValue(INDICATOR_TIMESTAMP_FIELD, timestampField ?? '');
+    setValue(GROUP_BY_FIELD, ALL_VALUE);
+    setValue(SETTINGS_SYNC_FIELD, null);
+  };
+


We make sure to reset the data views dependant fields to avoid keeping non-existant values

elasticmachine · 2024-11-22T16:14:50Z

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

github-actions · 2024-11-22T16:14:58Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

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

shahzad31

LGTM 🚢

elasticmachine · 2024-12-02T20:35:51Z

💚 Build Succeeded

Buildkite Build
Commit: ca6df89
Storybooks Preview
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-200822-ca6df897237a

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`slo`	855	857	+2

Async chunks

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

id	before	after	diff
`observability`	472.6KB	472.8KB	+150.0B
`slo`	842.6KB	848.0KB	+5.4KB
`synthetics`	1.1MB	1.1MB	+97.0B
total			+5.6KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`slo`	4	2	-2

Page load bundle

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

id	before	after	diff
`slo`	28.8KB	28.8KB	+6.0B

History

💚 Build #256158 succeeded 27e00b0
💚 Build #255644 succeeded da345b6
💛 Build #255372 was flaky 4c0e028
💔 Build #254683 failed b2c9133
💔 Build #254446 failed 887fbb0

cc @kdelemme

kibanamachine · 2024-12-02T21:19:38Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12128161463

kibanamachine · 2024-12-02T21:24:30Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts You might need to backport the following PRs to 8.x: - [Security Solution] - Update codeowners (#202046) - [eem] _search sort_by and display_name (#202361) - [OpenAPI] Fix Serverless API base URL (#202373) - [Synthetics] Fix to handle ops genie as default connector !! (#201923) - [Security Solution] [Onboarding] t1_analyst role blocked from interacting with cards due to missing integration privileges (#202413)

Manual backport

To create the backport manually run:

node scripts/backport --pr 200822