[RAM] [Rule Form v2] Add feature flag #179184

Zacqary · 2024-03-21T17:42:21Z

Summary

This adds a series of feature flags to all plugins that are currently using the Rule Form Flyout, in preparation for development of the new Create Rule Flow V2 (#175634).

Unfortunately true Kibana feature-flagging is still not yet implemented, so we need to implement this as a config option for every individual affected plugin. The following kibana.yml config will enable the upcoming V2 rule form:

xpack.trigger_actions_ui.enableExperimental: ['ruleFormV2']
xpack.infra.featureFlags.ruleFormV2Enabled: true
xpack.ml.experimental.ruleFormV2.enabled: true
xpack.transform.experimental.ruleFormV2Enabled: true
xpack.legacy_uptime.experimental.ruleFormV2Enabled: true
xpack.observability.unsafe.ruleFormV2.enabled: true
xpack.slo.experimental.ruleFormV2.enabled: true
xpack.apm.featureFlags.ruleFormV2Enabled: true

discover.experimental.ruleFormV2Enabled: true

These feature flags will not enable anything yet. This PR is for the sole purpose of adding these browser-enabled flags now, so that we can reduce the amount of code committed later.

Why feature flag every plugin?

The V1 rule form is currently exported from Triggers Actions UI. In V2, we're moving away from this model and exporting the rule form in a KBN package. Therefore we can't simply export the results of a single feature flag from Triggers Actions UI, we need to signal to each individual plugin whether it should be pulling from the new KBN package or from the old cross-plugin export.

Plugins affected

Triggers Actions UI, Infra, Observability, APM

These plugins already contained interfaces for experimental features or feature flags, so this PR simply adds a new flag to these existing structures.

Discover, ML, Transform, Uptime, SLO

These plugins did not have existing browser-exposed feature flag systems, so this PR adds these interfaces. The transform plugin notably did not yet have any config options configured at all.

…flag # Conflicts: # x-pack/plugins/ml/public/application/app.tsx # x-pack/plugins/ml/public/application/contexts/ml/serverless_context.tsx

apmmachine · 2024-03-21T17:42:43Z

🤖 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!)

elasticmachine · 2024-03-21T17:45:43Z

Pinging @elastic/response-ops (Team:ResponseOps)

justinkambic

Uptime changes LGTM

qn895 · 2024-03-21T18:26:06Z

x-pack/plugins/transform/public/app/mount_management_section.ts

