[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client #30043

sebelga · 2019-02-05T07:25:00Z

This PR adds the missing action types on the Watcher UI client. There recently was an issue (#29787) related to the Webhook action missing and it came to the light that there were other action types missing.

Index action
HipChat action
PagerDuty action
Jira action

How to test

Start by creating a watcher with a webhook action in the dev console

PUT _watcher/watch/my-watch
{
  "trigger" : {
    "schedule" : { "cron" : "0/5 * * * * ?" }
  },
  "input" : {
    "search" : {
      "request" : {
        "indices" : [
          "kibana_sample_data_flights"
        ],
        "body" : {
          "query" : {
            "bool" : {
              "must" : {
                "match": {
                   "Carrier": "Kibana Airlines"
                }
              }
            }
          }
        }
      }
    }
  },
  "condition" : {
    "compare" : { "ctx.payload.hits.total" : { "gt" : 0 }}
  },
  "actions" : {
    "my_webhook" : { 
      "webhook" : {
        "method" : "POST", 
        "host" : "localhost", 
        "port" : 3000, 
        "path": ":/{{ctx.watch_id}}", 
        "body" : "id={{ctx.watch_id}}, hits={{ctx.payload.hits.total}}" 
      }
    }
  }
}

Got to the Watcher app and click on "edit" on the row of the created watcher

What we want to test is making sure that the body of the HTTP request contains the corresonding values that we have defined in the JSON editor (and of course that the application does not crash) when saving the watcher.

In the Kibana JSON editor, at the bottom in the "actions" > "my_action" replace the "webhook" property with:

Hiphat action

"hipchat" : {
    "account" : "user-account",
    "message" : {
    "room" : [ "mission-control", "devops" ],
    "user" : "[email protected]",
    "body" : "Encountered  {{ctx.payload.hits.total}} errors in the last 5 minutes (facepalm)",
    "format" : "text",
    "color" : "red",
    "notify" : true
    }
}

Click the "save" button

You should get a toast error message, which is ok. The important part is that the body of the request that has been sent contains the action that we have just defined. It should be under watch.actions.my_actions of the PUT request body.

Repeat the same test with the other action types:

PagerDuty action

"pagerduty" : {
    "account" : "team1",
    "description" : "Main system down, please check! Happened at {{ctx.execution_time}}",
    "attach_payload" : true,
    "client" : "/foo/bar/{{ctx.watch_id}}",
    "client_url" : "http://www.example.org/",
    "contexts" : [
        {
            "type": "link",
            "href": "http://acme.pagerduty.com"
        },{
            "type": "link",
            "href": "http://acme.pagerduty.com",
            "text": "View the incident on {{ctx.payload.link}}"
        }
    ]
}

Jira action

"jira" : {
    "account" : "integration-account", 
    "fields" : {
        "project" : {
        "key": "PROJ" 
        },
        "issuetype" : {
        "name": "Bug" 
        },
        "summary" : "Encountered {{ctx.payload.hits.total}} errors in the last 5 minutes", 
        "description" : "Encountered {{ctx.payload.hits.total}} errors in the last 5 minutes (facepalm)", 
        "labels" : ["auto"], 
        "priority" : {
        "name" : "High" 
        }
    }
}

Index action

"index" : {
    "index" : "my-index", 
    "doc_type" : "my-type", 
    "doc_id": "my-id" 
}

elasticmachine · 2019-02-05T07:26:22Z

Pinging @elastic/es-ui

elasticmachine · 2019-02-05T08:05:25Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…ng-action-types

elasticmachine · 2019-02-05T08:59:31Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

cjcenizal

Haven't had time to test locally yet, but the code LGTM! Had some suggestions which we can address separately.

cjcenizal · 2019-02-05T14:43:57Z

x-pack/plugins/watcher/public/models/action/index.action.js

+    super(props);
+
+    allFields.forEach((field) => {
+      this[field] = get(props, field);


I could see a potentially difficult problem to debug if we ever add support for a field which collides with one of the class properties (e.g. description). This is compounded by the presence of properties inherited from BaseAction. What do you think of assigning these fields to an instance property, to eliminate this possibility? For example:

this.fields = {}; allFields.forEach((field) => { this.fields[field] = get(props, field); });

This change would have to be applied to all of the other actions too, and if any code is depending on these dynamic properties then this change could be significant; probably too significant for this PR. Let me know if you want me to move this suggestion into a separate issue.

Good point, I'll check for property collision.

cjcenizal · 2019-02-05T14:47:38Z

x-pack/plugins/watcher/public/models/action/index.action.js

+    });
+  }
+
+  get upstreamJson() {


I didn't look very closely, but this method looks duplicated throughout all of the actions. Would it make sense to extract it into a generalized service?

Yes you are right this could be optimized but as Watcher will be rewritten I just wanted to prevent future bugs in the meantime because this file was missing.

cjcenizal · 2019-02-05T15:10:05Z

If possible, it would be very helpful to also update the description with steps for testing, e.g. various requests to make in Dev Tools, and any settings we need to change for X-Pack.

…ng-action-types

sebelga · 2019-02-06T16:03:20Z

@cjcenizal I just updated the comment to explain how to test. Can you have another look?

elasticmachine · 2019-02-06T16:55:34Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

cjcenizal

Thanks for the steps to test! This really helped me a lot. I was able to test locally and verify the behavior works as expected. This information also helped me learn more about Watcher in general and I was able to spot a few errors in the code.

cjcenizal · 2019-02-06T17:14:39Z

x-pack/plugins/watcher/public/models/action/jira.action.js

+    return i18n.translate('xpack.watcher.models.jiraAction.description', {
+      defaultMessage: '{issueName} will be created in Jira',
+      values: {
+        issueName: this.fields && this.fields.issuetype && this.fields.issuetype.name || ''


From the Jira action docs it looks like the expected shape is:

{ "account" : "integration-account", "fields" : { "issue" : { "issuetype" : { "name": "Bug" } } } }

So I think the correct path should be this.fields.fields.issue.issuetype.name, right?

If we're already using lodash's get, I think we might as well use that here too:

get(this.fields, 'fields.issue.issuetype.name', '');

Good catch!

cjcenizal · 2019-02-06T17:17:40Z

x-pack/plugins/watcher/public/models/action/index.action.js

+      defaultMessage: 'The {index} will be indexed as {docType}',
+      values: {
+        index: this.index,
+        docType: this.doc_type,


I think we need to update the fields references here:

this.index -> this.fields.index

this.doc_type -> this.fields.doc_type

cjcenizal · 2019-02-06T17:18:13Z

x-pack/plugins/watcher/public/models/action/hipchat.action.js

+    return i18n.translate('xpack.watcher.models.hipchatAction.description', {
+      defaultMessage: '{body} will be sent through Hipchat',
+      values: {
+        body: this.message && this.message.body || ''


I think we need to update references of this.message to this.fields.message.

cjcenizal · 2019-02-06T17:19:35Z

x-pack/plugins/watcher/public/models/action/pagerduty.action.js

+    return i18n.translate('xpack.watcher.models.pagerDutyAction.description', {
+      defaultMessage: '{description} will be sent to PagerDuty',
+      values: {
+        description: this.description,


this.description -> this.fields.description

cjcenizal · 2019-02-06T17:23:35Z

x-pack/plugins/watcher/public/models/action/webhook.action.js

    allFields.forEach((field) => {
-      this[field] = get(props, field);
+      this.fields[field] = get(props, field);
    });

    this.fullPath = this.url ? this.url : this.host + this.port + this.path;


const { url, host, port, path } = this.fields; this.fullPath = url ? url : host + port + path;

sebelga · 2019-02-08T10:03:27Z

@cjcenizal updated the PR with your changes. Can you have another look? cheers!

elasticmachine · 2019-02-08T10:50:22Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…ng-action-types

elasticmachine · 2019-02-08T13:50:19Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

cjcenizal

Looks great, Seb!

cjcenizal · 2019-02-08T17:41:40Z

This is a step towards addressing #18059.

… client (elastic#30043)

… client (#30043) (#30620)

… client (elastic#30043)

… client (#30043) (#31559)

… client (#30043) (#31560)

immon · 2019-02-22T10:36:23Z

Since it has been backported to 6.6 and 6.7 branches can we have version labels added to the issue? Which 6.6 version is going to include the fix?

cjcenizal · 2019-02-22T17:05:45Z

Thanks for the reminder @immon. This will ship in 6.6.2 and 6.7.0.

… client (elastic#30043)

… client (#30043) (#35539)

sebelga added 4 commits February 4, 2019 15:57

[Watcher] Add missing IndexAction on the client

d13ecac

[Watcher] Add missing Hipchat action on the client

968d279

[Watcher] Add missing PagerDuty action on the client

f783d34

[Watcher] Add missing Jira action on the client

57aa9cd

sebelga requested review from cjcenizal and bmcconaghy February 5, 2019 07:25

sebelga added v7.0.0 Feature:Watcher Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v6.7.0 labels Feb 5, 2019

Merge remote-tracking branch 'upstream/master' into fix/watcher-missi…

e902b27

…ng-action-types

cjcenizal mentioned this pull request Feb 5, 2019

[Watcher] Add Webhook Action type on client #29818

Merged

5 tasks

cjcenizal approved these changes Feb 5, 2019

View reviewed changes

Merge remote-tracking branch 'upstream/master' into fix/watcher-missi…

301b507

…ng-action-types

sebelga removed v6.7.0 v7.0.0 labels Feb 6, 2019

Move action fields property to instance object to avoid collision

a46a96d

cjcenizal suggested changes Feb 6, 2019

View reviewed changes

Add CR changes

4f3da9e

Merge remote-tracking branch 'upstream/master' into fix/watcher-missi…

361e624

…ng-action-types

sebelga added the v8.0.0 label Feb 8, 2019

sebelga added the v7.2.0 label Feb 8, 2019

cjcenizal approved these changes Feb 8, 2019

View reviewed changes

cjcenizal changed the title ~~[Watcher] Add missing Action types on the client~~ [Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client Feb 8, 2019

sebelga merged commit 6b376e5 into elastic:master Feb 11, 2019

sebelga deleted the fix/watcher-missing-action-types branch February 11, 2019 08:39

sebelga added a commit to sebelga/kibana that referenced this pull request Feb 11, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

2e2525e

… client (elastic#30043)

sebelga mentioned this pull request Feb 11, 2019

[7.x] [Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client (#30043) #30620

Merged

cjcenizal pushed a commit that referenced this pull request Feb 12, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

a590b2f

… client (#30043) (#30620)

cjcenizal mentioned this pull request Feb 12, 2019

Error: “Attempted to create unknown action type pagerduty.” when trying to update a watcher in Kibana #30804

Closed

sebelga mentioned this pull request Feb 20, 2019

[6.7] [Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client (#30043) #31559

Merged

sebelga added a commit to sebelga/kibana that referenced this pull request Feb 20, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

faea89d

… client (elastic#30043)

sebelga mentioned this pull request Feb 20, 2019

[6.6] [Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client (#30043) #31560

Merged

sebelga added a commit to sebelga/kibana that referenced this pull request Feb 20, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

768e236

… client (elastic#30043)

sebelga added a commit that referenced this pull request Feb 20, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

448eb22

… client (#30043) (#31559)

sebelga added a commit that referenced this pull request Feb 21, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

bd7732c

… client (#30043) (#31560)

cjcenizal added v6.6.2 v6.7.0 labels Feb 22, 2019

sebelga added a commit to sebelga/kibana that referenced this pull request Apr 24, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

e242421

… client (elastic#30043)

sebelga mentioned this pull request Apr 24, 2019

[7.0] [Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client (#30043) #35539

Merged

cjcenizal added the v7.0.1 label Apr 24, 2019

cjcenizal pushed a commit that referenced this pull request Apr 24, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the…

1daf31f

… client (#30043) (#35539)

alisonelizabeth mentioned this pull request Apr 25, 2019

[Watcher] Support for adding actions to threshold watch #35175

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client #30043

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client #30043

sebelga commented Feb 5, 2019 •

edited

Loading

elasticmachine commented Feb 5, 2019

elasticmachine commented Feb 5, 2019

elasticmachine commented Feb 5, 2019

cjcenizal left a comment

cjcenizal Feb 5, 2019

sebelga Feb 5, 2019

cjcenizal Feb 5, 2019

sebelga Feb 5, 2019

cjcenizal commented Feb 5, 2019

sebelga commented Feb 6, 2019

elasticmachine commented Feb 6, 2019

cjcenizal left a comment

cjcenizal Feb 6, 2019

sebelga Feb 8, 2019

cjcenizal Feb 6, 2019

cjcenizal Feb 6, 2019

cjcenizal Feb 6, 2019

cjcenizal Feb 6, 2019

sebelga commented Feb 8, 2019

elasticmachine commented Feb 8, 2019

elasticmachine commented Feb 8, 2019

cjcenizal left a comment

cjcenizal commented Feb 8, 2019

immon commented Feb 22, 2019

cjcenizal commented Feb 22, 2019

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client #30043

[Watcher] Add Index, HipChat, PagerDuty, and Jira Action types on the client #30043

Conversation

sebelga commented Feb 5, 2019 • edited Loading

How to test

Hiphat action

PagerDuty action

Jira action

Index action

elasticmachine commented Feb 5, 2019

elasticmachine commented Feb 5, 2019

💔 Build Failed

elasticmachine commented Feb 5, 2019

💚 Build Succeeded

cjcenizal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjcenizal commented Feb 5, 2019

sebelga commented Feb 6, 2019

elasticmachine commented Feb 6, 2019

💚 Build Succeeded

cjcenizal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebelga commented Feb 8, 2019

elasticmachine commented Feb 8, 2019

💔 Build Failed

elasticmachine commented Feb 8, 2019

💚 Build Succeeded

cjcenizal left a comment

Choose a reason for hiding this comment

cjcenizal commented Feb 8, 2019

immon commented Feb 22, 2019

cjcenizal commented Feb 22, 2019

sebelga commented Feb 5, 2019 •

edited

Loading