You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by mmiklavc <gi...@git.apache.org> on 2017/05/31 17:50:43 UTC
[GitHub] metron pull request #599: METRON-975: Normalize logging and switch to common...
GitHub user mmiklavc opened a pull request:
https://github.com/apache/metron/pull/599
METRON-975: Normalize logging and switch to common idiom with SLF4J
https://issues.apache.org/jira/browse/METRON-975
We currently have a mixture of logging approaches scattered throughout the codebase. Log4j, slf4j, and commons logging. In addition, there are some deprecated idioms being used to declare loggers (post-jdk 7) and format strings within the logging statements.
This PR handles converting and normalizing Metron's logging over to slf4j in all major metron-platform areas except for tests. It also converts logging in metron-analytics, with the exception of MaaS which is currently leveraging commons logging.
I've made a few types of changes (change varietals?).
1. Normalized logger factory calls to the following `LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());` , per https://www.slf4j.org/faq.html#declaration_pattern
2. Removed `LOG.isDebugEnabled()` in instances where the SLF4J parameterized messages is a better option, e.g. `logger.debug("The entry is {}.", entry);`. I have *not* changed this implementation in instances where more costly operations are being done, like string concatenation derived from parsing or serializing json into string form, per https://www.slf4j.org/faq.html#logging_performance
3. Replaced string concatenation with parameterized nessages. I did this even when a formatted string precedes an exception/throwable. The javadoc wasn't immediately clear about this, but as of SLF4J 1.6 a final exception argument will be treated as an exception rather than as an object for use during parameterization - https://www.slf4j.org/faq.html#paramException
Testing instructions to follow. For starters, I've compared the number of lines in the Travis build output before and after this change and see no notable difference in total number of lines.
## 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:
- [ ] 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 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?
- [ ] 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 logging-fix
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/599.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 #599
----
commit 13e7087ed6de4e1ecf28ab1fb3c09b432a082dca
Author: Michael Miklavcic <mi...@gmail.com>
Date: 2017-05-30T21:45:44Z
Normalize logging and switch to common idiom with SLF4J
----
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on the issue:
https://github.com/apache/metron/pull/599
Is it worth us getting this in sooner rather than later, before we get too many other bits of logging that will need to be backported?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on the issue:
https://github.com/apache/metron/pull/599
I would love to get this in
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on the issue:
https://github.com/apache/metron/pull/599
@mmiklavc looks like there are some merge conflicts. If you don't mind resolving those I will get this reviewed.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #599: METRON-975: Normalize logging and switch to common...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc closed the pull request at:
https://github.com/apache/metron/pull/599
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by simonellistonball <gi...@git.apache.org>.
Github user simonellistonball commented on the issue:
https://github.com/apache/metron/pull/599
+1 (non-binding) the sooner we get this in the better. It has performance benefits, and the longer we wait the more work and trouble it will create. No reason not to get it done, lots to get it in.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by nickwallen <gi...@git.apache.org>.
Github user nickwallen commented on the issue:
https://github.com/apache/metron/pull/599
I saw this same test failure yesterday on another PR. I opened a [METRON-1048](https://issues.apache.org/jira/browse/METRON-1048) for it.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on the issue:
https://github.com/apache/metron/pull/599
Kick Travis - rest api test failure
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on the issue:
https://github.com/apache/metron/pull/599
Any comments on this? I've been merging/resolving conflicts with master as they come in.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/599
+1 by inspection
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #599: METRON-975: Normalize logging and switch to common...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/599
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/metron/pull/599
I'm damned confused about these test errors. This PR didn't seem to touch anything near the test and I haven't seen that test (which is a mock test) fail intermittently before. I'd love a debrief after you figure out the unit test failure cause, @mmiklavc . If it's test weirdness or something intermittent, let's make sure we capture a JIRA about it.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron pull request #599: METRON-975: Normalize logging and switch to common...
Posted by mmiklavc <gi...@git.apache.org>.
GitHub user mmiklavc reopened a pull request:
https://github.com/apache/metron/pull/599
METRON-975: Normalize logging and switch to common idiom with SLF4J
https://issues.apache.org/jira/browse/METRON-975
We currently have a mixture of logging approaches scattered throughout the codebase. Log4j, slf4j, and commons logging. In addition, there are some deprecated idioms being used to declare loggers (post-jdk 7) and format strings within the logging statements.
This PR handles converting and normalizing Metron's logging over to slf4j in all major metron-platform areas except for tests. It also converts logging in metron-analytics, with the exception of MaaS which is currently leveraging commons logging.
I've made a few types of changes (change varietals?).
1. Normalized logger factory calls to the following `LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());` , per https://www.slf4j.org/faq.html#declaration_pattern
2. Removed `LOG.isDebugEnabled()` in instances where the SLF4J parameterized messages is a better option, e.g. `logger.debug("The entry is {}.", entry);`. I have *not* changed this implementation in instances where more costly operations are being done, like string concatenation derived from parsing or serializing json into string form, per https://www.slf4j.org/faq.html#logging_performance
3. Replaced string concatenation with parameterized nessages. I did this even when a formatted string precedes an exception/throwable. The javadoc wasn't immediately clear about this, but as of SLF4J 1.6 a final exception argument will be treated as an exception rather than as an object for use during parameterization - https://www.slf4j.org/faq.html#paramException
Testing instructions to follow. For starters, I've compared the number of lines in the Travis build output before and after this change and see no notable difference in total number of lines.
## 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:
- [ ] 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 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?
- [ ] 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 logging-fix
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/599.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 #599
----
commit 13e7087ed6de4e1ecf28ab1fb3c09b432a082dca
Author: Michael Miklavcic <mi...@gmail.com>
Date: 2017-05-30T21:45:44Z
Normalize logging and switch to common idiom with SLF4J
----
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/metron/pull/599
I will give you real imaginary money to rebase this onto METRON-777 so I don't have to port ;)
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] metron issue #599: METRON-975: Normalize logging and switch to common idiom ...
Posted by mmiklavc <gi...@git.apache.org>.
Github user mmiklavc commented on the issue:
https://github.com/apache/metron/pull/599
@merrimanr Conflicts resolved
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---