GitHub user justinleet opened a pull request:
https://github.com/apache/metron/pull/780
METRON-1220: Create documentation around alert nested field
## Contributor Comments
Adding some docs around the requirement of an "alert" field on new sensors.
There's an open discussion thread [[DISCUSS] Meta alert Elasticsearch new
template requirement
ramifications](https://lists.apache.org/thread.html/418ec07c67670f685cc42acfedde85cbd90c80301ea7819093e787f8@%3Cdev.metron.apache.org%3E)
that has at least one question about what this should look like, so feel free
to chime in there.
Outstanding Question
* Where should this live? I have this put up, so people can see what it
says, but I'm pretty sure it should live somewhere else, under a different
heading. I'm just not sure what the best fit is.
* Should additional documentation around our ES templates and other sensors
requirements be added now or in the future.
I'll be running the proposed curl up in full dev, so that's slightly
subject to change. Normally, updates to temples don't affect existing ES
indices, but since it's a dummy field without data I cautiously expect it to
function.
## 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?
- [ ] 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)?
- [ ] 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/justinleet/metron METRON-1220
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/780.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 #780
----
commit bc4feff87f1a2e8380419f48ea6aa24aba0fa034
Author: justinjleet <[email protected]>
Date: 2017-09-29T14:57:27Z
Adding some documentation around ES alert template
----
---
