feat: support customization for MDC serializer #293
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
|
💚 CLA has been signed |
github-actions
bot
added
agent-java
community
JonasKunz
requested changes
Dec 12, 2024
There was a problem hiding this comment.
Thanks for your contribution @aliaksandr-lavishak-tde ! I think this feature request is reasonable, I just have some objections on how we structure the extension mechanism.
log4j2-ecs-layout/src/main/java/co/elastic/logging/log4j2/MdcSerializer.java
Show resolved
Hide resolved
JonasKunz
requested changes
Dec 12, 2024
log4j2-ecs-layout/src/main/java/co/elastic/logging/log4j2/MdcSerializer.java
Outdated
Show resolved
Hide resolved
aliaksandr-lavishak-tde
force-pushed
the
custom-mdc-serializer
branch
2 times, most recently
from
851e620 to
7ee13d8
Compare
aliaksandr-lavishak-tde
force-pushed
the
custom-mdc-serializer
branch
from
7ee13d8 to
3ebc7d5
Compare
JonasKunz
requested changes
Dec 18, 2024
| return (MdcSerializer) clazz.getDeclaredConstructor().newInstance(); | ||
| } catch (ClassNotFoundException | InstantiationException | IllegalAccessException | ||
| | NoSuchMethodException | InvocationTargetException e) { | ||
| return resolveDefault(); |
There was a problem hiding this comment.
This would silently hide the misconfiguration, leaving users scratching their head why thinks don't work.
I think it is better to throw an exception which will usually abort the application start to show the problem to the user:
Suggested change
| return resolveDefault(); | |
| throw new IllegalArgumentException("Could not create MdcSerializer " + mdcSerializerFullClassName, e); |
| * Implementations must have a public no-argument constructor to allow dynamic instantiation. | ||
| * </p> | ||
| */ | ||
| public interface MdcSerializer { | ||
| void serializeMdc(LogEvent event, StringBuilder builder); |
There was a problem hiding this comment.
Please add the following javadoc to the method:
/**
* Add MDC data for the give log event to the provided output string builder.
* The output written to the string builder must be a valid JSON-object without the surrounding curly braces
* and with a trailing comma. If this MDC serializer does not append any content, no comma shall be added.
* For example, the serializer could output the following content: "foo":"bar","key":"value",
*
* @param event the log event to write the MDC content for
* @param builder the output JSON string builder
*/
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.
No description provided.