GitHub user mmiklavc opened a pull request:
https://github.com/apache/incubator-metron/pull/529
METRON-849: Add 'reason' to threat triage risk level rules doc
Simple doc change. Add missing doc for "reason" field in risk level rules.
Also fixed small formatting issue with markdown.
Sample "reason" looks like this example that I'll be adding to the blog
page soon:
```
"triageConfig" : {
"riskLevelRules" : [
{
"name" : "in_zeus",
"comment" : "Checks if this domain without subdomains matches
against the zeus threat intel list",
"reason" : "FORMAT('%s exists in the Zeus threat intel list',
domain_without_subdomains)",
"rule" :
"exists(threatintels.hbaseThreatIntel.domain_without_subdomains.zeusList)",
"score" : 5
},
{
"name" : "tld_check",
"comment" : "Applies a risk score based on the domain TLD",
"reason" : "FORMAT('%s does not end with com or net',
domain_without_subdomains)",
"rule" : "not(ENDS_WITH(domain_without_subdomains, '.com') or
ENDS_WITH(domain_without_subdomains, '.net'))",
"score" : 10
}
],
"aggregator" : "MAX",
"aggregationConfig" : { }
}
```
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron (Incubating).
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:
NA
### 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
bin/generate-md.sh
mvn site: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 recommened 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/mmiklavc/incubator-metron METRON-849
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/529.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 #529
----
commit 6497fb0fa28a8528bb0d9f1f2e431f79a5e2c9ed
Author: Michael Miklavcic <michael.miklav...@gmail.com>
Date: 2017-04-13T19:19:30Z
METRON-849: Add 'reason' to threat triage risk level rules doc
----
---
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.
---
