GitHub user mmiklavc opened a pull request:
https://github.com/apache/metron/pull/665
METRON-1060: Add performance timing logging to enrichment topology
https://issues.apache.org/jira/browse/METRON-1060
Adds performance logging timers to the enrichment topology. I've made this
configurable so that the timers are separate from our standard logging. Any
opinions on documenting this, ie should it be added to the enrichment docs? I
also noticed some performance logging added to the StellarAdapter class, but we
haven't added documentation for the "feature."
### Testing
Run full dev
```
cd metron/metron-deployment/vagrant/full-dev-platform
vagrant up
```
**Set the log levels**
Go to the storm UI - http://node1:8744 and select the enrichment topology.
Scroll down to "Change Log Level" and enter the following loggers, level=DEBUG,
timeout=5000 sec:
> org.apache.metron.enrichment.bolt.GenericEnrichmentBolt$Perf
> org.apache.metron.enrichment.bolt.SplitBolt$Perf
> org.apache.metron.enrichment.bolt.JoinBolt$Perf
In the enrichment worker log you should see lines similar to the following
indicating that performance logging has been enabled:
> 2017-07-21 20:53:42.673 o.a.s.d.worker [INFO] Adding config for:
org.apache.metron.enrichment.bolt.SplitBolt$Perf with level: DEBUG
> 2017-07-21 20:54:14.747 o.a.s.d.worker [INFO] Adding config for:
org.apache.metron.enrichment.bolt.JoinBolt$Perf with level: DEBUG
> 2017-07-21 20:54:39.914 o.a.s.d.worker [INFO] Adding config for:
org.apache.metron.enrichment.bolt.GenericEnrichmentBolt$Perf with level: DEBUG
**Check the log output**
> You should see log entries similar to the following:
> 2017-07-24 21:13:05.171 o.a.m.e.b.GenericEnrichmentBolt$Perf [DEBUG]
key=4fe7c88a-79bd-4889-ac79-ad7a0d494291, enrich type=host, enrich time (ms): 0
> 2017-07-24 21:13:05.171 o.a.m.e.b.GenericEnrichmentBolt$Perf [DEBUG]
key=4fe7c88a-79bd-4889-ac79-ad7a0d494291, enrich type=geo, enrich time (ms): 0
> 2017-07-24 21:13:05.171 o.a.m.e.b.GenericEnrichmentBolt$Perf [DEBUG]
key=4fe7c88a-79bd-4889-ac79-ad7a0d494291, enrich type=host, enrich time (ms): 0
> 2017-07-24 21:13:05.171 o.a.m.e.b.GenericEnrichmentBolt$Perf [DEBUG]
key=4fe7c88a-79bd-4889-ac79-ad7a0d494291, enrich type=geo, enrich time (ms): 0
> 2017-07-24 21:13:05.171 o.a.m.e.b.GenericEnrichmentBolt$Perf [DEBUG]
key=4fe7c88a-79bd-4889-ac79-ad7a0d494291, execute() time (ms): 0
> 2017-07-24 21:13:05.171 o.a.m.e.b.GenericEnrichmentBolt$Perf [DEBUG]
key=4fe7c88a-79bd-4889-ac79-ad7a0d494291, execute() time (ms): 0
That should do it!
## 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 && build_utils/verify_licenses.sh
```
- [x] Have you verified the basic functionality of the build by building
and running locally with Vagrant full-dev environment or the equivalent?
#### 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/mmiklavc/metron enrichment-perf-logging
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/665.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 #665
----
commit 440a0576da9c59118387ea81b5861e03367e5a2a
Author: Michael Miklavcic <[email protected]>
Date: 2017-07-24T21:17:52Z
METRON-1060: Add performance timing logging to enrichment topology
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
