[jira] [Commented] (METRON-1606) Add a 'wrap' to incoming messages in the metron json parser

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

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

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

GitHub user ottobackwards opened a pull request:

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

    METRON-1606 Add capability to wrap json message as entity arrays

    This PR adds the ability to configure the JSONMap parser to wrap messages when using JSON Path queries in an entity with an array.
    
    For example, if the json 'document' is 
    
    `{"foo": "one"}, {"bar","two"}`
    you need to have it wrapped to work with it with jsonpath.
    
    This PR allows this, resulting in
    
    `{"configured name or default of message" : [ {{"foo": "one"}, {"bar","two"}]}`
    
    Tests where added, along with sample data for integration, and a new sample configuration.
    
    
    
    ### 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:
    - [ ] 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 metron folder via:
      ```
      mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh 
      ```
    
    - [x] 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)?
    - [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:
    - [ ] 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/ottobackwards/metron json-wrap

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

    https://github.com/apache/metron/pull/1054.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 #1054
    
----
commit e991d8d43865149f957d530624a69539de5d7bb2
Author: Otto Fowler <ot...@...>
Date:   2018-06-07T14:52:07Z

    METRON-1606 Add capability to wrap json message as entity arrays

----


> Add a 'wrap' to incoming messages in the metron json parser
> -----------------------------------------------------------
>
>                 Key: METRON-1606
>                 URL: https://issues.apache.org/jira/browse/METRON-1606
>             Project: Metron
>          Issue Type: Improvement
>            Reporter: Laurens Vets
>            Assignee: Otto Fowler
>            Priority: Minor
>
> For many use cases, the user may not have control over the format of the json that is coming in.  Some services send 'documents' with many atomic json entries, that are not in a coherent array, and cannot be referenced or parsed.
>  
> It would be useful to simply have the option for the JSONMap parser to be configured to 'wrap' the incoming document in an array and holding entity.  This would allow it to be parsed and addressed by JSONPath.
>  
> {data},
> {data},
> {data},
>  
> wraps to:
>  
> { "wrapName" : [
> {data},
> {data},
> {data}
> ]
> }
>  
> that can be then referenced by a jsonPath statement : $.wrapperName[*]  or something more complex
>  
> So you would configure the parser
> {code:java}
> wrapIncomming : 'true' # This wraps the incomming bytes in a json construct, { NAME : [ CONTENT ] }{code}
> {code:java}
> .wrapContructName : 'messages' # default name for the wrapping construct, this name should be referenced in your jsonpath statement{code}
>  
> The assumption here is that the entities, while not wrapped or in an array, are still comma separated.
>  



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