You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by cestella <gi...@git.apache.org> on 2017/08/30 18:59:01 UTC
[GitHub] metron pull request #724: METRON-1142: Add Geo Hashing functions to stellar
GitHub user cestella opened a pull request:
https://github.com/apache/metron/pull/724
METRON-1142: Add Geo Hashing functions to stellar
## Contributor Comments
Adding geo hashing functions to stellar would be a nice complement to the geo enrichment. Furthermore, geo hashing would provide binning and geographic based outlier analysis as a threat triage indicator.
Test plan imminent.
## 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/cestella/incubator-metron geohash
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/724.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 #724
----
commit 26e1c6293bc6c1f544056ddbd31cfa3496be538d
Author: cstella <ce...@gmail.com>
Date: 2017-08-30T15:27:57Z
Initial commit.
commit a1a6cab3ef041be9da8be5e822fbf6edaac15076
Author: cstella <ce...@gmail.com>
Date: 2017-08-30T18:09:57Z
Better tests and a new function.
commit a15a0b806b8aef695a9b7e1df1f80076ba7dbda3
Author: cstella <ce...@gmail.com>
Date: 2017-08-30T18:32:57Z
Updating readme docs.
----
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on the issue:
https://github.com/apache/metron/pull/724
I spun this up in full dev and it worked as advertised. I was able to easily get the "geo_hash_parser" and "geo_hash_enrichment" fields correctly populated in ES. I also tested all the new GEOHASH functions in the Stellar REPL and they all worked correctly.
Also read through the documentation in the README. The descriptions for the functions were clear and references were provided for further reading. Awesome +1
---
[GitHub] metron issue #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/metron/pull/724
This is a great submission, thanks for contributing!
Would you be able to show to how this works with the profiler and some of the SET stuff you added? An example like the MAD outlier work would be great.
---
[GitHub] metron issue #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/724
@justinleet that's fair. I'll make an example and put it in the docs
---
[GitHub] metron pull request #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/724
---
[GitHub] metron issue #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/metron/pull/724
@cestella That absolutely makes sense. Thanks a lot for adding it.
+1
---
[GitHub] metron issue #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/724
Ok, I tested this via a custom enrichment and custom parser field transformation and ensured that no adverse classpath issues happened. I'm ready to call this ready for review.
Manual testing should follow the squid example:
* Add a new parser field transformation:
```
{
"parserClassName": "org.apache.metron.parsers.GrokParser",
"sensorTopic": "squid",
"parserConfig": {
"grokPath": "/patterns/squid",
"patternLabel": "SQUID_DELIMITED",
"timestampField": "timestamp"
},
"fieldTransformations" : [
{
"transformation" : "STELLAR"
,"output" : [ "full_hostname", "domain_without_subdomains", "geo_hash_parser"]
,"config" : {
"full_hostname" : "URL_TO_HOST(url)"
,"domain_without_subdomains" : "DOMAIN_REMOVE_SUBDOMAINS(full_hostname)"
,"geo_hash_parser" : "GEOHASH_FROM_LOC(GEO_GET(ip_dst_addr))"
}
}
]
}
```
* Add a new enrichment config:
```
{
"enrichment" : {
"fieldMap": {
"stellar": {
"config" : [
"geo_hash_enrichment := GEOHASH_FROM_LOC(GEO_GET(ip_dst_addr))"
]
}
}
},
"threatIntel": { }
}
```
* Send squid data through and ensure that `geo_hash_enrichment` and `geo_hash_parser` yield a hash
* Test the various new stellar commands in the REPL (e.g. `GEOHASH_FROM_LOC(GEO_GET('172.168.2.3'))`
---
[GitHub] metron issue #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/724
@justinleet Ok, I added an walk-through of using geohashes and the profiler to find geographic anomalies in authentication records (admittedly synthetic). Let me know if this makes some sense and motivates things appropriately.
---
[GitHub] metron issue #724: METRON-1142: Add Geo Hashing functions to stellar
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/724
Please note: I have not spun this up in fulldev and used the functions in an enrichment or field transformation yet, so until I do, please refrain from committing (even if it gets a +1). I'll be doing that evaluation on tuesday.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---