[alerting] add mustache variable for Kibana's publicly exposed base URL #90525

pmuellr · 2021-02-05T22:19:18Z

resolves #49392

Adds the top-level mustache variable kibanaBaseUrl for action parameter
mustache templates. The value comes from Kibana config, which, if not set
will result in this variable having the value undefined.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
~~Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
~~Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)~~
~~Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)~~
~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
~~This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)~~
~~This was checked for cross-browser compatibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately

pmuellr · 2021-02-05T22:32:26Z

POC at the moment, just wanted to make sure we could do this.

Here's the contents of the message param for Slack - the last three lines are added from the default, and make use of the new variable. The wrapping in {{#...}}...{{/...}} are so that the "View in" line will only be rendered if kibanaBaseUrl is an actual string value. It could be undefined, if this url has not been specifically configured in the kibana.yml file.

alert '{{alertName}}' is active for group '{{context.group}}':

- Value: {{context.value}}
- Conditions Met: {{context.conditions}} over {{params.timeWindowSize}}{{params.timeWindowUnit}}
- Timestamp: {{context.date}}

{{#kibanaBaseUrl}}
View in <{{kibanaBaseUrl}}/app/management/insightsAndAlerting/triggersActions/alert/{{alertId}}|Kibana>
{{/kibanaBaseUrl}}

Here's how it renders in Slack - and it works!

pmuellr · 2021-02-09T13:54:05Z

Additional note that being able to display "nice" links in Slack and email can't be done with a single message that would work in both. For email, you'd need to use [link text here]({{kibanaBaseUrl}}/...) and slack <{{kibanaBaseUrl}}/...|link text here>.

So there's no way I know of to create a nice link like this with the defaultActionMessage capability. We'll need to wait for this issue, which will provide a way to generate default messages given different formats, action groups, etc - #66095

Until that issue is resolved, alert implementors should probably just reference the url by itself if used in a defaultActionMessage, like so:

default message here.  view in Kibana: {{kibanaBaseUrl}}/...

Both email and slack will render these as links, but the text will be the complete URL.

resolves elastic#49392 Adds the top-level mustache variable `kibanaBaseUrl` for action parameter mustache templates. The value comes from Kibana config, which, if not set will result in this variable having the value `undefined`.

pmuellr · 2021-02-16T04:44:38Z

jenkins retest this please

kibanamachine · 2021-02-16T06:54:42Z

💚 Build Succeeded

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	+1.0KB

History

💔 Build #106709 failed f21c638
💔 Build #106702 failed 2fd6f272130b3a617cdd2ebf2f96f47df9b67c88
💚 Build #106059 succeeded 563ae40e774fa70305ec881ae06b7e16343fe593
💔 Build #105800 failed a3bc837c0c6661cc70b81598758356c4dedadf1f
💔 Build #104447 failed 4b37810e2794cd503e727ef4ec08b33ab101e955

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

elasticmachine · 2021-02-16T12:25:10Z

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

pmuellr · 2021-02-16T12:28:24Z

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

@@ -161,6 +161,7 @@ export class AlertingPlugin {
  private eventLogService?: IEventLogService;
  private eventLogger?: IEventLogger;
  private readonly kibanaIndexConfig: Observable<{ kibana: { index: string } }>;
+  private kibanaBaseUrl: string | undefined;


new instance variable so we can capture the path in setup and use it in start

pmuellr · 2021-02-16T12:29:28Z

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

@@ -39,6 +39,7 @@ export interface CreateExecutionHandlerOptions<
  actions: AlertAction[];
  spaceId: string;
  apiKey: RawAlert['apiKey'];
+  kibanaBaseUrl: string | undefined;


there were a couple of paths of threading this new variable into the right place, this required the fewest number of changes

pmuellr · 2021-02-16T12:31:01Z

x-pack/plugins/triggers_actions_ui/public/application/lib/action_variables.test.ts

@@ -44,10 +44,18 @@ describe('transformActionVariables', () => {
          "description": "The alert action group that was used to scheduled actions for the alert.",
          "name": "alertActionGroup",
        },
+        Object {


I double-checked the variables we're making available, alertActionSubgroup should have been here, but was not, so added it.

pmuellr · 2021-02-16T12:32:14Z

x-pack/test/alerting_api_integration/common/config.ts

@@ -97,7 +98,7 @@ export function createTestConfig(name: string, options: CreateTestConfigOptions)
        ...xPackApiIntegrationTestsConfig.get('kbnTestServer'),
        serverArgs: [
          ...xPackApiIntegrationTestsConfig.get('kbnTestServer.serverArgs'),
-          '--server.publicBaseUrl=https://localhost:5601',
+          ...(options.publicBaseUrl ? ['--server.publicBaseUrl=https://localhost:5601'] : []),


changed so security_and_spaces runs WITH the configured url, but spaces_only does not

pmuellr · 2021-02-16T12:33:19Z

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

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


this is a copy of the spaces_only tests, but only included a test for the new action variable, since it's now different between the two

ymao1

LGTM!

YulNaumenko

LGTM

…exposed base URL (elastic#90525) resolves elastic#49392 Adds the top-level mustache variable `kibanaBaseUrl` for action parameter mustache templates. The value comes from Kibana config, which, if not set will result in this variable having the value `undefined` which will be rendered as an empty string.

…exposed base URL (#90525) (#91563) resolves #49392 Adds the top-level mustache variable `kibanaBaseUrl` for action parameter mustache templates. The value comes from Kibana config, which, if not set will result in this variable having the value `undefined` which will be rendered as an empty string.

pmuellr requested a review from a team as a code owner February 5, 2021 22:19

pmuellr closed this Feb 5, 2021

pmuellr reopened this Feb 5, 2021

pmuellr marked this pull request as draft February 5, 2021 22:20

darnautov mentioned this pull request Feb 10, 2021

[ML] Anomaly Detection alert type #89286

Merged

7 tasks

pmuellr force-pushed the alerting/kibana-url-action-variable branch 2 times, most recently from 2fd6f27 to 40d5cdf Compare February 15, 2021 23:36

pmuellr force-pushed the alerting/kibana-url-action-variable branch from 40d5cdf to f21c638 Compare February 15, 2021 23:37

pmuellr added Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.12 v8.0.0 release_note:skip Skip the PR/issue when compiling release notes needs_docs labels Feb 16, 2021

pmuellr marked this pull request as ready for review February 16, 2021 12:25

pmuellr commented Feb 16, 2021

View reviewed changes

ymao1 approved these changes Feb 16, 2021

View reviewed changes

YulNaumenko approved these changes Feb 16, 2021

View reviewed changes

pmuellr merged commit 20e16bd into elastic:master Feb 16, 2021

pmuellr removed the v7.12 label Feb 16, 2021

pmuellr added the v7.12.0 label Feb 16, 2021

pmuellr mentioned this pull request Feb 16, 2021

[7.x] [alerting] add mustache variable kibanaBaseUrl for Kibana's publicly exposed base URL (#90525) #91563

Merged

pmuellr added the backported label Feb 17, 2021

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

pmuellr mentioned this pull request May 6, 2021

[Security Solution] Sending Entire Detection Alert JSON to JIRA Service Desk Issue Output Doesn't Work #95618

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[alerting] add mustache variable for Kibana's publicly exposed base URL #90525

[alerting] add mustache variable for Kibana's publicly exposed base URL #90525

pmuellr commented Feb 5, 2021 •

edited

Loading

pmuellr commented Feb 5, 2021

pmuellr commented Feb 9, 2021

pmuellr commented Feb 16, 2021

kibanamachine commented Feb 16, 2021

elasticmachine commented Feb 16, 2021

pmuellr Feb 16, 2021

pmuellr Feb 16, 2021

pmuellr Feb 16, 2021

pmuellr Feb 16, 2021

pmuellr Feb 16, 2021

ymao1 left a comment

YulNaumenko left a comment

[alerting] add mustache variable for Kibana's publicly exposed base URL #90525

[alerting] add mustache variable for Kibana's publicly exposed base URL #90525

Conversation

pmuellr commented Feb 5, 2021 • edited Loading

Checklist

For maintainers

pmuellr commented Feb 5, 2021

pmuellr commented Feb 9, 2021

pmuellr commented Feb 16, 2021

kibanamachine commented Feb 16, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

History

elasticmachine commented Feb 16, 2021

pmuellr Feb 16, 2021

Choose a reason for hiding this comment

pmuellr Feb 16, 2021

Choose a reason for hiding this comment

pmuellr Feb 16, 2021

Choose a reason for hiding this comment

pmuellr Feb 16, 2021

Choose a reason for hiding this comment

pmuellr Feb 16, 2021

Choose a reason for hiding this comment

ymao1 left a comment

Choose a reason for hiding this comment

YulNaumenko left a comment

Choose a reason for hiding this comment

pmuellr commented Feb 5, 2021 •

edited

Loading