[alerts] add executionStatus to event log doc for action execute #82401

pmuellr · 2020-11-03T07:12:10Z

Summary

resolves #79785

Until now, the execution status was not available in the the event
log document for the execute action. In this PR we add it.

The event log is extended to add the following fields:

kibana.alerting.status - from executionStatus.status
event.reason - from executionStatus.error.reason

The date from the executionStatus and start date in the event
log will be set to the same value.

Previously, errors encountered before trying to execute an
alert executor, eg decrypting the alert, would not end up
with an event doc generated. Now they will.

Checklist

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

pmuellr

Noted a couple of anomolies in the current tests

x-pack/plugins/alerts/server/task_runner/task_runner.test.ts

resolves elastic#79785 Until now, the execution status was available in the the event log document for the execute action. In this PR we add it. The event log is extended to add the following fields: - `kibana.alerting.status` - from executionStatus.status - `event.reason` - from executionStatus.error.reason The date from the executionStatus and start date in the event log will be set to the same value. Previously, errors encountered while trying to execute an alert executor, eg decrypting the alert, would not end up with an event doc generated. Now they will. In addition, there were a few places where events that could have had the action group in them did not, and one where the instance id was undefined - those were fixed up.

elasticmachine · 2020-11-10T17:27:48Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

pmuellr · 2020-11-11T04:43:28Z

Wanted to point out some additional issues to open after working with this code; unrelated to this PR directly, but straight-forward and we should clean these up.

The generated config schema generated for events is here:

kibana/x-pack/plugins/event_log/generated/schemas.ts

Lines 27 to 29 in f4126ea

    
           export const EventSchema = schema.maybe( 
        
             schema.object({ 
        
               '@timestamp': ecsDate(),

It has an unfortunate schema.maybe() at the top which makes the entire type undefine-able, which can be painful to deal with. I looked at removing it - it's easy. But we should also go change all the places where we would then be excessively checking the value for undefined, and I think that's a fair number of places, and didn't want to clutter up this PR.

Poking around the action group usage, I realized it wasn't in the top-level variables, but should be:

kibana/x-pack/plugins/alerts/server/task_runner/transform_action_params.ts

Lines 16 to 26 in f4126ea

    
           interface TransformActionParamsOptions { 
        
             alertId: string; 
        
             alertName: string; 
        
             spaceId: string; 
        
             tags?: string[]; 
        
             alertInstanceId: string; 
        
             actionParams: AlertActionParams; 
        
             alertParams: AlertTypeParams; 
        
             state: AlertInstanceState; 
        
             context: AlertInstanceContext; 
        
           }

I updated issue [Alerting Core] Add timestamp to provided template values #67389 with a comment about this field.

pmuellr · 2020-11-11T14:43:43Z

x-pack/plugins/alerts/server/task_runner/task_runner.test.ts

@@ -184,11 +184,15 @@ describe('Task Runner', () => {
    expect(eventLogger.logEvent).toHaveBeenCalledTimes(1);


the changes at the top of this file are a dog's breakfast, sorry. The order the events get logged has changed, where the execute event is written AFTER all the other events now, but post-dated to the start of the execution process (and will be <= the other events generated), since we now have to write it AFTER all the execution processing. So, the diff is not very pleasing ...

pmuellr · 2020-11-11T14:45:32Z

x-pack/plugins/alerts/server/task_runner/task_runner.ts

@@ -153,7 +155,8 @@ export class TaskRunner {
    alert: SanitizedAlert,
    params: AlertExecutorOptions['params'],
    executionHandler: ReturnType<typeof createExecutionHandler>,
-    spaceId: string
+    spaceId: string,
+    event: Event


We now pass a partially populated event in to these "inner" functions of the execution logic, as we write the event at the "top level" of the execution logic, instead of in this "inner" one.

pmuellr · 2020-11-11T14:46:17Z

x-pack/plugins/alerts/server/task_runner/task_runner.ts

@@ -166,24 +169,10 @@ export class TaskRunner {
      alertRawInstances,
      (rawAlertInstance) => new AlertInstance(rawAlertInstance)
    );
+    const originalAlertInstances = cloneDeep(alertInstances);


we need the last set of alert instances (from the previous execution), so we can get the action group for "resolved" events, not just the original instance ids. Also, need to clone this, as alertInstances is mutated during the processing.

pmuellr · 2020-11-11T14:49:46Z

x-pack/plugins/event_log/generated/mappings.json

@@ -45,6 +45,10 @@
                "outcome": {


these are the two fields from the alert execution status, that weren't already populated somehow in the event, so added as new fields, in what I think are appropriate places - reason is a pre-existing. ECS field, but status is a new field in the custom ECS kibana.alertingfield

pmuellr · 2020-11-11T14:52:12Z

x-pack/plugins/event_log/server/event_logger.test.ts

@@ -102,16 +102,16 @@ describe('EventLogger', () => {
      event: { provider: 'test-provider', action: 'a' },
    });

-    const ignoredTimestamp = '1999-01-01T00:00:00Z';


Because we are now "post-dating" the execute event log docs, we need to allow the timestamp to be overridable when we merge fixed and initial event fields - previously you could NOT override it. That logic is in the file below, x-pack/plugins/event_log/server/event_logger.ts

pmuellr · 2020-11-11T14:53:42Z

x-pack/test/alerting_api_integration/security_and_spaces/tests/alerting/event_log.ts

@@ -0,0 +1,84 @@
+/*


In order to test a decrypt error status in the event log, we need to run with security on - all the other eventLog-specific tests are in the spaces_only tests, so we reference some of the utilities used there via import.

pmuellr · 2020-11-11T14:55:55Z

x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log.ts

  }

-  function validateEvent(event: IValidatedEvent, params: ValidateEventLogParams): void {


for this diff section, best viewed with ignore whitespace, as I lifted some functions out of a function scope, to make them top-level, so they could be exported, so they could be reused by the security_and_spaces tests

pmuellr · 2020-11-11T14:56:42Z

I've added a number of comments to the PR as guide posts - lots of stuff that seems a bit obscure in this PR :-)

ymao1

LGTM. Verified that for event log where action = execute, there is now a status field with executionStatus and that if the status is error, a reason is populated.

dhurley14

LGTM! This is awesome thanks very much! Tested it out locally I'm hoping to switch over from using our rule status saved object to just reading errors through the getAlertInstanceSummary on the alertsClient. Looks like that will work. This will really help detections clean things up in our own codebase.

YulNaumenko

LGTM!

pmuellr · 2020-11-12T00:51:23Z

@elasticmachine merge upstream

kibanamachine · 2020-11-12T02:37:39Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: fef5f43

Metrics [docs]

✅ unchanged

History

💚 Build #87096 succeeded a4599f9
💚 Build #87011 succeeded 05759b9787b68eb1f5f827363c8950469f7a4864
💚 Build #87001 succeeded b20bad05e6dae75124d29e7fe47c510c5b220df1
💚 Build #86635 succeeded c6b1ba4e273cdadee913bc041934fa0083e337a2
💔 Build #86625 failed 52bb9c01b318c43e4dc321b11039bb7ff1d2e0b7

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

…stic#82401) resolves elastic#79785 Until now, the execution status was available in the the event log document for the execute action. In this PR we add it. The event log is extended to add the following fields: - `kibana.alerting.status` - from executionStatus.status - `event.reason` - from executionStatus.error.reason The date from the executionStatus and start date in the event log will be set to the same value. Previously, errors encountered while trying to execute an alert executor, eg decrypting the alert, would not end up with an event doc generated. Now they will. In addition, there were a few places where events that could have had the action group in them did not, and one where the instance id was undefined - those were fixed up.

* master: [Advanced Settings] Introducing telemetry (elastic#82860) [alerts] add executionStatus to event log doc for action execute (elastic#82401) Add additional sources routes (elastic#83227) [ML] Persisted URL state for the "Anomaly detection jobs" page (elastic#83149) [Logs UI] Add pagination to the log stream shared component (elastic#81193) [Index Management] Add an index template link to data stream details (elastic#82592) Add maps_oss folder to code_owners (elastic#83204) fix truncation issue (elastic#83000) [Ingest Manger] Move asset getters out of registry (elastic#83214)

) (#83289) resolves #79785 Until now, the execution status was available in the the event log document for the execute action. In this PR we add it. The event log is extended to add the following fields: - `kibana.alerting.status` - from executionStatus.status - `event.reason` - from executionStatus.error.reason The date from the executionStatus and start date in the event log will be set to the same value. Previously, errors encountered while trying to execute an alert executor, eg decrypting the alert, would not end up with an event doc generated. Now they will. In addition, there were a few places where events that could have had the action group in them did not, and one where the instance id was undefined - those were fixed up.

… alerts/action-groups-as-conditions * origin/alerts/stack-alerts-public: (91 commits) removed import from plugin code as it causes FTR to fail [Advanced Settings] Introducing telemetry (elastic#82860) [alerts] add executionStatus to event log doc for action execute (elastic#82401) Add additional sources routes (elastic#83227) [ML] Persisted URL state for the "Anomaly detection jobs" page (elastic#83149) [Logs UI] Add pagination to the log stream shared component (elastic#81193) [Index Management] Add an index template link to data stream details (elastic#82592) Add maps_oss folder to code_owners (elastic#83204) fix truncation issue (elastic#83000) [Ingest Manger] Move asset getters out of registry (elastic#83214) make defaulted field non maybe Remove unused asciidoc file (elastic#83228) [Lens] Remove background from lens embeddable (elastic#83061) [Discover] Unskip flaky tests based on discover fixture index pattern (elastic#82991) Removing unnecessary trailing slash in CODEOWNERS Trying to fix CODEOWNERS again, where was a non-existent team prior (elastic#83236) Trying to fix CODEOWERS, missing a starting slash (elastic#83233) skip flaky suite (elastic#83231) Add enzyme rerender test helper (elastic#83208) Move Elasticsearch type definitions out of APM (elastic#83081) ...

pmuellr force-pushed the alerts/log-execution-status branch 2 times, most recently from c356721 to 3ca7c23 Compare November 5, 2020 02:08

pmuellr mentioned this pull request Nov 5, 2020

[Alerting] the alert updated_at field is no representative of the last update by a user #82701

Closed

pmuellr force-pushed the alerts/log-execution-status branch 2 times, most recently from eb34d38 to 52bb9c0 Compare November 8, 2020 22:22

pmuellr commented Nov 9, 2020

View reviewed changes

x-pack/plugins/alerts/server/task_runner/task_runner.test.ts Outdated Show resolved Hide resolved

x-pack/plugins/alerts/server/task_runner/task_runner.test.ts Outdated Show resolved Hide resolved

pmuellr force-pushed the alerts/log-execution-status branch from 05759b9 to 1822d4d Compare November 10, 2020 14:55

pmuellr force-pushed the alerts/log-execution-status branch from 1822d4d to a4599f9 Compare November 10, 2020 14:58

pmuellr added Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) release_note:skip Skip the PR/issue when compiling release notes v7.11 v8.0.0 labels Nov 10, 2020

pmuellr marked this pull request as ready for review November 10, 2020 17:27

pmuellr requested a review from a team as a code owner November 10, 2020 17:27

pmuellr commented Nov 11, 2020

View reviewed changes

ymao1 approved these changes Nov 11, 2020

View reviewed changes

dhurley14 approved these changes Nov 11, 2020

View reviewed changes

YulNaumenko approved these changes Nov 11, 2020

View reviewed changes

dhurley14 mentioned this pull request Nov 12, 2020

[Security Solution] [Detections] Replace rule status saved object #83235

Closed

Merge branch 'master' into alerts/log-execution-status

fef5f43

pmuellr merged commit c3e5794 into elastic:master Nov 12, 2020

pmuellr mentioned this pull request Nov 12, 2020

[7.x] [alerts] add executionStatus to event log doc for action execute (#82401) #83289

Merged

pmuellr added the backported label Nov 12, 2020

pmuellr added the v7.11.0 label Nov 16, 2020

pmuellr mentioned this pull request Dec 4, 2020

[Alerting] Index threshold: Actions not fired as expected #84335

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[alerts] add executionStatus to event log doc for action execute #82401

[alerts] add executionStatus to event log doc for action execute #82401

pmuellr commented Nov 3, 2020 •

edited

Loading

pmuellr left a comment

elasticmachine commented Nov 10, 2020

pmuellr commented Nov 11, 2020

pmuellr Nov 11, 2020

pmuellr Nov 11, 2020

pmuellr Nov 11, 2020 •

edited

Loading

pmuellr Nov 11, 2020

pmuellr Nov 11, 2020

pmuellr Nov 11, 2020

pmuellr Nov 11, 2020

pmuellr commented Nov 11, 2020

ymao1 left a comment

dhurley14 left a comment

YulNaumenko left a comment

pmuellr commented Nov 12, 2020

kibanamachine commented Nov 12, 2020

		@@ -184,11 +184,15 @@ describe('Task Runner', () => {
		expect(eventLogger.logEvent).toHaveBeenCalledTimes(1);

		}

		function validateEvent(event: IValidatedEvent, params: ValidateEventLogParams): void {

[alerts] add executionStatus to event log doc for action execute #82401

[alerts] add executionStatus to event log doc for action execute #82401

Conversation

pmuellr commented Nov 3, 2020 • edited Loading

Summary

Checklist

pmuellr left a comment

Choose a reason for hiding this comment

elasticmachine commented Nov 10, 2020

pmuellr commented Nov 11, 2020

pmuellr Nov 11, 2020

Choose a reason for hiding this comment

pmuellr Nov 11, 2020

Choose a reason for hiding this comment

pmuellr Nov 11, 2020 • edited Loading

Choose a reason for hiding this comment

pmuellr Nov 11, 2020

Choose a reason for hiding this comment

pmuellr Nov 11, 2020

Choose a reason for hiding this comment

pmuellr Nov 11, 2020

Choose a reason for hiding this comment

pmuellr Nov 11, 2020

Choose a reason for hiding this comment

pmuellr commented Nov 11, 2020

ymao1 left a comment

Choose a reason for hiding this comment

dhurley14 left a comment

Choose a reason for hiding this comment

YulNaumenko left a comment

Choose a reason for hiding this comment

pmuellr commented Nov 12, 2020

kibanamachine commented Nov 12, 2020

💚 Build Succeeded

Metrics [docs]

History

pmuellr commented Nov 3, 2020 •

edited

Loading

pmuellr Nov 11, 2020 •

edited

Loading