[jira] [Commented] (METRON-1496) ChainLink Parser to reuse parser code at parserConfig level

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/METRON-1496?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16406558#comment-16406558 ] 

ASF GitHub Bot commented on METRON-1496:
----------------------------------------

GitHub user kevin91nl opened a pull request:

    https://github.com/apache/metron/pull/969

    METRON-1496: ChainLink Parser to reuse parser code at parserConfig level

    ## Contributor Comments
    [Please place any comments here.  A description of the problem/enhancement, how to reproduce the issue, your testing methodology, etc.]
    
    
    ## 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:
    - [ ] 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).
    - [ ] 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.
    - [ ] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    
    ### For code changes:
    - [ ] 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?
    - [ ] 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 && dev-utilities/build-utils/verify_licenses.sh 
      ```
    
    - [ ] Have you written or updated unit tests and or integration tests to verify your changes?
    - [ ] 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:
    - [ ] 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/kevin91nl/metron master

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

    https://github.com/apache/metron/pull/969.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 #969
    
----

----


> ChainLink Parser to reuse parser code at parserConfig level
> -----------------------------------------------------------
>
>                 Key: METRON-1496
>                 URL: https://issues.apache.org/jira/browse/METRON-1496
>             Project: Metron
>          Issue Type: Improvement
>            Reporter: Bas van de Lustgraaf
>            Priority: Minor
>
> During the development of some custom parsers we wrote a couple of classes / functions to make it possible to reuse code and assemble parser quicker at java coding level.
> We took this idea one step further and created the so called ChainLinkParser.
> This parser gives user without any java knowledge the opportunity to assemble parsers at parser configuration level.
> We would like to discuss the code and see if it can be submitted to the project. We will create a PR during this week to submit the code for review and discussion.
> Below you'll find an example of our Parser configuration for Suricata, which is using our ChainParser. 
>  
> {noformat}
> {
>    "parserClassName":"nl.qsight.chainparser.ChainParser",
>    "sensorTopic":"suricata",
>    "readMetadata":true,
>    "mergeMetadata":true,
>    "numWorkers":3,
>    "numAckers":3,
>    "spoutParallelism":6,
>    "spoutNumTasks":6,
>    "parserParallelism":20,
>    "parserNumTasks":20,
>    "errorWriterParallelism":1,
>    "errorWriterNumTasks":1,
>    "spoutConfig":{
>       "spout.firstPollOffsetStrategy":"LATEST"
>    },
>    "stormConfig":{
>       "topology.max.spout.pending":2000
>    },
>    "parserConfig":{
>       "chain":[
>          "parse_json",
>          "parse_username",
>          "rename_fields",
>          "parse_datetime"
>       ],
>       "parsers":{
>          "parse_json":{
>             "class":"nl.qsight.links.io.JSONDecoderLink"
>          },
>          "parse_username":{
>             "class":"nl.qsight.links.io.RegexLink",
>             "pattern":"(?i)(user|username|log)[=:](\\w+)",
>             "selector":{
>                "username":"2"
>             },
>             "input":"{{payload_printable}}"
>          },
>          "rename_fields":{
>             "class":"nl.qsight.links.fields.RenameLink",
>             "rename":{
>                "proto":"protocol",
>                "dest_ip":"ip_dst_addr",
>                "src_ip":"ip_src_addr",
>                "dest_port":"ip_dst_port",
>                "src_port":"ip_src_port"
>             }
>          },
>          "parse_datetime":{
>             "class":"nl.qsight.links.io.TimestampLink",
>             "patterns":[
>                [
>                   "([0-9]{4})-([0-9]+)-([0-9]+)T([0-9]+):([0-9]+):([0-9]+).([0-9]+)([+-]{1}[0-9]{1,2}[:]?[0-9]{2})",
>                   "yyyy MM dd HH mm ss SSSSSS Z",
>                   "newest"
>                ]
>             ],
>             "input":"{{timestamp}}"
>          }
>       }
>    }
> }
> {noformat}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)