Add support for logging markers as tags #14
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Logback (SLF4J) and Log4j 2 support Markers, which can contain useful information. This change adds support for optionally logging these markers as tags in the created/encoded log messages. By default, this feature is disabled and can be enabled by setting the `includeMarkers` configuration setting to `true` in the Log4j 2 `EcsLayout` and Logback `EcsEncoder`. See also: * https://logging.apache.org/log4j/2.0/manual/markers.html * https://www.slf4j.org/api/org/slf4j/Marker.html
|
Great, thanks a lot for the contribution! I think there is also some overlap with #12 |
I think Furthermore, if we take the example from the Log4j 2 documentation about markers, one could search for all SQL queries ("SQL") or only UPDATE statements ("SQL_UPDATE") in the log messages. When using private static final Marker SQL_MARKER = MarkerManager.getMarker("SQL");
private static final Marker UPDATE_MARKER = MarkerManager.getMarker("SQL_UPDATE").setParents(SQL_MARKER);
private static final Marker QUERY_MARKER = MarkerManager.getMarker("SQL_QUERY").setParents(SQL_MARKER);
Regarding the integration tests, yes. |
|
+1 on using tags. I guess it then would look like: |
|
@ruflin Yes, correct. In case of Log4j 2 it would be |
felixbarny
reviewed
Sep 9, 2019
log4j2-ecs-layout/src/main/java/co/elastic/logging/log4j2/EcsLayout.java
Outdated
Show resolved
Hide resolved
log4j2-ecs-layout/src/main/java/co/elastic/logging/log4j2/EcsLayout.java
Outdated
Show resolved
Hide resolved
log4j2-ecs-layout/src/test/java/co/elastic/logging/log4j2/Log4j2EcsLayoutIntegrationTest.java
Outdated
Show resolved
Hide resolved
|
@pgomulka Would mapping markers to |
|
@felixbarny Anything to be worried about for me because of the failed tests? |
|
Jenkins run the tests please |
|
@joschi There seem to be some failing tests: https://apm-ci.elastic.co/blue/organizations/jenkins/apm-agent-java%2Fjava-ecs-logging-mbp/detail/PR-14/7/pipeline/ |
I think this should be fine, I was aiming to refactor this way. But ES is not using markers the way they should be - we just treat this basically as a label. |
felixbarny
approved these changes
Sep 11, 2019
|
@felixbarny Unfortunately I'm unable to see the Jenkins build output at https://apm-ci.elastic.co/blue/organizations/jenkins/apm-agent-java%2Fjava-ecs-logging-mbp/detail/PR-14/7/pipeline/ |
|
This is the stack trace: I don't know where this is coming from. Could you allow edits from maintainers? If you add |
|
After some playing around with the URL, I've found https://apm-ci.elastic.co/job/apm-agent-java/job/java-ecs-logging-mbp/view/change-requests/job/PR-14/7. @felixbarny I think the issue was that both Log4j 2 tests, when run in parallel, modified the same singleton LoggerContext which made at least one of them fail.
That's already enabled. At least the box is checked. |
|
Heh, I didn’t know they were running in parallel 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Logback (SLF4J) and Log4j 2 support Markers, which can contain useful information.
This change adds support for optionally logging these markers as tags in the created/encoded log messages.
By default, this feature is disabled and can be enabled by setting the
includeMarkersconfiguration setting totruein the Log4j 2EcsLayoutand LogbackEcsEncoder.See also: