[alerts] adds action group and date to mustache template variables for actions by pmuellr · Pull Request #83195 · elastic/kibana

pmuellr · 2020-11-11T17:42:30Z

resolves: #67389

Adds new variables to the existing set of variables that can be used in mustache templates to be used in action parameters when creating alerts.

alertActionGroup - the action group associated with the alert scheduling actions
date - the current date, in ISO format

Checklist

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

note that I left Documentation unchecked, but also added the needs_docs label per recent conversation on getting doc added - we'll need these new variables added to whatever documentation we have on these mustache variables

…r actions resolves: elastic#67389

elasticmachine · 2020-11-17T03:42:25Z

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

YulNaumenko

LGTM

gmmorris

Works as expected, so LGTM, my only concerns is with naming (always the easiest problem, ey?):

Shouldn't alertActionGroup actually be alertInstanceActionGroup? or perhaps instanceActionGroup?

pmuellr · 2020-11-17T15:02:03Z

@gmmorris: Shouldn't alertActionGroup actually be alertInstanceActionGroup? or perhaps instanceActionGroup?

My vote is no.

Here's the full list of top-level names we make available as variables:

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

Lines 47 to 59 in c4543cc

    
           const variables = { 
        
             alertId, 
        
             alertName, 
        
             spaceId, 
        
             tags, 
        
             alertInstanceId, 
        
             alertActionGroup, 
        
             context, 
        
             date: new Date().toISOString(), 
        
             state, 
        
             params: alertParams, 
        
           }; 
        
           return Mustache.render(value, variables);

Aside - this list always bugs me, I feel like maybe it makes more sense to have an alert object with the alert-prefixed variables in it, without the alert- prefix, kinda thing. A fight for another day :-)

We do have alertInstanceId, but that's basically alert + instanceId, so follows the "alert + property/well-known name" convention with the other names.

A search through the code base doesn't find any references to instanceActionGroup, not that that matters much - these names are intended for customers, not developers.

It's also a mouthful. I guess my main argument against it would be that it's already implied that you're operating on an instance at this point, so it's not really needed. And it's a mouthful :-)

I can be convinced otherwise :-)

pmuellr · 2020-11-18T21:00:13Z

@elasticmachine merge upstream

kibanamachine · 2020-11-18T22:48:27Z

💚 Build Succeeded

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

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
`triggersActionsUi`	1.4MB	1.4MB	+460.0B

History

💚 Build #87996 succeeded c4543cc
💚 Build #87757 succeeded d515748ed799ba7f72a631f6eb5f193e37d067eb
💔 Build #87400 failed e34bd5a94df6b7fbbd64c14920839e650d35961e

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

…r actions (elastic#83195) resolves: elastic#67389 Adds new variables to the existing set of variables that can be used in mustache templates to be used in action parameters when creating alerts. - `alertActionGroup` - the action group associated with the alert scheduling actions - `date` - the current date, in ISO format

* master: skip "Dashboards linked by a drilldown are both copied to a space" (elastic#83824) [alerts] adds action group and date to mustache template variables for actions (elastic#83195) skip flaky suite (elastic#79389) [DOCS] Reallocates limitations to point-of-use (elastic#79582) [Enterprise Search] Engine overview layout stub (elastic#83756) Disable exporting/importing of templates. Optimize pitch images a bit (elastic#83098) [DOCS] Consolidates plugins (elastic#83712) [ML] Space management UI (elastic#83320) test just part of the message to avoid updates (elastic#83703) [Data Table] Remove extra column in split mode (elastic#83193) Improve snapshot error messages (elastic#83785) skip flaky suite (elastic#83773) skip flaky suite (elastic#83771) skip flaky suite (elastic#65278) skip flaky suite (elastic#83793) [Task Manager] Ensures retries are inferred from the schedule of recurring tasks (elastic#83682) [index patterns] improve index pattern cache (elastic#83368) [Fleet] Rename ingestManager plugin ID fleet (elastic#83200) fixed pagination in connectors list (elastic#83638)

…r actions (elastic#83195) resolves: elastic#67389 Adds new variables to the existing set of variables that can be used in mustache templates to be used in action parameters when creating alerts. - `alertActionGroup` - the action group associated with the alert scheduling actions - `date` - the current date, in ISO format

…r actions (#83195) (#83828) resolves: #67389 Adds new variables to the existing set of variables that can be used in mustache templates to be used in action parameters when creating alerts. - `alertActionGroup` - the action group associated with the alert scheduling actions - `date` - the current date, in ISO format

pmuellr added the needs_docs label Nov 11, 2020

pmuellr force-pushed the alerts/action-group-in-mustache-variables branch from d515748 to dd3fd9a Compare November 16, 2020 14:13

[alerts] adds action group and date to mustache template variables fo…

c4543cc

…r actions resolves: elastic#67389

pmuellr force-pushed the alerts/action-group-in-mustache-variables branch from dd3fd9a to c4543cc Compare November 16, 2020 14:19

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

pmuellr marked this pull request as ready for review November 17, 2020 03:42

pmuellr requested a review from a team as a code owner November 17, 2020 03:42

YulNaumenko approved these changes Nov 17, 2020

View reviewed changes

gmmorris self-requested a review November 17, 2020 11:57

gmmorris approved these changes Nov 17, 2020

View reviewed changes

Merge branch 'master' into alerts/action-group-in-mustache-variables

f20b104

pmuellr merged commit f83e06f into elastic:master Nov 19, 2020

pmuellr mentioned this pull request Nov 19, 2020

[7.x] [alerts] adds action group and date to mustache template variables for actions (#83195) #83828

Merged

pmuellr added the backported label Nov 19, 2020

pmuellr mentioned this pull request Nov 19, 2020

Ability to add actions to alerts pmuellr/kbn-alert-load#2

Merged

mikecote added release_note:enhancement and removed release_note:skip Skip the PR/issue when compiling release notes labels Dec 16, 2020

pmuellr mentioned this pull request Feb 24, 2021

Catch-up release documentation - @pmuellr #90006

Closed

4 tasks

pmuellr removed the needs_docs label Mar 3, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[alerts] adds action group and date to mustache template variables for actions#83195

[alerts] adds action group and date to mustache template variables for actions#83195
pmuellr merged 2 commits intoelastic:masterfrom
pmuellr:alerts/action-group-in-mustache-variables

pmuellr commented Nov 11, 2020 •

edited

Loading

Uh oh!

elasticmachine commented Nov 17, 2020

Uh oh!

YulNaumenko left a comment

Uh oh!

gmmorris left a comment

Uh oh!

pmuellr commented Nov 17, 2020

Uh oh!

pmuellr commented Nov 18, 2020

Uh oh!

kibanamachine commented Nov 18, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

pmuellr commented Nov 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

elasticmachine commented Nov 17, 2020

Uh oh!

YulNaumenko left a comment

Choose a reason for hiding this comment

Uh oh!

gmmorris left a comment

Choose a reason for hiding this comment

Uh oh!

pmuellr commented Nov 17, 2020

Uh oh!

pmuellr commented Nov 18, 2020

Uh oh!

kibanamachine commented Nov 18, 2020

💚 Build Succeeded

Metrics [docs]

Async chunks

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pmuellr commented Nov 11, 2020 •

edited

Loading