[jira] [Commented] (METRON-1539) Specialized RENAME field transformer

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

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

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

GitHub user cestella opened a pull request:

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

    METRON-1539: Specialized RENAME field transformer

    ## Contributor Comments
    Currently our advice is to use the Stellar field transformation to do simple field renaming.  Given how common this situation is and how the old field must be nulled out, thus making the stellar transformation awkward, it's worthwhile having a specialized field transformer for RENAME.
    
    * Create a new parser by editing `$METRON_HOME/config/zookeeper/parsers/dummy.json` to have the following content:
    ```
    {
      "parserClassName":"org.apache.metron.parsers.json.JSONMapParser",
      "sensorTopic":"dummy",
      "fieldTransformations" : [
             { "transformation" : "STELLAR"
             ,"output" : [ "new_field"]
             ,"config" : {
               "new_field" : "JOIN( [ TO_UPPER(source.type), field ], ',' )"
                         }
             },
             { "transformation" : "RENAME"
             , "config" : {
                 "new_field" : "newer_field"
               }
             }
      ]
    }
    ```
    * Create the dummy kafka topic via `/usr/hdp/current/kafka-broker/bin/kafka-topics.sh --zookeeper node1:2181 --create --topic dummy --partitions 1 --replication-factor 1`
    * Push the zookeeper configs via `$METRON_HOME/bin/zk_load_configs.sh --mode PUSH -i $METRON_HOME/config/zookeeper -z node1:2181`
    * Start the parser via `$METRON_HOME/bin/start_parser_topology.sh -k node1:6667 -z node1:2181 -s dummy`
    * Create some dummy data by creating a file at `~/dummy.dat` with the following:
    ```
    { "field" : "f1", "source.type" : "dummy" }
    { "field" : "f2", "source.type" : "dummy" }
    { "field" : "f3", "source.type" : "dummy" }
    { "field" : "f4", "source.type" : "dummy" }
    { "field" : "f5", "source.type" : "dummy" }
    { "field" : "f6", "source.type" : "dummy" }
    { "field" : "f7", "source.type" : "dummy" }
    ```
    * Send the dummy data in via `cat ~/dummy.dat | /usr/hdp/current/kafka-broker/bin/kafka-console-producer.sh --broker-list node1:6667 --topic dummy`
    * Ensure the data written to the indices has a field `newer_field` that looks like `DUMMY,${field}` and no `new_field`
    
    
    ## 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 && dev-utilities/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 rename_transformer

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

    https://github.com/apache/metron/pull/1002.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 #1002
    
----
commit 7c19d63b9947595cab4d761d3f79d19ee07c0d17
Author: cstella <ce...@...>
Date:   2018-04-24T15:55:40Z

    first cut.

commit aa72f5531c54762c6a4d0289bb1539ae67bb842f
Author: cstella <ce...@...>
Date:   2018-04-24T17:50:24Z

    Documentation

----


> Specialized RENAME field transformer
> ------------------------------------
>
>                 Key: METRON-1539
>                 URL: https://issues.apache.org/jira/browse/METRON-1539
>             Project: Metron
>          Issue Type: New Feature
>            Reporter: Casey Stella
>            Priority: Major
>
> Currently our advice is to use the Stellar field transformation to do simple field renaming.  Given how common this situation is and how the old field must be nulled out, thus making the stellar transformation awkward, it's worthwhile having a specialized field transformer for RENAME.



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