org.apache.logging.log4j.core.async.AsyncQueueFullMessageUtil Maven / Gradle / Ivy
/*
* 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.async;
import org.apache.logging.log4j.status.StatusLogger;
/**
* Consider this class private.
*
* Logs a warning to the {@link StatusLogger} when events are logged out of order to avoid deadlocks.
*
*/
public final class AsyncQueueFullMessageUtil {
private AsyncQueueFullMessageUtil() {
// Utility Class
}
/**
* Logs a warning to the {@link StatusLogger} explaining why a message appears out of order in the appender.
*/
public static void logWarningToStatusLogger() {
StatusLogger.getLogger()
.warn("LOG4J2-2031: Log4j2 logged an event out of order to prevent deadlock caused by domain "
+ "objects logging from their toString method when the async queue is full");
}
}