-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support customization for MDC serializer
- Loading branch information
1 parent
7ff2b43
commit 7ee13d8
Showing
7 changed files
with
260 additions
and
62 deletions.
There are no files selected for viewing
72 changes: 72 additions & 0 deletions
72
log4j2-ecs-layout/src/main/java/co/elastic/logging/log4j2/DefaultMdcSerializer.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /*- | ||
| * #%L | ||
| * Java ECS logging | ||
| * %% | ||
| * Copyright (C) 2019 - 2020 Elastic and contributors | ||
| * %% | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| * #L% | ||
| */ | ||
| package co.elastic.logging.log4j2; | ||
|
|
||
| import co.elastic.logging.EcsJsonSerializer; | ||
| import co.elastic.logging.JsonUtils; | ||
| import org.apache.logging.log4j.core.LogEvent; | ||
| import org.apache.logging.log4j.util.TriConsumer; | ||
|
|
||
| interface DefaultMdcSerializer extends MdcSerializer { | ||
|
|
||
| /** | ||
| * Garbage free MDC serialization for log4j2 2.7+ | ||
| * Never reference directly in prod code so avoid linkage errors when TriConsumer or getContextData are not available | ||
| */ | ||
| enum UsingContextData implements MdcSerializer { | ||
|
|
||
| @SuppressWarnings("unused") | ||
| INSTANCE; | ||
|
|
||
| private static final TriConsumer<String, Object, StringBuilder> WRITE_MDC = new TriConsumer<String, Object, StringBuilder>() { | ||
| @Override | ||
| public void accept(final String key, final Object value, final StringBuilder stringBuilder) { | ||
| stringBuilder.append('\"'); | ||
| JsonUtils.quoteAsString(key, stringBuilder); | ||
| stringBuilder.append("\":\""); | ||
| JsonUtils.quoteAsString(EcsJsonSerializer.toNullSafeString(String.valueOf(value)), stringBuilder); | ||
| stringBuilder.append("\","); | ||
| } | ||
| }; | ||
|
|
||
|
|
||
| @Override | ||
| public void serializeMdc(LogEvent event, StringBuilder builder) { | ||
| event.getContextData().forEach(WRITE_MDC, builder); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Fallback for log4j2 <= 2.6 | ||
| */ | ||
| enum UsingContextMap implements MdcSerializer { | ||
| INSTANCE; | ||
|
|
||
| @Override | ||
| public void serializeMdc(LogEvent event, StringBuilder builder) { | ||
| EcsJsonSerializer.serializeMDC(builder, event.getContextMap()); | ||
| } | ||
| } | ||
| } |
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
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
58 changes: 58 additions & 0 deletions
58
log4j2-ecs-layout/src/main/java/co/elastic/logging/log4j2/MdcSerializerResolver.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /*- | ||
| * #%L | ||
| * Java ECS logging | ||
| * %% | ||
| * Copyright (C) 2019 - 2020 Elastic and contributors | ||
| * %% | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| * #L% | ||
| */ | ||
| package co.elastic.logging.log4j2; | ||
|
|
||
| import java.lang.reflect.InvocationTargetException; | ||
|
|
||
| import org.apache.logging.log4j.core.LogEvent; | ||
|
|
||
| import co.elastic.logging.log4j2.DefaultMdcSerializer.UsingContextMap; | ||
|
|
||
| interface MdcSerializerResolver { | ||
|
|
||
| static MdcSerializer resolve(String mdcSerializerFullClassName) { | ||
| if (mdcSerializerFullClassName == null || mdcSerializerFullClassName.isEmpty()) { | ||
| return resolveDefault(); | ||
| } | ||
| try { | ||
| Class<?> clazz = Class.forName(mdcSerializerFullClassName); | ||
| return (MdcSerializer) clazz.getDeclaredConstructor().newInstance(); | ||
| } catch (ClassNotFoundException | InstantiationException | IllegalAccessException | ||
| | NoSuchMethodException | InvocationTargetException e) { | ||
| return resolveDefault(); | ||
| } | ||
| } | ||
|
|
||
| private static MdcSerializer resolveDefault() { | ||
| try { | ||
| LogEvent.class.getMethod("getContextData"); | ||
| return (DefaultMdcSerializer) Class.forName( | ||
| "co.elastic.logging.log4j2.DefaultMdcSerializer$UsingContextData").getEnumConstants()[0]; | ||
| } catch (Exception | LinkageError ignore) { | ||
| } | ||
| return UsingContextMap.INSTANCE; | ||
| } | ||
|
|
||
| } |
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
71 changes: 71 additions & 0 deletions
71
log4j2-ecs-layout/src/test/java/co/elastic/logging/log4j2/CustomMdcSerializer.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /*- | ||
| * #%L | ||
| * Java ECS logging | ||
| * %% | ||
| * Copyright (C) 2019 - 2020 Elastic and contributors | ||
| * %% | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| * #L% | ||
| */ | ||
| package co.elastic.logging.log4j2; | ||
|
|
||
| import org.apache.logging.log4j.core.LogEvent; | ||
| import org.apache.logging.log4j.util.TriConsumer; | ||
|
|
||
| import co.elastic.logging.EcsJsonSerializer; | ||
| import co.elastic.logging.JsonUtils; | ||
|
|
||
| public class CustomMdcSerializer implements MdcSerializer { | ||
|
|
||
| protected static final String CUSTOM_MDC_SERIALIZER_TEST_KEY = "SPECIAL_TEST_CUSTOM_KEY"; | ||
|
|
||
| @Override | ||
| public void serializeMdc(LogEvent event, StringBuilder builder) { | ||
| event.getContextData() | ||
| .forEach((key, value) -> getWriteFunctionForKey(key).accept(key, value, builder)); | ||
| } | ||
|
|
||
| // Default function for serializing MDC entries | ||
| private static final TriConsumer<String, Object, StringBuilder> DEFAULT_WRITE_MDC_FUNCTION = (key, value, stringBuilder) -> { | ||
| stringBuilder.append('\"'); | ||
| JsonUtils.quoteAsString(key, stringBuilder); | ||
| stringBuilder.append("\":\""); | ||
| JsonUtils.quoteAsString(EcsJsonSerializer.toNullSafeString(String.valueOf(value)), stringBuilder); | ||
| stringBuilder.append("\","); | ||
| }; | ||
|
|
||
| // Custom function for handling a specific key | ||
| private static final TriConsumer<String, Object, StringBuilder> CUSTOM_KEY_WRITE_MDC_FUNCTION = (key, value, stringBuilder) -> DEFAULT_WRITE_MDC_FUNCTION.accept( | ||
| key, | ||
| value.toString().toUpperCase(), | ||
| stringBuilder | ||
| ); | ||
|
|
||
| /** | ||
| * Returns the appropriate function to write an MDC entry based on the key. | ||
| * | ||
| * @param key MDC key. | ||
| * @return The function to serialize the MDC entry value. | ||
| */ | ||
| private TriConsumer<String, Object, StringBuilder> getWriteFunctionForKey(String key) { | ||
| if (CUSTOM_MDC_SERIALIZER_TEST_KEY.equals(key)) { | ||
| return CUSTOM_KEY_WRITE_MDC_FUNCTION; | ||
| } | ||
| return DEFAULT_WRITE_MDC_FUNCTION; | ||
| } | ||
| } |
Oops, something went wrong.