metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From justinleet <>
Subject [GitHub] metron pull request #780: METRON-1220: Create documentation around alert nes...
Date Fri, 29 Sep 2017 15:06:01 GMT
GitHub user justinleet opened a pull request:

    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
that has at least one question about what this should look like, so feel free to chime in
    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](
for the complete guide to follow for contributions.  
    Please refer also to our [Build Verification Guidelines](
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](

    - [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
    ### 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
    - [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/ 
    - [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](

    - [ ] 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]( 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 METRON-1220

Alternatively you can review and apply these changes as the patch at:

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 <>
Date:   2017-09-29T14:57:27Z

    Adding some documentation around ES alert template



View raw message