[Actions] System actions enhancements by cnasikas · Pull Request #161340 · elastic/kibana

cnasikas · 2023-07-06T11:39:45Z

Summary

This PR:

Handles the references for system actions in the rule
Forbids the creation of system actions through the kibana.yml
Adds telemetry for system actions
Allow system action types to be disabled from the kibana.yml

Depends on: #160983, #161341

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

…ana into system_actions_registration

…ntext

cnasikas · 2023-07-11T15:08:27Z

x-pack/plugins/actions/server/usage/actions_telemetry.ts

  countNamespaces: number;
 }> {
-  const scriptedMetric = {
+  const getInMemoryActionScriptedMetric = (actionRefPrefix: string) => ({


I switch the order of scriptedMetric and preconfiguredActionsScriptedMetric (which I made it a function)

cnasikas · 2023-07-11T15:09:34Z

x-pack/plugins/actions/server/usage/task.ts

-  const inMemoryConnectors = getInMemoryConnectors().filter(
-    (inMemoryConnector) => inMemoryConnector.isPreconfigured
-  );
+  const inMemoryConnectors = getInMemoryConnectors();


We will take system actions into account in telemetry.

elasticmachine · 2023-07-22T16:18:48Z

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

cnasikas · 2023-07-24T13:40:54Z

@elasticmachine merge upstream

mikecote

Changes LGTM! Left a few nits and questions.

mikecote · 2023-07-25T18:19:36Z

x-pack/plugins/actions/server/action_type_registry.ts

-      (!actionTypeEnabled &&
-        this.inMemoryConnectors.find((inMemoryConnector) => inMemoryConnector.id === actionId) !==
-          undefined)
+      (!actionTypeEnabled && inMemoryConnector !== undefined && inMemoryConnector.isPreconfigured)


optional nit:

Suggested change

(!actionTypeEnabled && inMemoryConnector !== undefined && inMemoryConnector.isPreconfigured)

inMemoryConnector?.isPreconfigured === true

mikecote · 2023-07-25T18:22:04Z

x-pack/plugins/actions/server/action_type_registry.ts

+   * Returns true if action type is enabled or it is a preconfigured action type
+   * It is possible for to disable an action type but use a preconfigured action
+   * of action type the disabled one. This does not apply to system actions.
+   * It should be possible to disable a system action type.


Suggested change

* Returns true if action type is enabled or it is a preconfigured action type

* It is possible for to disable an action type but use a preconfigured action

* of action type the disabled one. This does not apply to system actions.

* It should be possible to disable a system action type.

* Returns true if action type is enabled or preconfigured.

* An action type can be disabled but used with a preconfigured action.

* This does not apply to system actions as those can be disabled.

mikecote · 2023-07-27T10:55:35Z

x-pack/plugins/actions/server/action_type_registry.ts

-      (!actionTypeEnabled &&
-        this.inMemoryConnectors.find((inMemoryConnector) => inMemoryConnector.id === actionId) !==
-          undefined)
+      (!actionTypeEnabled && inMemoryConnector !== undefined && inMemoryConnector.isPreconfigured)


As discussed, we should see with @shanisagiv1 if we wan the capability of disabling system actions or not. We can start with the context of the case action (and maybe think of future ones too).

If we are unsure, maybe it's best to hold off in case configuring via kibana.yml isn't the right answer? (ex: what about feature controls, serverless, etc)

We discussed offline and we decided to let the system actions to be disabled from the kibana.yml

mikecote · 2023-07-27T11:03:43Z

x-pack/plugins/actions/server/plugin.ts

+    const preConfiguredConnectors = this.inMemoryConnectors.filter(
+      (connector) => connector.isPreconfigured
+    );
+
+    const isSystemActionAsPreconfiguredInConfig = preConfiguredConnectors.some((connector) =>
+      this.actionTypeRegistry!.isSystemActionType(connector.actionTypeId)
+    );
+
+    if (isSystemActionAsPreconfiguredInConfig) {
+      throw new Error('Setting system action types in preconfigured connectors are not allowed');
+    }


optional nit: in case you want to condense the code

Suggested change

const preConfiguredConnectors = this.inMemoryConnectors.filter(

(connector) => connector.isPreconfigured

);

const isSystemActionAsPreconfiguredInConfig = preConfiguredConnectors.some((connector) =>

this.actionTypeRegistry!.isSystemActionType(connector.actionTypeId)

);

if (isSystemActionAsPreconfiguredInConfig) {

throw new Error('Setting system action types in preconfigured connectors are not allowed');

}

const hasSystemActionAsPreconfiguredInConfig = this.inMemoryConnectors

.filter((connector) => connector.isPreconfigured)

.some((connector) => this.actionTypeRegistry!.isSystemActionType(connector.actionTypeId));

if (hasSystemActionAsPreconfiguredInConfig) {

throw new Error('Setting system action types in preconfigured connectors are not allowed');

}

… system_actions_refs

cnasikas · 2023-07-28T11:44:14Z

@elasticmachine merge upstream

kibana-ci · 2023-07-28T12:53:35Z

💚 Build Succeeded

Buildkite Build
Commit: 9b94ea4

Metrics [docs]

✅ unchanged

History

💔 Build #145472 failed 96115ef
💔 Build #144310 failed a04b5ae
💔 Build #144136 failed 637a98f
💔 Build #144134 failed f479dff
💔 Build #144130 failed 25a93f0
💔 Build #141614 failed abe3edf

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

cc @cnasikas

## Summary This PR: - Handles the references for system actions in the rule - Forbids the creation of system actions through the `kibana.yml` - Adds telemetry for system actions - Allow system action types to be disabled from the `kibana.yml` Depends on: elastic#160983, elastic#161341 ### Checklist Delete any items that are not applicable to this PR. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

cnasikas and others added 30 commits June 28, 2023 10:51

Add isSystemAction to ActionResult type and default it to false

1352e52

Disallow registering system actions

09b82f6

Add test

dc1a2c8

Fix alerting types

bb7e9a5

Fix integration tests

774b389

Fix triggers_actions_ui types

83ee747

Fix cases types

d2b8e67

Fix cases tests

31f1f39

Fix integration tests

85ca6a4

Fix cases tests

b070bd9

Merge branch 'main' into system_actions_registration

a8e7143

Fix types from other plugins

b50a3e0

Merge branch 'system_actions_registration' of github.com:cnasikas/kib…

ee5df7b

…ana into system_actions_registration

Rename preconfiguredConnectors to inMemoryConnectors

1caf874

Create system actions

2aabeed

Prevent create/update/delete of system actions

3cf469a

Fix types

8c1246c

Merge branch 'main' into load_system_actions_in_memory

0d7aea1

Fix types

52ef0e5

Remove cases from basic

d763161

Convert preconfigured to in-memory

5c3245e

Merge branch 'main' into load_system_actions_in_memory

31bc750

Get in-memory connectors after they have been created in the route co…

d35a7f9

…ntext

Register test system action in integration tests

34ee2ab

Add integration tests

86b279c

Fix i18n

57b4d3a

Fix types

a162163

Fix integration test

2ea3c9c

Fixes

7362b97

Merge branch 'main' into load_system_actions_in_memory

cbaeb1f

cnasikas added 3 commits July 11, 2023 12:21

Merge branch 'main' into system_actions_rbac

a9e3bd5

Small improvements

72e9d72

Merge branch 'system_actions_rbac' into system_actions_refs

abe3edf

cnasikas changed the title ~~[Actions] System actions references~~ [Actions] System actions enhancements Jul 11, 2023

cnasikas commented Jul 11, 2023

View reviewed changes

cnasikas added 3 commits July 12, 2023 10:41

Improvements

de1f454

Merge branch 'main' into system_actions_refs

a54dd07

Fixes

25a93f0

cnasikas force-pushed the system_actions_refs branch from 6009fd6 to 25a93f0 Compare July 22, 2023 12:58

cnasikas added 2 commits July 22, 2023 17:54

Allow to disable system actions

f479dff

Allow rules client to get system actions

637a98f

cnasikas marked this pull request as ready for review July 22, 2023 16:18

cnasikas requested a review from a team as a code owner July 22, 2023 16:18

Merge branch 'main' into system_actions_refs

a04b5ae

mikecote self-requested a review July 25, 2023 18:18

mikecote approved these changes Jul 27, 2023

View reviewed changes

cnasikas added 3 commits July 28, 2023 13:15

Merge branch 'main' into system_actions_refs

9b0cc28

PR feedback

4fa0b02

Merge branch 'system_actions_refs' of github.com:cnasikas/kibana into…

96115ef

… system_actions_refs

cnasikas enabled auto-merge (squash) July 28, 2023 10:29

Merge branch 'main' into system_actions_refs

9b94ea4

cnasikas merged commit f8a1600 into elastic:main Jul 28, 2023

cnasikas deleted the system_actions_refs branch July 28, 2023 12:53

kibanamachine added the backport:skip This PR does not require backporting label Jul 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Actions] System actions enhancements#161340

[Actions] System actions enhancements#161340
cnasikas merged 65 commits intoelastic:mainfrom
cnasikas:system_actions_refs

cnasikas commented Jul 6, 2023 •

edited

Loading

Uh oh!

cnasikas Jul 11, 2023

Uh oh!

cnasikas Jul 11, 2023

Uh oh!

elasticmachine commented Jul 22, 2023

Uh oh!

cnasikas commented Jul 24, 2023

Uh oh!

mikecote left a comment

Uh oh!

mikecote Jul 25, 2023

Uh oh!

mikecote Jul 25, 2023

Uh oh!

mikecote Jul 27, 2023

Uh oh!

cnasikas Jul 28, 2023

Uh oh!

mikecote Jul 27, 2023

Uh oh!

cnasikas commented Jul 28, 2023

Uh oh!

kibana-ci commented Jul 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	(!actionTypeEnabled && inMemoryConnector !== undefined && inMemoryConnector.isPreconfigured)
	inMemoryConnector?.isPreconfigured === true

Conversation

cnasikas commented Jul 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Uh oh!

cnasikas Jul 11, 2023

Choose a reason for hiding this comment

Uh oh!

cnasikas Jul 11, 2023

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jul 22, 2023

Uh oh!

cnasikas commented Jul 24, 2023

Uh oh!

mikecote left a comment

Choose a reason for hiding this comment

Uh oh!

mikecote Jul 25, 2023

Choose a reason for hiding this comment

Uh oh!

mikecote Jul 25, 2023

Choose a reason for hiding this comment

Uh oh!

mikecote Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

cnasikas Jul 28, 2023

Choose a reason for hiding this comment

Uh oh!

mikecote Jul 27, 2023

Choose a reason for hiding this comment

Uh oh!

cnasikas commented Jul 28, 2023

Uh oh!

kibana-ci commented Jul 28, 2023

💚 Build Succeeded

Metrics [docs]

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

cnasikas commented Jul 6, 2023 •

edited

Loading