forked from spring-projects/spring-boot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request spring-projects#42158 from slissner
* pr/42158: Polish "Add Graylog Extended Log Format (GELF) for structured logging" Add Graylog Extended Log Format (GELF) for structured logging Closes spring-projectsgh-42158
- Loading branch information
Showing
13 changed files
with
799 additions
and
3 deletions.
There are no files selected for viewing
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
149 changes: 149 additions & 0 deletions
149
...g/springframework/boot/logging/log4j2/GraylogExtendedLogFormatStructuredLogFormatter.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,149 @@ | ||
| /* | ||
| * Copyright 2012-2024 the original author or authors. | ||
| * | ||
| * Licensed 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 | ||
| * | ||
| * https://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. | ||
| */ | ||
|
|
||
| package org.springframework.boot.logging.log4j2; | ||
|
|
||
| import java.math.BigDecimal; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import java.util.function.BiConsumer; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.apache.logging.log4j.Level; | ||
| import org.apache.logging.log4j.core.LogEvent; | ||
| import org.apache.logging.log4j.core.net.Severity; | ||
| import org.apache.logging.log4j.core.time.Instant; | ||
| import org.apache.logging.log4j.message.Message; | ||
| import org.apache.logging.log4j.util.ReadOnlyStringMap; | ||
|
|
||
| import org.springframework.boot.json.JsonWriter; | ||
| import org.springframework.boot.json.JsonWriter.WritableJson; | ||
| import org.springframework.boot.logging.structured.CommonStructuredLogFormat; | ||
| import org.springframework.boot.logging.structured.GraylogExtendedLogFormatService; | ||
| import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter; | ||
| import org.springframework.boot.logging.structured.StructuredLogFormatter; | ||
| import org.springframework.core.env.Environment; | ||
| import org.springframework.core.log.LogMessage; | ||
| import org.springframework.util.Assert; | ||
| import org.springframework.util.ObjectUtils; | ||
|
|
||
| /** | ||
| * Log4j2 {@link StructuredLogFormatter} for | ||
| * {@link CommonStructuredLogFormat#GRAYLOG_EXTENDED_LOG_FORMAT}. Supports GELF version | ||
| * 1.1. | ||
| * | ||
| * @author Samuel Lissner | ||
| * @author Moritz Halbritter | ||
| */ | ||
| class GraylogExtendedLogFormatStructuredLogFormatter extends JsonWriterStructuredLogFormatter<LogEvent> { | ||
|
|
||
| private static final Log logger = LogFactory.getLog(GraylogExtendedLogFormatStructuredLogFormatter.class); | ||
|
|
||
| /** | ||
| * Allowed characters in field names are any word character (letter, number, | ||
| * underscore), dashes and dots. | ||
| */ | ||
| private static final Pattern FIELD_NAME_VALID_PATTERN = Pattern.compile("^[\\w.\\-]*$"); | ||
|
|
||
| /** | ||
| * Every field been sent and prefixed with an underscore "_" will be treated as an | ||
| * additional field. | ||
| */ | ||
| private static final String ADDITIONAL_FIELD_PREFIX = "_"; | ||
|
|
||
| /** | ||
| * Libraries SHOULD not allow to send id as additional field ("_id"). Graylog server | ||
| * nodes omit this field automatically. | ||
| */ | ||
| private static final Set<String> ADDITIONAL_FIELD_ILLEGAL_KEYS = Set.of("id", "_id"); | ||
|
|
||
| GraylogExtendedLogFormatStructuredLogFormatter(Environment environment) { | ||
| super((members) -> jsonMembers(environment, members)); | ||
| } | ||
|
|
||
| private static void jsonMembers(Environment environment, JsonWriter.Members<LogEvent> members) { | ||
| members.add("version", "1.1"); | ||
| // note: a blank message will lead to a Graylog error as of Graylog v6.0.x. We are | ||
| // ignoring this here. | ||
| members.add("short_message", LogEvent::getMessage).as(Message::getFormattedMessage); | ||
| members.add("timestamp", LogEvent::getInstant) | ||
| .as(GraylogExtendedLogFormatStructuredLogFormatter::formatTimeStamp); | ||
| members.add("level", GraylogExtendedLogFormatStructuredLogFormatter::convertLevel); | ||
| members.add("_level_name", LogEvent::getLevel).as(Level::name); | ||
| members.add("_process_pid", environment.getProperty("spring.application.pid", Long.class)) | ||
| .when(Objects::nonNull); | ||
| members.add("_process_thread_name", LogEvent::getThreadName); | ||
| GraylogExtendedLogFormatService.get(environment).jsonMembers(members); | ||
| members.add("_log_logger", LogEvent::getLoggerName); | ||
| members.from(LogEvent::getContextData) | ||
| .whenNot(ReadOnlyStringMap::isEmpty) | ||
| .usingPairs((contextData, pairs) -> contextData | ||
| .forEach((key, value) -> createAdditionalField(key, value, pairs))); | ||
| members.add().whenNotNull(LogEvent::getThrownProxy).usingMembers((eventMembers) -> { | ||
| eventMembers.add("full_message", | ||
| GraylogExtendedLogFormatStructuredLogFormatter::formatFullMessageWithThrowable); | ||
| eventMembers.add("_error_type", (event) -> event.getThrownProxy().getThrowable()) | ||
| .whenNotNull() | ||
| .as(ObjectUtils::nullSafeClassName); | ||
| eventMembers.add("_error_stack_trace", (event) -> event.getThrownProxy().getExtendedStackTraceAsString()); | ||
| eventMembers.add("_error_message", (event) -> event.getThrownProxy().getMessage()); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * GELF requires "seconds since UNIX epoch with optional <b>decimal places for | ||
| * milliseconds</b>". To comply with this requirement, we format a POSIX timestamp | ||
| * with millisecond precision as e.g. "1725459730385" -> "1725459730.385" | ||
| * @param timeStamp the timestamp of the log message. Note it is not the standard Java | ||
| * `Instant` type but {@link org.apache.logging.log4j.core.time} | ||
| * @return the timestamp formatted as string with millisecond precision | ||
| */ | ||
| private static WritableJson formatTimeStamp(Instant timeStamp) { | ||
| return (out) -> out.append(new BigDecimal(timeStamp.getEpochMillisecond()).movePointLeft(3).toPlainString()); | ||
| } | ||
|
|
||
| /** | ||
| * Converts the log4j2 event level to the Syslog event level code. | ||
| * @param event the log event | ||
| * @return an integer representing the syslog log level code | ||
| * @see Severity class from Log4j2 which contains the conversion logic | ||
| */ | ||
| private static int convertLevel(LogEvent event) { | ||
| return Severity.getSeverity(event.getLevel()).getCode(); | ||
| } | ||
|
|
||
| private static String formatFullMessageWithThrowable(LogEvent event) { | ||
| return event.getMessage().getFormattedMessage() + "\n\n" | ||
| + event.getThrownProxy().getExtendedStackTraceAsString(); | ||
| } | ||
|
|
||
| private static void createAdditionalField(String fieldName, Object value, BiConsumer<Object, Object> pairs) { | ||
| Assert.notNull(fieldName, "fieldName must not be null"); | ||
| if (!FIELD_NAME_VALID_PATTERN.matcher(fieldName).matches()) { | ||
| logger.warn(LogMessage.format("'%s' is not a valid field name according to GELF standard", fieldName)); | ||
| return; | ||
| } | ||
| if (ADDITIONAL_FIELD_ILLEGAL_KEYS.contains(fieldName)) { | ||
| logger.warn(LogMessage.format("'%s' is an illegal field name according to GELF standard", fieldName)); | ||
| return; | ||
| } | ||
| String key = (fieldName.startsWith(ADDITIONAL_FIELD_PREFIX)) ? fieldName : ADDITIONAL_FIELD_PREFIX + fieldName; | ||
| pairs.accept(key, value); | ||
| } | ||
|
|
||
| } |
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
139 changes: 139 additions & 0 deletions
139
.../springframework/boot/logging/logback/GraylogExtendedLogFormatStructuredLogFormatter.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,139 @@ | ||
| /* | ||
| * Copyright 2012-2024 the original author or authors. | ||
| * | ||
| * Licensed 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 | ||
| * | ||
| * https://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. | ||
| */ | ||
|
|
||
| package org.springframework.boot.logging.logback; | ||
|
|
||
| import java.math.BigDecimal; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import java.util.function.BiConsumer; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import ch.qos.logback.classic.pattern.ThrowableProxyConverter; | ||
| import ch.qos.logback.classic.spi.ILoggingEvent; | ||
| import ch.qos.logback.classic.spi.IThrowableProxy; | ||
| import ch.qos.logback.classic.util.LevelToSyslogSeverity; | ||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
|
|
||
| import org.springframework.boot.json.JsonWriter; | ||
| import org.springframework.boot.json.JsonWriter.WritableJson; | ||
| import org.springframework.boot.logging.structured.CommonStructuredLogFormat; | ||
| import org.springframework.boot.logging.structured.GraylogExtendedLogFormatService; | ||
| import org.springframework.boot.logging.structured.JsonWriterStructuredLogFormatter; | ||
| import org.springframework.boot.logging.structured.StructuredLogFormatter; | ||
| import org.springframework.core.env.Environment; | ||
| import org.springframework.core.log.LogMessage; | ||
| import org.springframework.util.Assert; | ||
| import org.springframework.util.CollectionUtils; | ||
|
|
||
| /** | ||
| * Logback {@link StructuredLogFormatter} for | ||
| * {@link CommonStructuredLogFormat#GRAYLOG_EXTENDED_LOG_FORMAT}. Supports GELF version | ||
| * 1.1. | ||
| * | ||
| * @author Samuel Lissner | ||
| * @author Moritz Halbritter | ||
| */ | ||
| class GraylogExtendedLogFormatStructuredLogFormatter extends JsonWriterStructuredLogFormatter<ILoggingEvent> { | ||
|
|
||
| private static final Log logger = LogFactory.getLog(GraylogExtendedLogFormatStructuredLogFormatter.class); | ||
|
|
||
| /** | ||
| * Allowed characters in field names are any word character (letter, number, | ||
| * underscore), dashes and dots. | ||
| */ | ||
| private static final Pattern FIELD_NAME_VALID_PATTERN = Pattern.compile("^[\\w.\\-]*$"); | ||
|
|
||
| /** | ||
| * Every field been sent and prefixed with an underscore "_" will be treated as an | ||
| * additional field. | ||
| */ | ||
| private static final String ADDITIONAL_FIELD_PREFIX = "_"; | ||
|
|
||
| /** | ||
| * Libraries SHOULD not allow to send id as additional field ("_id"). Graylog server | ||
| * nodes omit this field automatically. | ||
| */ | ||
| private static final Set<String> ADDITIONAL_FIELD_ILLEGAL_KEYS = Set.of("id", "_id"); | ||
|
|
||
| GraylogExtendedLogFormatStructuredLogFormatter(Environment environment, | ||
| ThrowableProxyConverter throwableProxyConverter) { | ||
| super((members) -> jsonMembers(environment, throwableProxyConverter, members)); | ||
| } | ||
|
|
||
| private static void jsonMembers(Environment environment, ThrowableProxyConverter throwableProxyConverter, | ||
| JsonWriter.Members<ILoggingEvent> members) { | ||
| members.add("version", "1.1"); | ||
| // note: a blank message will lead to a Graylog error as of Graylog v6.0.x. We are | ||
| // ignoring this here. | ||
| members.add("short_message", ILoggingEvent::getFormattedMessage); | ||
| members.add("timestamp", ILoggingEvent::getTimeStamp) | ||
| .as(GraylogExtendedLogFormatStructuredLogFormatter::formatTimeStamp); | ||
| members.add("level", LevelToSyslogSeverity::convert); | ||
| members.add("_level_name", ILoggingEvent::getLevel); | ||
| members.add("_process_pid", environment.getProperty("spring.application.pid", Long.class)) | ||
| .when(Objects::nonNull); | ||
| members.add("_process_thread_name", ILoggingEvent::getThreadName); | ||
| GraylogExtendedLogFormatService.get(environment).jsonMembers(members); | ||
| members.add("_log_logger", ILoggingEvent::getLoggerName); | ||
| members.from(ILoggingEvent::getMDCPropertyMap) | ||
| .when((mdc) -> !CollectionUtils.isEmpty(mdc)) | ||
| .usingPairs((mdc, pairs) -> mdc.forEach((key, value) -> createAdditionalField(key, value, pairs))); | ||
| members.from(ILoggingEvent::getKeyValuePairs) | ||
| .when((keyValuePairs) -> !CollectionUtils.isEmpty(keyValuePairs)) | ||
| .usingPairs((keyValuePairs, pairs) -> keyValuePairs | ||
| .forEach((keyValuePair) -> createAdditionalField(keyValuePair.key, keyValuePair.value, pairs))); | ||
| members.add().whenNotNull(ILoggingEvent::getThrowableProxy).usingMembers((throwableMembers) -> { | ||
| throwableMembers.add("full_message", | ||
| (event) -> formatFullMessageWithThrowable(throwableProxyConverter, event)); | ||
| throwableMembers.add("_error_type", ILoggingEvent::getThrowableProxy).as(IThrowableProxy::getClassName); | ||
| throwableMembers.add("_error_stack_trace", throwableProxyConverter::convert); | ||
| throwableMembers.add("_error_message", ILoggingEvent::getThrowableProxy).as(IThrowableProxy::getMessage); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * GELF requires "seconds since UNIX epoch with optional <b>decimal places for | ||
| * milliseconds</b>". To comply with this requirement, we format a POSIX timestamp | ||
| * with millisecond precision as e.g. "1725459730385" -> "1725459730.385" | ||
| * @param timeStamp the timestamp of the log message | ||
| * @return the timestamp formatted as string with millisecond precision | ||
| */ | ||
| private static WritableJson formatTimeStamp(long timeStamp) { | ||
| return (out) -> out.append(new BigDecimal(timeStamp).movePointLeft(3).toPlainString()); | ||
| } | ||
|
|
||
| private static String formatFullMessageWithThrowable(ThrowableProxyConverter throwableProxyConverter, | ||
| ILoggingEvent event) { | ||
| return event.getFormattedMessage() + "\n\n" + throwableProxyConverter.convert(event); | ||
| } | ||
|
|
||
| private static void createAdditionalField(String key, Object value, BiConsumer<Object, Object> pairs) { | ||
| Assert.notNull(key, "fieldName must not be null"); | ||
| if (!FIELD_NAME_VALID_PATTERN.matcher(key).matches()) { | ||
| logger.warn(LogMessage.format("'%s' is not a valid field name according to GELF standard", key)); | ||
| return; | ||
| } | ||
| if (ADDITIONAL_FIELD_ILLEGAL_KEYS.contains(key)) { | ||
| logger.warn(LogMessage.format("'%s' is an illegal field name according to GELF standard", key)); | ||
| return; | ||
| } | ||
| String keyWithPrefix = (key.startsWith(ADDITIONAL_FIELD_PREFIX)) ? key : ADDITIONAL_FIELD_PREFIX + key; | ||
| pairs.accept(keyWithPrefix, value); | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.