[
https://issues.apache.org/jira/browse/METRON-777?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15968238#comment-15968238
]
ASF GitHub Bot commented on METRON-777:
---------------------------------------
GitHub user ottobackwards opened a pull request:
https://github.com/apache/incubator-metron/pull/530
METRON-777 Metron Extension System and Parser Extensions
## Contributor Comments
[Please place any comments here. A description of the problem/enhancement,
how to reproduce the issue, your testing methodology, etc.]
The pr. introduces an extension system for metron, along with refactoring
the metron parsers on top of it. This is the base work for METRON-258 -
Sideloading parsers, which is to follow, as it enables the creation and
management of extensions outside of the metron codebase. The work for enabling
side loading is the ability to install and deploy 3rd party extensions/parsers.
There is a lot that can be done with this, but I could nibble at it
forever, and I'd like to get feedback and improvements going. There is still
more documentation work that can be done for example.
The areas of change:
### Metron Maven Bundle Plugin
- adaptation of the nifi plugin
- more configurable wrt file extension/dependency and metadata naming
- new pre-build step on clean systems to install plugin
### bundle-lib
My goal here was not to make any radical changes
- adaptation of nifi-nar-utils to be used outside of the nifi project
- rudimentary extensibility to allow configuration and injection of
service types and other things that were hard coded to nifi
- refactored from File based to VFS based
- introduced class cluster for FileUtils to allow for specialized HDFS
file functionality ( HDFS with VFS is read only )
- rebranding to Bundle from Nar ( although the lib and the plugin allow
that to be configured now )
- added capability to the properties class to write to stream, adapted to
uri from paths
- added integration tests for hdfs
### Metron Maven Parser Extension Archetype
- locally installable archetype for creating Metron Parsers
- <provided> dependencies instead of shading
- builds Bundle
- creates an assembly with bundle and configuration
- configuration for parsers now includes all parser related configurations
( except ES and Logrotate )
- Includes sample data for testing, global config etc. ( such that you
don't need metron code to build and test ).
- Can be used with configuration only parsers, so that you can still unit
and integration test them, common deployment
- Creates documentation readme.
### Metron-Extensions / Metron-Parser-Extensions/**
- Module area for extensions, first extension type is parsers
- All parsers re-based on archetype generated projects
- All parser test data/ configuration located with parser ( see above )
- Each parser had a readme that should be filled out, but I didn't do that
### Metron-Parsers
- Removed all parsers and their tests etc except CSV, JSON, GROK
- Still shaded, still the storm loaded jar
- extended or fix tests so that they work when derived outside of code tree
- Parser bolt no longer takes MessageParser<> instance, loads it as from
extension/bundle system
### Metron-configuration
- changes to support new parser locations
- added functionality to load and store bundle.properties to zk
### Metron Tests
- Extended to work with relative path / formatted paths
### RPM-Build
- Copy all the parser extensions
- Include in the spec
/usr/metron/V/ now has a new directories for extensions:
/extension_etc/PARSER_NAME/ -> that parser's configuration
/extension_alt_etc/ -> location for 3rd Party extension configuration
/extension_lib -> location on disk for rpm to place bundles
/extension_alt_lib -> location on disk for staging 3rd party bundles
### METRON-SERVICE ambari
- Load zk configurations for parsers from their location
- filles out the properties template and deploys to hdfs
- create HDFS directories
- deploy/copy bundles to HDFS
### the metron workflow that this enables
We need a new parser:
*create with archetype under metron-extensions/metron-parser-extensions
*implement including tests and test data, all configurations
*add to the copy-resources of RPM-Docker pom
*add to the spec file
*add to the all_parsers variable in params
- this will get it installed but not started, no ES no log rotate
* add to parsers variable in the env.xml to get it to start as well ( still
no ES or Log rotate )
* other steps to get the ES template integrated with indexing scripts and
log rotate with ansible
I have been working in Full Dev to get this going, and I believe it is
working enough to get this started.
At the end of vagrant up with full dev, you should have data in kibana, as
if nothing had changed ;)
There are issues however:
I have not integrated this with the Metron Docker project, I'm not sure how
yet.
I have fixed Metron-Interface to get the test to run, but I think that work
needs to be done there.
The next steps here are follow ons for installing parsers from the ui.
Testing: Build and Tests run, Vagrants work, what is broken with Docker,
AWS if you can do it.
Build a parser see that it builds and the tests run from the archetype
Basic smoke test of system?
I am sure I missed many things, or that there are things that could be
better. Thank you in advance for your review.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron (Incubating).
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 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?
- [ ] 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
bin/generate-md.sh
mvn site: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 recommened 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/incubator-metron METRON-777
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/530.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 #530
----
commit 864d320d91c522dfc2eb63fc12341f316a3f8952
Author: Otto Fowler <[email protected]>
Date: 2017-03-17T04:56:49Z
Metron Extension system
Based on Apache Nifi Nars
NAR changes
* new lib , rebrand to bundles from NAR
* port to VFS/FileObject from File based
* ability to set property values
* Rework FileUtils so that you can derive and override
* added initializers to set 'classes' that we care about instead of hard
coding them, still needs defaults
* added components nec. for integration tests ( do not want dep. on
metron-* )
* VFSClassloader for NarClassLoader
* Hdfs based integration test version of unpacknars tests
* HDFS ( filesystem ) based fileutilities to cover for writes to hdfs,
since VFS is currently R/O HDFS
* modified plugin to support configuration of outputs
* use class index not service loader ( both subclass and annotated
supported )
Archetype
* Parser Extension archetyp
* incudes all configuration
* creates tar.gz with bundle and configuration
* class index support ( automatic generation )
Extensions
* new extensions modules
* parser
* archetype built module for each parser type
* support for configuration only parsers with tests
Parsers
* moved all but json, csv, grok to extensions
* Bolt now loads from bundle properties
Deployment
* rpms for parsers
* create extension directories
* ambari initializes zookeeper per parser
* amabri creates hdfs directories
* ISSUE: Writing to hdfs
Rest-API
* only test against parsers in metron-parsers
* still needs integration
----
> Create a plugin system for Metron based on 'NAR'
> ------------------------------------------------
>
> Key: METRON-777
> URL: https://issues.apache.org/jira/browse/METRON-777
> Project: Metron
> Issue Type: New Feature
> Reporter: Otto Fowler
> Assignee: Otto Fowler
>
> The success of the Metron project will be greatly dependent on community
> participation, and with that the ability to adapt and extend Metron without
> having to maintain a fork of the project.
> As organizations and individuals look to extend the Metron system with custom
> parsers, enrichments, and stellar functions that may be proprietary in
> nature, the ability to develop and deploy these extensions outside the Metron
> code base is critically important.
> To that end, and after community discussion and proposal we create or
> formalize the 'plugin' development story in Metron.
> The proposal is to adapt the Apache Nifi NAR system for use in Metron. This
> will provide the system with:
> * archetype(s) for developer projects and independent development
> * defined packaging and metadata for 'plugin' products
> * loading and instantiation with classloader isolation capabilities
> * removing the necessity for shading plugin jars
> These capabilities will also enable other features, such as plugin lifecycle,
> plugin configuration+redeployment, and other things.
> The plugin archetypes and their installation will be a followon
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
