org.apache.logging.log4j.core.LogEvent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of log4j-core Show documentation
Show all versions of log4j-core Show documentation
The Apache Log4j Implementation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.
*/
package org.apache.logging.log4j.core;
import java.io.Serializable;
import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.ThreadContext;
import org.apache.logging.log4j.core.impl.ThrowableProxy;
import org.apache.logging.log4j.message.Message;
/**
* Provides contextual information about a logged message. A LogEvent must be {@link java.io.Serializable} so that it
* may be transmitted over a network connection, output in a
* {@link org.apache.logging.log4j.core.layout.SerializedLayout}, and many other uses. Besides containing a
* {@link org.apache.logging.log4j.message.Message}, a LogEvent has a corresponding
* {@link org.apache.logging.log4j.Level} that the message was logged at. If a
* {@link org.apache.logging.log4j.Marker} was used, then it is included here. The contents of the
* {@link org.apache.logging.log4j.ThreadContext} at the time of the log call are provided via
* {@link #getContextMap()} and {@link #getContextStack()}. If a {@link java.lang.Throwable} was included in the log
* call, then it is provided via {@link #getThrown()}. When this class is serialized, the attached Throwable will
* be wrapped into a {@link org.apache.logging.log4j.core.impl.ThrowableProxy} so that it may be safely serialized
* and deserialized properly without causing problems if the exception class is not available on the other end.
*/
public interface LogEvent extends Serializable {
/**
* Gets the context map (also know as Mapped Diagnostic Context or MDC).
*
* @return The context map, never {@code null}.
*/
Map getContextMap();
/**
* Gets the context stack (also known as Nested Diagnostic Context or NDC).
*
* @return The context stack, never {@code null}.
*/
ThreadContext.ContextStack getContextStack();
/**
* Returns the fully qualified class name of the caller of the logging API.
*
* @return The fully qualified class name of the caller.
*/
String getLoggerFqcn();
/**
* Gets the level.
*
* @return level.
*/
Level getLevel();
/**
* Gets the logger name.
*
* @return logger name, may be {@code null}.
*/
String getLoggerName();
/**
* Gets the Marker associated with the event.
*
* @return Marker or {@code null} if no Marker was defined on this LogEvent
*/
Marker getMarker();
/**
* Gets the message associated with the event.
*
* @return message.
*/
Message getMessage();
/**
* Gets event time in milliseconds since midnight, January 1, 1970 UTC.
*
* @return milliseconds since midnight, January 1, 1970 UTC.
* @see java.lang.System#currentTimeMillis()
*/
long getTimeMillis();
/**
* Gets the source of logging request.
*
* @return source of logging request, may be null.
*/
StackTraceElement getSource();
/**
* Gets the thread name.
*
* @return thread name, may be null.
* TODO guess this could go into a thread context object too. (RG) Why?
*/
String getThreadName();
/**
* Gets the thread ID.
*
* @return thread ID.
* @since 2.6
*/
long getThreadId();
/**
* Gets the thread priority.
*
* @return thread priority.
* @since 2.6
*/
int getThreadPriority();
/**
* Gets throwable associated with logging request.
*
* Convenience method for {@code ThrowableProxy.getThrowable();}
*
* @return throwable, may be null.
*/
Throwable getThrown();
/**
* Gets throwable proxy associated with logging request.
*
* @return throwable, may be null.
*/
ThrowableProxy getThrownProxy();
/**
* Returns {@code true} if this event is the last one in a batch, {@code false} otherwise. Used by asynchronous
* Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient
* alternative to the {@code immediateFlush=true} configuration.
*
* @return whether this event is the last one in a batch.
*/
// see also LOG4J2-164
boolean isEndOfBatch();
/**
* Returns whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use
* this flag to determine whether to take a {@code StackTrace} snapshot or not before handing off this event to
* another thread.
*
* @return {@code true} if the source of the logging request is required downstream, {@code false} otherwise.
* @see #getSource()
*/
// see also LOG4J2-153
boolean isIncludeLocation();
/**
* Sets whether this event is the last one in a batch. Used by asynchronous Loggers and Appenders to signal to
* buffered downstream components when to flush to disk, as a more efficient alternative to the
* {@code immediateFlush=true} configuration.
*
* @param endOfBatch {@code true} if this event is the last one in a batch, {@code false} otherwise.
*/
void setEndOfBatch(boolean endOfBatch);
/**
* Sets whether the source of the logging request is required downstream. Asynchronous Loggers and Appenders use
* this flag to determine whether to take a {@code StackTrace} snapshot or not before handing off this event to
* another thread.
*
* @param locationRequired {@code true} if the source of the logging request is required downstream, {@code false}
* otherwise.
* @see #getSource()
*/
void setIncludeLocation(boolean locationRequired);
/**
* Returns the value of the running Java Virtual Machine's high-resolution time source when this event was created,
* or a dummy value if it is known that this value will not be used downstream.
* @return The value of the running Java Virtual Machine's high-resolution time source when this event was created.
* @since Log4J 2.4
*/
long getNanoTime();
}