GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/711
METRON-1127: Add ability to escalate alerts for external consumption
## Contributor Comments
This PR exposes a way to put alerts (or any message) into a configurable
escalation Kafka topic. In summary:
- Adds a "metron_escalation_topic" parameter to MPack and Spring property
file
- Provides a default value and sets up the topic upon MPack installation
- Adds a new AlertController for this and future alert-related functions
- Adds a producer to the Kafka service and controller
- Adds and updates the appropriate unit and integration tests, including
making the KafkaControllerIntegrationTest simpler
- Adds documentation to the README
This can be tested in full dev with Swagger by first ensuring the
"escalation" topic is automatically created and showing up in the list of
topics (use the "/api/v1/kafka/topic" endpoint). Next use
"/api/v1/alert/escalate" endpoint in the alert-controller to escalate an alert,
you should receive a 200 response code. Finally get the latest message from
the Kafka "escalation" topic with "/api/v1/kafka/topic/{name}/sample" endpoint.
You should get the same message that you escalated in the previous step.
## 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/merrimanr/incubator-metron METRON-1127
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/711.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 #711
----
commit 5f8f49cff4050b57a07347be6f2fe6ce131494c9
Author: merrimanr <merrim...@gmail.com>
Date: 2017-08-22T19:54:19Z
initial commit
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