@@ -98,6 +100,7 @@ export async function mountManagementSection(

  const enabledFeatures: TransformEnabledFeatures = {
    showNodeInfo: !isServerless,
+    ruleFormV2Enabled: experimentalFeatures?.ruleFormV2Enabled ?? false,
  };
  const unmountAppCallback = renderApp(element, appDependencies, enabledFeatures);


Not a super strong opinion on this one but I wonder if it will be more clear to continue passing experimentalFeatures to renderApp(element, appDependencies, enabledFeatures, experimentalFeatures); just like how it's done ML. This way the parameters passed down to are consistent, and also for clarity that it's an experimental feature. Just a thought, not a blocker.

Sounds good, pushing a change

qn895 · 2024-03-21T18:28:39Z

Tested ML & Transform changes and LGTM

doakalexi

ResponseOps changes LGTM

davismcphee · 2024-03-22T02:08:13Z

/ci

davismcphee · 2024-03-22T02:20:17Z

src/plugins/discover/public/plugin.tsx

@@ -354,6 +361,7 @@ export class DiscoverPlugin
          customizationContext: {
            displayMode: 'standalone',
            inlineTopNav: this.inlineTopNav,
+            ruleFormV2Enabled: this.experimentalFeatures?.ruleFormV2Enabled ?? false,


Rather than incorporating this into the customization context, which is used for a different purpose in Discover, I'd prefer we pass ExperimentalFeatures directly into renderApp instead to keep things separated. Then when we need to use it, we can introduce something like a context provider for it.

Sure thing, changed this in the latest commit

tonyghiani

Change to infra config LGTM.

JiaweiWu

Just have a small nitpick, otherwise LGTM

JiaweiWu · 2024-03-22T17:22:00Z

x-pack/plugins/ml/common/constants/app.ts

+  experimentalFeatures: ExperimentalFeatures,
+  config: ConfigSchema
+) {
+  if (config.experimental?.ruleFormV2?.enabled !== undefined) {


super small nitpick: maybe better to check if its a boolean?

Trying to repeat the same pattern used elsewhere in this file

davismcphee

Code-only review. Data Discovery changes LGTM

jeramysoucy

Kibana security changes LGTM

benakansara

@Zacqary I think we also need a feature flag for Observability "Create rule" form. wdyt?

Zacqary · 2024-03-25T16:01:53Z

@benakansara This same feature flag will apply to both the full page Create Rule form and in-context flyouts.

For creating new rules from the Rules Management page, or editing existing ones, we'll be using this full-page experience: #179105

We'll also be integrating the new UI into flyouts, which we'll be using when the user creates a new rule from the upper-right dropdown from apps like Inventory, Metrics Explorer, etc: #179108

Both of those flows are part of the V2 project, so once they're both implemented, we want to be able to turn them both on or off together.

…flag

benakansara · 2024-03-25T17:04:12Z

@Zacqary thanks for the explanation. To confirm, correct me if I am wrong - The observability Create rule flyout will be replaced with full page experience and to turn full page on / off, the same feature flag will be used. Is it xpack.trigger_actions_ui.enableExperimental: ['ruleFormV2'] feature flag for observability too?

Zacqary · 2024-03-25T19:07:53Z

@benakansara I'd love to use just the triggers_actions_ui feature flag to affect every single plugin, but Kibana doesn't allow us to do that right now. True feature flagging is on the Core team's 2024 roadmap, but for now we need to add a flag for every single plugin.

Using this single feature flag would work if we were still sticking with the V1 method of embedding the rule form in solutions: exporting it from triggers_actions_ui and lazy-loading it through functions getAddRuleFlyout. In V2 we're going to be exporting it from @kbn/alerts-ui-shared instead, bypassing triggers_actions_ui entirely.

elasticmachine · 2024-03-25T21:03:26Z

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

elasticmachine · 2024-03-25T21:03:26Z

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

Zacqary · 2024-03-25T21:04:59Z

As per discussion with @benakansara on Slack, added feature flags for observability, apm, and slo

benakansara · 2024-03-26T18:08:21Z

x-pack/plugins/observability_solution/slo/public/components/header_menu/header_menu.tsx

-  const { appMountParameters } = usePluginContext();
-
+  const { appMountParameters, experimentalFeatures } = usePluginContext();
+  console.log('EXPERIMENTAL', experimentalFeatures);


could we remove console.log?

benakansara

LGTM. Just left a comment about console.log.

Zacqary · 2024-03-27T19:01:39Z

@elasticmachine merge upstream

kibana-ci · 2024-03-27T20:17:21Z

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id	before	after	diff
`apm`	3.2MB	3.2MB	+71.0B
`discover`	590.2KB	590.3KB	+46.0B
`ml`	3.7MB	3.7MB	+169.0B
`slo`	609.8KB	609.8KB	+46.0B
`transform`	391.7KB	391.9KB	+197.0B
`uptime`	458.8KB	458.8KB	+2.0B
total			+531.0B

Page load bundle

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

id	before	after	diff
`discover`	34.7KB	34.9KB	+214.0B
`ml`	78.3KB	78.7KB	+340.0B
`slo`	20.8KB	21.2KB	+325.0B
`transform`	18.4KB	18.6KB	+193.0B
`triggersActionsUi`	108.7KB	108.7KB	+14.0B
`uptime`	22.0KB	22.1KB	+178.0B
total			+1.2KB

History

💛 Build #199807 was flaky 6b8c09a
💛 Build #199483 was flaky 81e7e3b
💔 Build #199320 failed 0dccee5
💔 Build #199297 failed 6b53b0e
💚 Build #199229 succeeded c2a9e8a
💛 Build #199008 was flaky 5823995

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

Zacqary added 2 commits March 21, 2024 12:32

[RAM] [Rule Form v2] Add feature flag

1e132fa

Merge remote-tracking branch 'upstream/main' into 179110-ruleform-v2-…

90f13ab

…flag # Conflicts: # x-pack/plugins/ml/public/application/app.tsx # x-pack/plugins/ml/public/application/contexts/ml/serverless_context.tsx

Zacqary added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Alerting/RulesManagement Issues related to the Rules Management UX v8.14.0 labels Mar 21, 2024

Zacqary marked this pull request as ready for review March 21, 2024 17:45

Zacqary requested review from a team as code owners March 21, 2024 17:45

justinkambic approved these changes Mar 21, 2024

View reviewed changes

qn895 reviewed Mar 21, 2024

View reviewed changes

qn895 approved these changes Mar 21, 2024

View reviewed changes

doakalexi approved these changes Mar 21, 2024

View reviewed changes

Clarify experimental features arg in transform plugin

5da6ad6

davismcphee reviewed Mar 22, 2024

View reviewed changes

tonyghiani approved these changes Mar 22, 2024

View reviewed changes

Zacqary added 4 commits March 22, 2024 11:20

Fix ML stack management pages

2b66a16

Fix typecheck on triggers_actions_ui

90d4853

Move experimental features out of discover customization context

0fb0e34

Fix discover typecheck

847f959

JiaweiWu approved these changes Mar 22, 2024

View reviewed changes

davismcphee approved these changes Mar 22, 2024

View reviewed changes

Fix tests and typecheck

5823995

Zacqary requested review from a team as code owners March 22, 2024 21:02

jeramysoucy approved these changes Mar 22, 2024

View reviewed changes

benakansara reviewed Mar 25, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into 179110-ruleform-v2-…

c2a9e8a

…flag

Zacqary added 3 commits March 25, 2024 15:45

Add observability ruleFormV2 unsafe flag

61e0343

Add experimental ruleformv2 to slo

18f0464

Add RuleFormV2 feature flag to APM

6b53b0e

botelastic bot added Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team Team:obs-ux-management Observability Management User Experience Team labels Mar 25, 2024

Zacqary added 2 commits March 25, 2024 18:04

Fix tests and typecheck

0dccee5

Fix slo typecheck

81e7e3b

benakansara reviewed Mar 26, 2024

View reviewed changes

benakansara approved these changes Mar 26, 2024

View reviewed changes

Remove console statement

6b8c09a

Zacqary enabled auto-merge (squash) March 27, 2024 16:53

Merge branch 'main' into 179110-ruleform-v2-flag

0ed9b50

Zacqary merged commit bfc91b0 into elastic:main Mar 27, 2024
17 of 20 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Mar 27, 2024

adcoelho mentioned this pull request Oct 17, 2024

[ResponseOps][Rules] Remove the RuleFormV2 from plugins that do not need it #196704

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RAM] [Rule Form v2] Add feature flag #179184

[RAM] [Rule Form v2] Add feature flag #179184

Zacqary commented Mar 21, 2024 •

edited

Loading

apmmachine commented Mar 21, 2024

elasticmachine commented Mar 21, 2024

justinkambic left a comment

qn895 Mar 21, 2024 •

edited

Loading

Zacqary Mar 21, 2024

qn895 commented Mar 21, 2024

doakalexi left a comment

davismcphee commented Mar 22, 2024

davismcphee Mar 22, 2024

Zacqary Mar 22, 2024

tonyghiani left a comment

JiaweiWu left a comment

JiaweiWu Mar 22, 2024

Zacqary Mar 22, 2024

davismcphee left a comment

jeramysoucy left a comment

benakansara left a comment

Zacqary commented Mar 25, 2024

benakansara commented Mar 25, 2024

Zacqary commented Mar 25, 2024

elasticmachine commented Mar 25, 2024

elasticmachine commented Mar 25, 2024

Zacqary commented Mar 25, 2024

benakansara Mar 26, 2024

benakansara left a comment

Zacqary commented Mar 27, 2024

kibana-ci commented Mar 27, 2024

[RAM] [Rule Form v2] Add feature flag #179184

[RAM] [Rule Form v2] Add feature flag #179184

Conversation

Zacqary commented Mar 21, 2024 • edited Loading

Summary

Why feature flag every plugin?

Plugins affected

Triggers Actions UI, Infra, Observability, APM

Discover, ML, Transform, Uptime, SLO

apmmachine commented Mar 21, 2024

🤖 GitHub comments

elasticmachine commented Mar 21, 2024

justinkambic left a comment

Choose a reason for hiding this comment

qn895 Mar 21, 2024 • edited Loading

Choose a reason for hiding this comment

Zacqary Mar 21, 2024

Choose a reason for hiding this comment

qn895 commented Mar 21, 2024

doakalexi left a comment

Choose a reason for hiding this comment

davismcphee commented Mar 22, 2024

davismcphee Mar 22, 2024

Choose a reason for hiding this comment

Zacqary Mar 22, 2024

Choose a reason for hiding this comment

tonyghiani left a comment

Choose a reason for hiding this comment

JiaweiWu left a comment

Choose a reason for hiding this comment

JiaweiWu Mar 22, 2024

Choose a reason for hiding this comment

Zacqary Mar 22, 2024

Choose a reason for hiding this comment

davismcphee left a comment

Choose a reason for hiding this comment

jeramysoucy left a comment

Choose a reason for hiding this comment

benakansara left a comment

Choose a reason for hiding this comment

Zacqary commented Mar 25, 2024

benakansara commented Mar 25, 2024

Zacqary commented Mar 25, 2024

elasticmachine commented Mar 25, 2024

elasticmachine commented Mar 25, 2024

Zacqary commented Mar 25, 2024

benakansara Mar 26, 2024

Choose a reason for hiding this comment

benakansara left a comment

Choose a reason for hiding this comment

Zacqary commented Mar 27, 2024

kibana-ci commented Mar 27, 2024

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

Zacqary commented Mar 21, 2024 •

edited

Loading

qn895 Mar 21, 2024 •

edited

Loading