You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by iraghumitra <gi...@git.apache.org> on 2017/10/05 10:28:35 UTC
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
GitHub user iraghumitra opened a pull request:
https://github.com/apache/metron/pull/788
METRON-1223: Support for adding comments to alerts
## Contributor Comments
This PR adds support for adding arbitrary text notes to an alert. This can be achieved by using METRON-1051.The comments along with comment contain username and timestamp of the comment
## Testing
- Login to alerts-ui
- Select an alert this will open the alerts detail pane
- Select the comments icon on the pane
- Add comment in the textarea and click on 'ADD COMMENT'
- If you hover over a comment the delete comment icon would be avialble to delete the comment
- E2E tests are available to test the add, delete comments
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.
Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified and tested manually?
- [x] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to verify your changes?
- [x] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/iraghumitra/incubator-metron METRON-1223
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/788.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #788
----
commit 869961d8c15bfacfba8e16f01cc50fcf82ee8fdb
Author: iraghumitra <ra...@gmail.com>
Date: 2017-10-05T08:50:05Z
Support for adding comments to alerts
----
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r143158180
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
In the short term, we could just consider this an unanalysed field, and not have comments searchable, no?
In terms of doing it properly, we already have the nested field issue with the meta-alerts concept, so reusing the same coping mechanisms seems viable.
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by iraghumitra <gi...@git.apache.org>.
Github user iraghumitra commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r144335342
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
@justinleet I captured this limitation in the caveats section of the alerts readme
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r143470175
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
@justinleet makes sense, the goal is to get something in fast and iterate, but it sounds like getting the field nested is not going to be much more work than the alerts work we already have to do, so can piggyback on that and minimise the upgrade effort. There is I believe some separate work going on making reindexing easier, which may help here (though we should also ensure that that work is DAO aware when reindexing commented stuff from HDFS)
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r143161957
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
@simonellistonball I think an `"index" : "no"` field would work? I think?
I think that still involves mapping updates since that's not the default and would need to be on every sensor (or we'll end up with analyzed or raw or whatever the default is fields). Which loops back around to backend changes. My concern with not doing a more complete solution is you'd have to reindex anything with a non null comments field, which is potentially a pain (and I don't know how much work that is, so it's also possible it's not at all a pain).
Using the meta alert coping mechanisms is still backend change, though. That primarily gets handled by the DAOs.
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/788
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by james-sirota <gi...@git.apache.org>.
Github user james-sirota commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r144174823
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
What I would recommend is just to document around potential issues. I think what we have here is fine
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r143198763
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
Thinking through this a bit more, my major concern of making it nonsearchable is that if we ever want to make those comments searchable, we'd probably have to eat a reindex of every sensor. Existing mappings can't be changed, you have to create a new index and migrate the data. That sounds awful. And I definitely can see cases where you'd want to search those comments (give me every comment that person X made in the last month. Give me every comment by person X regarding sensor Y. and so on).
If we make the field nested from the beginning, that does mean that the current patch calls need to be replace calls where the entire doc is constructed by the UI. Alternatively, we eat the backend work and make a comments endpoint that accepts a GUID and has add comment / delete comment and the backend constructs the new doc and ships it out.
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r143157741
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
I'm concerned that this will actually cause problems when searching comments in Elasticsearch. Keep in mind this is theoretical, since I'm not at all an ES expert.
Without comments this being a [Nested Object](https://www.elastic.co/guide/en/elasticsearch/guide/current/nested-objects.html), this ends up being subject to cross object mapping (see [Object Arrays](https://www.elastic.co/guide/en/elasticsearch/guide/current/complex-core-fields.html#object-arrays)). In fact, the actual example ES gives is on comment fields. To the best of my knowledge, this only becomes an issue when you want to do queries involving the actual comment fields (e.g. give me all of a particular user's comments between two times). For the case of just saving off and reading back comments, it should be fine; I'm worried it'll bite us later and it won't at all be obvious why.
We might want/need to actually make this a real nested field in ES, which unfortunately probably involves backend work and some maintenance of mappings / templates to ensure the field exists (which is a problem meta alerts also contend with).
---
[GitHub] metron pull request #788: METRON-1223: Support for adding comments to alerts
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/metron/pull/788#discussion_r144293192
--- Diff: metron-interface/metron-alerts/src/app/alerts/alert-details/alert-details.component.ts ---
@@ -133,6 +173,40 @@ export class AlertDetailsComponent implements OnInit {
});
}
+ onAddComment() {
+ let alertComment = new AlertComment(this.alertCommentStr, this.authenticationService.getCurrentUserName(), new Date().getTime());
+ let tAlertComments = this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment);
+ tAlertComments.unshift(alertComment);
+ this.patchAlert(new Patch('add', '/comments', tAlertComments));
+ }
+
+ patchAlert(patch: Patch) {
+ let patchRequest = new PatchRequest();
+ patchRequest.guid = this.alertSource.guid;
+ patchRequest.index = this.alertIndex;
+ patchRequest.patch = [patch];
+ patchRequest.sensorType = this.alertSourceType;
+
+ this.updateService.patch(patchRequest).subscribe(() => {
+ this.getData();
+ });
+ }
+
+ onDeleteComment(index: number) {
+ let commentText = 'Do you wish to delete the comment ';
+ if (this.alertCommentsWrapper[index].alertComment.comment.length > 25 ) {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment.substr(0, 25) + '...\'';
+ } else {
+ commentText += ' \'' + this.alertCommentsWrapper[index].alertComment.comment + '\'';
+ }
+
+ this.metronDialogBox.showConfirmationMessage(commentText).subscribe(response => {
+ if (response) {
+ this.alertCommentsWrapper.splice(index, 1);
+ this.patchAlert(new Patch('add', '/comments', this.alertCommentsWrapper.map(alertsWrapper => alertsWrapper.alertComment)));
--- End diff --
I'm good with that, as long as we document it
---