org.graylog2.log4j2.GelfAppender Maven / Gradle / Ivy
package org.graylog2.log4j2;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.appender.AppenderLoggingException;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.layout.PatternLayout;
import org.apache.logging.log4j.core.net.Severity;
import org.apache.logging.log4j.status.StatusLogger;
import org.graylog2.gelfclient.GelfConfiguration;
import org.graylog2.gelfclient.GelfMessageBuilder;
import org.graylog2.gelfclient.GelfMessageLevel;
import org.graylog2.gelfclient.GelfTransports;
import org.graylog2.gelfclient.transport.GelfTransport;
import java.io.Serializable;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.UnknownHostException;
import java.util.Formatter;
import java.util.List;
import java.util.Map;
@Plugin(name = "GELF", category = "Core", elementType = "appender", printObject = true)
public class GelfAppender extends AbstractAppender {
private static final Logger LOG = StatusLogger.getLogger();
private final GelfConfiguration gelfConfiguration;
private final String hostName;
private final boolean includeSource;
private final boolean includeThreadContext;
private final boolean includeStackTrace;
private GelfTransport client;
protected GelfAppender(final String name, final Layout layout, final Filter filter,
final boolean ignoreExceptions, final GelfConfiguration gelfConfiguration, final String hostName,
final boolean includeSource, final boolean includeThreadContext, final boolean includeStackTrace) {
super(name, filter, layout, ignoreExceptions);
this.gelfConfiguration = gelfConfiguration;
this.hostName = hostName;
this.includeSource = includeSource;
this.includeThreadContext = includeThreadContext;
this.includeStackTrace = includeStackTrace;
}
@Override
public void append(LogEvent event) {
final GelfMessageBuilder builder = new GelfMessageBuilder(event.getMessage().getFormattedMessage(), hostName)
.timestamp(event.getTimeMillis() / 1000d)
.level(GelfMessageLevel.fromNumericLevel(Severity.getSeverity(event.getLevel()).getCode()))
.additionalField("loggerName", event.getLoggerName())
.additionalField("threadName", event.getThreadName());
final Marker marker = event.getMarker();
if (marker != null) {
builder.additionalField("marker", marker.getName());
}
if (includeThreadContext) {
for (Map.Entry entry : event.getContextMap().entrySet()) {
builder.additionalField(entry.getKey(), entry.getValue());
}
final List contextStack = event.getContextStack().asList();
if (contextStack != null && !contextStack.isEmpty()) {
builder.additionalField("contextStack", contextStack.toString());
}
}
final StackTraceElement source = event.getSource();
if (includeSource && source != null) {
builder.additionalField("sourceFileName", source.getFileName());
builder.additionalField("sourceMethodName", source.getMethodName());
builder.additionalField("sourceClassName", source.getClassName());
builder.additionalField("sourceLineNumber", source.getLineNumber());
}
@SuppressWarnings("all")
final Throwable thrown = event.getThrown();
if (includeStackTrace && thrown != null) {
final StringBuilder stackTraceBuilder = new StringBuilder();
for (StackTraceElement stackTraceElement : thrown.getStackTrace()) {
new Formatter(stackTraceBuilder)
.format("%s.%s(%s:%d)\n",
stackTraceElement.getClassName(), stackTraceElement.getMethodName(),
stackTraceElement.getFileName(), stackTraceElement.getLineNumber());
}
builder.additionalField("exceptionClass", thrown.getClass().getCanonicalName());
builder.additionalField("exceptionMessage", thrown.getMessage());
builder.additionalField("exceptionStackTrace", stackTraceBuilder.toString());
builder.fullMessage(event.getMessage().getFormattedMessage() + "\n\n" + stackTraceBuilder.toString());
}
try {
client.send(builder.build());
} catch (Exception e) {
throw new AppenderLoggingException("failed to write log event to GELF server: " + e.getMessage(), e);
}
}
@Override
public void start() {
client = GelfTransports.create(gelfConfiguration);
}
@Override
public void stop() {
super.stop();
client.stop();
}
@Override
public String toString() {
return GelfAppender.class.getSimpleName() + "{"
+ "name=" + getName()
+ ",server=" + gelfConfiguration.getRemoteAddress().getHostName()
+ ",port=" + gelfConfiguration.getRemoteAddress().getPort()
+ ",protocol=" + gelfConfiguration.getTransport().toString()
+ ",hostName=" + hostName
+ ",queueSize=" + gelfConfiguration.getQueueSize()
+ ",connectTimeout=" + gelfConfiguration.getConnectTimeout()
+ ",reconnectDelay=" + gelfConfiguration.getReconnectDelay()
+ ",sendBufferSize=" + gelfConfiguration.getSendBufferSize()
+ ",tcpNoDelay=" + gelfConfiguration.isTcpNoDelay()
+ "}";
}
/**
* Factory method for creating a {@link GelfTransport} provider within the plugin manager.
*
* @param name The name of the Appender.
* @param filter A Filter to determine if the event should be handled by this Appender.
* @param layout The Layout to use to format the LogEvent defaults to {@code "%m%n"}.
* @param ignoreExceptions The default is {@code true}, causing exceptions encountered while appending events
* to be internally logged and then ignored. When set to {@code false} exceptions will
* be propagated to the caller, instead. Must be set to {@code false} when wrapping this
* Appender in a {@link org.apache.logging.log4j.core.appender.FailoverAppender}.
* @param server The server name of the GELF server, defaults to {@code localhost}.
* @param port The port the GELF server is listening on, defaults to {@code 12201}.
* @param hostName The host name of the machine generating the logs, defaults to local host name
* or {@code localhost} if it couldn't be detected.
* @param protocol The transport protocol to use, defaults to {@code UDP}.
* @param queueSize The size of the internally used queue, defaults to {@code 512}.
* @param connectTimeout The connection timeout for TCP connections in milliseconds, defaults to {@code 1000}.
* @param reconnectDelay The time to wait between reconnects in milliseconds, defaults to {@code 500}.
* @param sendBufferSize The size of the socket send buffer in bytes, defaults to {@code -1} (deactivate).
* @param tcpNoDelay Whether Nagle's algorithm should be used for TCP connections, defaults to {@code false}.
* @param includeSource Whether the source of the log message should be included, defaults to {@code true}.
* @param includeThreadContext Whether the contents of the {@link org.apache.logging.log4j.ThreadContext} should be included, defaults to {@code true}.
* @param includeStackTrace Whether a full stack trace should be included, defaults to {@code true}.
* @return a new GELF provider
*/
@PluginFactory
public static GelfAppender createGelfAppender(
@PluginElement("Filter") Filter filter,
@PluginElement("Layout") Layout layout,
@PluginAttribute(value = "name") String name,
@PluginAttribute(value = "ignoreExceptions", defaultBoolean = true) Boolean ignoreExceptions,
@PluginAttribute(value = "server", defaultString = "localhost") String server,
@PluginAttribute(value = "port", defaultInt = 12201) Integer port,
@PluginAttribute(value = "protocol", defaultString = "UDP") String protocol,
@PluginAttribute(value = "hostName") String hostName,
@PluginAttribute(value = "queueSize", defaultInt = 512) Integer queueSize,
@PluginAttribute(value = "connectTimeout", defaultInt = 1000) Integer connectTimeout,
@PluginAttribute(value = "reconnectDelay", defaultInt = 500) Integer reconnectDelay,
@PluginAttribute(value = "sendBufferSize", defaultInt = -1) Integer sendBufferSize,
@PluginAttribute(value = "tcpNoDelay", defaultBoolean = false) Boolean tcpNoDelay,
@PluginAttribute(value = "includeSource", defaultBoolean = true) Boolean includeSource,
@PluginAttribute(value = "includeThreadContext", defaultBoolean = true) Boolean includeThreadContext,
@PluginAttribute(value = "includeStackTrace", defaultBoolean = true) Boolean includeStackTrace
) {
if (name == null) {
LOGGER.error("No name provided for ConsoleAppender");
return null;
}
if (layout == null) {
layout = PatternLayout.createDefaultLayout();
}
if (!"UDP".equalsIgnoreCase(protocol) && !"TCP".equalsIgnoreCase(protocol)) {
LOG.warn("Invalid protocol {}, falling back to UDP", protocol);
protocol = "UDP";
}
if (hostName == null || hostName.trim().isEmpty()) {
try {
hostName = InetAddress.getLocalHost().getHostName();
} catch (UnknownHostException e) {
LOG.warn("Couldn't detect local host name, falling back to \"localhost\"");
hostName = "localhost";
}
}
final InetSocketAddress serverAddress = new InetSocketAddress(server, port);
final GelfTransports gelfProtocol = GelfTransports.valueOf(protocol.toUpperCase());
final GelfConfiguration gelfConfiguration = new GelfConfiguration(serverAddress)
.transport(gelfProtocol)
.queueSize(queueSize)
.connectTimeout(connectTimeout)
.reconnectDelay(reconnectDelay)
.sendBufferSize(sendBufferSize)
.tcpNoDelay(tcpNoDelay);
return new GelfAppender(name, layout, filter, ignoreExceptions, gelfConfiguration, hostName,
includeSource, includeThreadContext, includeStackTrace);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy