Rename the term "execution" in config to "run" (#130172)

* Rename the term "execution" in config to "run" * Rename the term "execution" in config to "run" * Rename the overlooked terms * [DOCS] Fix example indentation * Update docs/user/alerting/troubleshooting/alerting-common-issues.asciidoc Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: lcawl <[email protected]> Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit f962ff2)
elastic · Apr 18, 2022 · fbaf95e · fbaf95e
1 parent 3e82ac2
commit fbaf95e
Show file tree

Hide file tree

Showing 18 changed files with 69 additions and 74 deletions.
diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc
@@ -198,24 +198,26 @@ For example, `20m`, `24h`, `7d`. Default: `1m`.
 `xpack.alerting.rules.minimumScheduleInterval.enforce`::
 Specifies the behavior when a new or changed rule has a schedule interval less than the value defined in `xpack.alerting.rules.minimumScheduleInterval.value`. If `false`, rules with schedules less than the interval will be created but warnings will be logged. If `true`, rules with schedules less than the interval cannot be created. Default: `false`.
 
-`xpack.alerting.rules.execution.actions.max`::
+`xpack.alerting.rules.run.actions.max`::
 Specifies the maximum number of actions that a rule can trigger each time detection checks run.
 
-`xpack.alerting.rules.execution.timeout`::
+`xpack.alerting.rules.run.timeout`::
 Specifies the default timeout for tasks associated with all types of rules. The time is formatted as:
 +
 `<count>[ms,s,m,h,d,w,M,Y]`
 +
 For example, `20m`, `24h`, `7d`, `1w`. Default: `5m`.
 
-`xpack.alerting.rules.execution.ruleTypeOverrides`::
-Overrides the configs under `xpack.alerting.rules.execution` for the rule type with the given ID. List the rule identifier and its settings in an array of objects.
+`xpack.alerting.rules.run.ruleTypeOverrides`::
+Overrides the configs under `xpack.alerting.rules.run` for the rule type with the given ID. List the rule identifier and its settings in an array of objects.
 +
+--
 For example:
 ```
-xpack.alerting.rules.execution:
+xpack.alerting.rules.run:
     timeout: '5m'
     ruleTypeOverrides:
         - id: '.index-threshold'
           timeout: '15m'
-```
+```
+--
diff --git a/docs/user/alerting/troubleshooting/alerting-common-issues.asciidoc b/docs/user/alerting/troubleshooting/alerting-common-issues.asciidoc
@@ -85,7 +85,7 @@ and in the <<rule-details,details page>>:
 [role="screenshot"]
 image::images/rule-details-timeout-error.png[Rule details page with timeout error]
 
-If you want your rules to run longer, update the `xpack.alerting.rules.execution.timeout` configuration in your <<alert-settings>>. You can also target a specific rule type by using `xpack.alerting.rules.execution.ruleTypeOverrides`.
+If you want your rules to run longer, update the `xpack.alerting.rules.run.timeout` configuration in your <<alert-settings>>. You can also target a specific rule type by using `xpack.alerting.rules.run.ruleTypeOverrides`.
 
 Rules that consistently run longer than their <<create-edit-rules, check interval>> may produce unexpected results. If the average run duration, visible on the <<rule-details,details page>>, is greater than the check interval, consider increasing the check interval.
 

diff --git a/x-pack/plugins/alerting/server/config.test.ts b/x-pack/plugins/alerting/server/config.test.ts
@@ -22,15 +22,15 @@ describe('config validation', () => {
         },
         "maxEphemeralActionsPerAlert": 10,
         "rules": Object {
-          "execution": Object {
-            "actions": Object {
-              "max": 100000,
-            },
-          },
           "minimumScheduleInterval": Object {
             "enforce": false,
             "value": "1m",
           },
+          "run": Object {
+            "actions": Object {
+              "max": 100000,
+            },
+          },
         },
       }
     `);

diff --git a/x-pack/plugins/alerting/server/config.ts b/x-pack/plugins/alerting/server/config.ts
@@ -21,7 +21,7 @@ const rulesSchema = schema.object({
     }),
     enforce: schema.boolean({ defaultValue: false }), // if enforce is false, only warnings will be shown
   }),
-  execution: schema.object({
+  run: schema.object({
     timeout: schema.maybe(schema.string({ validate: validateDurationSchema })),
     actions: schema.object({
       max: schema.number({ defaultValue: 100000 }),

diff --git a/x-pack/plugins/alerting/server/index.ts b/x-pack/plugins/alerting/server/index.ts
@@ -60,12 +60,8 @@ export const config: PluginConfigDescriptor<AlertsConfigType> = {
       'xpack.alerting.invalidateApiKeysTask.removalDelay',
       { level: 'warning' }
     ),
-    renameFromRoot(
-      'xpack.alerting.defaultRuleTaskTimeout',
-      'xpack.alerting.rules.execution.timeout',
-      {
-        level: 'warning',
-      }
-    ),
+    renameFromRoot('xpack.alerting.defaultRuleTaskTimeout', 'xpack.alerting.rules.run.timeout', {
+      level: 'warning',
+    }),
   ],
 };
diff --git a/x-pack/plugins/alerting/server/lib/get_rule_task_timeout.test.ts b/x-pack/plugins/alerting/server/lib/get_rule_task_timeout.test.ts
@@ -14,16 +14,16 @@ const config = {
     value: '2m',
     enforce: false,
   },
-  execution: {
+  run: {
     timeout: '1m',
     actions: { max: 1000 },
   },
 } as RulesConfig;
 
 const configWithRuleType = {
   ...config,
-  execution: {
-    ...config.execution,
+  run: {
+    ...config.run,
     ruleTypeOverrides: [
       {
         id: ruleTypeId,
@@ -35,7 +35,7 @@ const configWithRuleType = {
 
 const configWithoutTimeout = {
   ...config,
-  execution: {
+  run: {
     actions: { max: 1000 },
   },
 };

diff --git a/x-pack/plugins/alerting/server/lib/get_rule_task_timeout.ts b/x-pack/plugins/alerting/server/lib/get_rule_task_timeout.ts
@@ -18,7 +18,7 @@ export const getRuleTaskTimeout = ({
   ruleTaskTimeout?: string;
   ruleTypeId: string;
 }): string => {
-  const ruleTypeConfig = config.execution.ruleTypeOverrides?.find(
+  const ruleTypeConfig = config.run.ruleTypeOverrides?.find(
     (ruleType) => ruleTypeId === ruleType.id
   );
 
@@ -27,9 +27,6 @@ export const getRuleTaskTimeout = ({
   // if not, ruleTaskTimeout is applied that is passed from the rule type registering plugin
   // if none of above is set, DEFAULT_EXECUTION_TIMEOUT is applied
   return (
-    ruleTypeConfig?.timeout ||
-    config.execution.timeout ||
-    ruleTaskTimeout ||
-    DEFAULT_EXECUTION_TIMEOUT
+    ruleTypeConfig?.timeout || config.run.timeout || ruleTaskTimeout || DEFAULT_EXECUTION_TIMEOUT
   );
 };
diff --git a/x-pack/plugins/alerting/server/lib/get_rules_config.test.ts b/x-pack/plugins/alerting/server/lib/get_rules_config.test.ts
@@ -14,16 +14,16 @@ const config = {
     value: '2m',
     enforce: false,
   },
-  execution: {
+  run: {
     timeout: '1m',
     actions: { max: 1000 },
   },
 } as RulesConfig;
 
 const configWithRuleType = {
   ...config,
-  execution: {
-    ...config.execution,
+  run: {
+    ...config.run,
     ruleTypeOverrides: [
       {
         id: ruleTypeId,
@@ -36,7 +36,7 @@ const configWithRuleType = {
 describe('get rules config', () => {
   test('returns the rule type specific config and keeps the default values that are not overwritten', () => {
     expect(getExecutionConfigForRuleType({ config: configWithRuleType, ruleTypeId })).toEqual({
-      execution: {
+      run: {
         id: ruleTypeId,
         timeout: '1m',
         actions: { max: 20 },
@@ -46,7 +46,7 @@ describe('get rules config', () => {
 
   test('returns the default config when there is no rule type specific config', () => {
     expect(getExecutionConfigForRuleType({ config, ruleTypeId })).toEqual({
-      execution: config.execution,
+      run: config.run,
     });
   });
 });
diff --git a/x-pack/plugins/alerting/server/lib/get_rules_config.ts b/x-pack/plugins/alerting/server/lib/get_rules_config.ts
@@ -15,13 +15,13 @@ export const getExecutionConfigForRuleType = ({
   config: RulesConfig;
   ruleTypeId: string;
 }): RuleTypeConfig => {
-  const ruleTypeExecutionConfig = config.execution.ruleTypeOverrides?.find(
+  const ruleTypeExecutionConfig = config.run.ruleTypeOverrides?.find(
     (ruleType) => ruleType.id === ruleTypeId
   );
 
   return {
-    execution: {
-      ...omit(config.execution, 'ruleTypeOverrides'),
+    run: {
+      ...omit(config.run, 'ruleTypeOverrides'),
       ...ruleTypeExecutionConfig,
     },
   };

diff --git a/x-pack/plugins/alerting/server/plugin.test.ts b/x-pack/plugins/alerting/server/plugin.test.ts
@@ -33,7 +33,7 @@ const generateAlertingConfig = (): AlertingConfig => ({
   cancelAlertsOnRuleTimeout: true,
   rules: {
     minimumScheduleInterval: { value: '1m', enforce: false },
-    execution: {
+    run: {
       actions: {
         max: 1000,
       },
@@ -50,7 +50,7 @@ const sampleRuleType: RuleType<never, never, never, never, never, 'default'> = {
   defaultActionGroupId: 'default',
   producer: 'test',
   config: {
-    execution: {
+    run: {
       actions: {
         max: 1000,
       },
@@ -126,7 +126,7 @@ describe('Alerting Plugin', () => {
         ...generateAlertingConfig(),
         rules: {
           minimumScheduleInterval: { value: '1m', enforce: false },
-          execution: {
+          run: {
             actions: {
               max: 123,
             },
@@ -141,7 +141,7 @@ describe('Alerting Plugin', () => {
       setupContract.registerType(ruleType);
 
       expect(ruleType.config).toEqual({
-        execution: {
+        run: {
           actions: { max: 123 },
         },
       });
@@ -152,7 +152,7 @@ describe('Alerting Plugin', () => {
         ...generateAlertingConfig(),
         rules: {
           minimumScheduleInterval: { value: '1m', enforce: false },
-          execution: {
+          run: {
             actions: { max: 123 },
             ruleTypeOverrides: [{ id: sampleRuleType.id, timeout: '1d' }],
           },
@@ -166,7 +166,7 @@ describe('Alerting Plugin', () => {
       setupContract.registerType(ruleType);
 
       expect(ruleType.config).toEqual({
-        execution: {
+        run: {
           id: sampleRuleType.id,
           actions: {
             max: 123,