merrimanr opened a new pull request #1351: METRON-2026: Remove Storm dependency from metron-common URL: https://github.com/apache/metron/pull/1351 ## Contributor Comments This PR includes the necessary changes to move Storm-dependent code to a separate module. In most cases classes were moved unchanged with the exception of the package changing from `org.apache.metron.common.utils.*` to `org.apache.metron.storm.common.utils.*`. More complex changes are listed in the next section. ### Changes Included - Removal of Storm and Flux Maven dependencies from the metron-common pom file. - Additional of the `org.ow2.asm:asm:5.0.3` Maven dependency to metron-common pom file. This dependency was inherited from the Storm dependencies. - Created a new metron-storm-common module for classes migrated out of metron-common. - Refactored the `RawMessageUtil` and `MetadataUtil` classes to separate Storm dependent code. The `MetadataUtil.extractMetadata` method's purpose is to extract metadata from a tuple and should be in metron-storm-common while the other methods in `MetadataUtil` I believe are reusable and should be kept in metron-common. For now I moved `RawMessageUtil` to metron-storm-common and moved the method to `RawMessageUtil.extractMetadata`. - Removed the `TopologyContext` parameter from `BulkMessageWriter.init` and adjusted implementations to match. - All `BulkMessageWriter` implementations did not use `TopologyContext` except for `HdfsWriter`. This class is tightly coupled to Storm dependencies and will likely need to be rewritten without them for other streaming platforms. In this PR, it's treated as a special case in `BulkMessageWriterBolt` with the `TopologyContext` call in a separate `HdfsWriter` method. - Storm-dependent classes and tests were moved from metron-common to metron-storm-common including: - Classes in the `org.apache.metron.common.bolt` package - `MessageGetStrategy` interface and implementations - `RawMessageUtil` including the `extractMetadata` method ### Testing I have done some basic testing in full dev. I've spun it up and made some basic assertions: - Data is flowing to ES and HDFS - No topologies are reporting errors - All components are showing green in Ambari - REST is functioning - UIs are working What else should we test? Should we add a case around parser metadata? ### Outstanding Issues - I think we could improve on the `MetadataUtil` refactor. Should we rename `RawMessageUtil` to something more appropriate? Should we reorganize that code differently? - Is the `HdfsWriter` approach good enough? How else could we do this? - Is `metron-platform/metron-storm-common` the right module for common Storm code? ## 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.
---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
