You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/06/06 23:51:18 UTC
[jira] [Commented] (METRON-987) Allow stellar enrichments to be
specified by a list as well as a map
[ https://issues.apache.org/jira/browse/METRON-987?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16039887#comment-16039887 ]
ASF GitHub Bot commented on METRON-987:
---------------------------------------
GitHub user cestella opened a pull request:
https://github.com/apache/metron/pull/609
METRON-987: Allow stellar enrichments to be specified by a list as well as a map
## Contributor Comments
Currently, stellar enrichments are specified by a map associating fields with the stellar expressions associated with the fields. There is a significant downside here in that you cannot update previously assigned fields. For instance, the following cannot be represented currently:
```
"fieldMap": {
...
"stellar" : {
"config" : {
"hostname" : "if ENDS_WITH(hostname, '.') then CHOP(hostname) else hostname",
"hostname" : "TO_LOWER(hostname)"
}
}
}
```
This would now be allowed thusly:
```
"fieldMap": {
...
"stellar" : {
"config" : [
"hostname := if ENDS_WITH(hostname, '.') then CHOP(hostname) else hostname",
"hostname := TO_LOWER(hostname)"
]
}
}
```
A consequent of this deficiency is that we also cannot use temporary variables and unset them after their use inside an enrichment group.
The proposed change is to allow users to use lists of strings representing stellar expression assignments with the same syntax as the Stellar REPL. This would be as an alternative to maps, but the map syntax would also be supported for legacy.
Test plan to follow in comments.
## 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 incubating-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/cestella/incubator-metron stellar_list_support
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/609.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 #609
----
commit e9ea04bc6e9f42e1029d1d7fa6e98fa00e0226fe
Author: cstella <ce...@gmail.com>
Date: 2017-06-06T22:21:49Z
Adding the ability to specify Stellar enrichments as lists as well as Maps.
commit cba07c78d91451eb1ec318418c418269e7127e38
Author: cstella <ce...@gmail.com>
Date: 2017-06-06T23:17:11Z
Documentation update
----
> Allow stellar enrichments to be specified by a list as well as a map
> --------------------------------------------------------------------
>
> Key: METRON-987
> URL: https://issues.apache.org/jira/browse/METRON-987
> Project: Metron
> Issue Type: Improvement
> Reporter: Casey Stella
> Assignee: Casey Stella
>
> Currently, stellar enrichments are specified by a map associating fields with the stellar expressions associated with the fields. There is a significant downside here in that you cannot update previously assigned fields. For instance, the following cannot be represented currently:
> {code}
> "fieldMap": {
> ...
> "stellar" : {
> "config" : {
> "hostname" : "if ENDS_WITH(hostname, '.') then CHOP(hostname) else hostname",
> "hostname" : "TO_LOWER(hostname)"
> }
> }
> }
> {code}
> A consequent of this deficiency is that we also cannot use temporary variables and unset them after their use inside an enrichment group.
> The proposed change is to allow users to use lists of strings representing stellar expression assignments with the same syntax as the Stellar REPL. This would be as an alternative to maps, but the map syntax would also be supported for legacy.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)