[Alerting] Add more rule execution context (#117504) (#119793)

Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Dario Gieselaar <[email protected]>
elastic · Nov 28, 2021 · 26e92de · 26e92de
1 parent 94943fb
commit 26e92de
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 4 deletions.
diff --git a/x-pack/plugins/actions/server/lib/action_executor.ts b/x-pack/plugins/actions/server/lib/action_executor.ts
@@ -100,7 +100,7 @@ export class ActionExecutor {
         name: `execute_action`,
         type: 'actions',
         labels: {
-          actionId,
+          actions_connector_id: actionId,
         },
       },
       async (span) => {
@@ -130,7 +130,7 @@ export class ActionExecutor {
         if (span) {
           span.name = `execute_action ${actionTypeId}`;
           span.addLabels({
-            actionTypeId,
+            actions_connector_type_id: actionTypeId,
           });
         }
 

diff --git a/x-pack/plugins/alerting/server/task_runner/task_runner.ts b/x-pack/plugins/alerting/server/task_runner/task_runner.ts
@@ -4,7 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-
+import apm from 'elastic-apm-node';
 import type { PublicMethodsOf } from '@kbn/utility-types';
 import { Dictionary, pickBy, mapValues, without, cloneDeep } from 'lodash';
 import type { Request } from '@hapi/hapi';
@@ -483,6 +483,17 @@ export class TaskRunner<
     // Ensure API key is still valid and user has access
     try {
       alert = await rulesClient.get({ id: alertId });
+
+      if (apm.currentTransaction) {
+        apm.currentTransaction.name = `Execute Alerting Rule: "${alert.name}"`;
+        apm.currentTransaction.addLabels({
+          alerting_rule_consumer: alert.consumer,
+          alerting_rule_name: alert.name,
+          alerting_rule_tags: alert.tags.join(', '),
+          alerting_rule_type_id: alert.alertTypeId,
+          alerting_rule_params: JSON.stringify(alert.params),
+        });
+      }
     } catch (err) {
       throw new ErrorWithReason(AlertExecutionStatusErrorReasons.Read, err);
     }
@@ -512,6 +523,13 @@ export class TaskRunner<
       schedule: taskSchedule,
     } = this.taskInstance;
 
+    if (apm.currentTransaction) {
+      apm.currentTransaction.name = `Execute Alerting Rule`;
+      apm.currentTransaction.addLabels({
+        alerting_rule_id: alertId,
+      });
+    }
+
     const runDate = new Date();
     const runDateString = runDate.toISOString();
     this.logger.debug(`executing alert ${this.alertType.id}:${alertId} at ${runDateString}`);
@@ -567,6 +585,14 @@ export class TaskRunner<
       executionStatus.lastExecutionDate = new Date(event.event.start);
     }
 
+    if (apm.currentTransaction) {
+      if (executionStatus.status === 'ok' || executionStatus.status === 'active') {
+        apm.currentTransaction.setOutcome('success');
+      } else if (executionStatus.status === 'error' || executionStatus.status === 'unknown') {
+        apm.currentTransaction.setOutcome('failure');
+      }
+    }
+
     this.logger.debug(
       `alertExecutionStatus for ${this.alertType.id}:${alertId}: ${JSON.stringify(executionStatus)}`
     );
@@ -749,6 +775,12 @@ function generateNewAndRecoveredInstanceEvents<
   const recoveredAlertInstanceIds = Object.keys(recoveredAlertInstances);
   const newIds = without(currentAlertInstanceIds, ...originalAlertInstanceIds);
 
+  if (apm.currentTransaction) {
+    apm.currentTransaction.addLabels({
+      alerting_new_alerts: newIds.length,
+    });
+  }
+
   for (const id of recoveredAlertInstanceIds) {
     const { group: actionGroup, subgroup: actionSubgroup } =
       recoveredAlertInstances[id].getLastScheduledActions() ?? {};
@@ -929,6 +961,14 @@ function logActiveAndRecoveredInstances<
   const { logger, activeAlertInstances, recoveredAlertInstances, alertLabel } = params;
   const activeInstanceIds = Object.keys(activeAlertInstances);
   const recoveredInstanceIds = Object.keys(recoveredAlertInstances);
+
+  if (apm.currentTransaction) {
+    apm.currentTransaction.addLabels({
+      alerting_active_alerts: activeInstanceIds.length,
+      alerting_recovered_alerts: recoveredInstanceIds.length,
+    });
+  }
+
   if (activeInstanceIds.length > 0) {
     logger.debug(
       `alert ${alertLabel} has ${activeInstanceIds.length} active alert instances: ${JSON.stringify(

diff --git a/x-pack/plugins/task_manager/server/task_scheduling.test.ts b/x-pack/plugins/task_manager/server/task_scheduling.test.ts
@@ -35,6 +35,9 @@ jest.mock('uuid', () => ({
 
 jest.mock('elastic-apm-node', () => ({
   currentTraceparent: 'parent',
+  currentTransaction: {
+    type: 'taskManager run',
+  },
 }));
 
 describe('TaskScheduling', () => {

diff --git a/x-pack/plugins/task_manager/server/task_scheduling.ts b/x-pack/plugins/task_manager/server/task_scheduling.ts
@@ -99,9 +99,15 @@ export class TaskScheduling {
       ...options,
       taskInstance: ensureDeprecatedFieldsAreCorrected(taskInstance, this.logger),
     });
+
+    const traceparent =
+      agent.currentTransaction && agent.currentTransaction.type !== 'request'
+        ? agent.currentTraceparent
+        : '';
+
     return await this.store.schedule({
       ...modifiedTask,
-      traceparent: agent.currentTraceparent ?? '',
+      traceparent: traceparent || '',
     });
   }