001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.async;
018
019import org.apache.logging.log4j.status.StatusLogger;
020
021/**
022 * <b>Consider this class private.</b>
023 * <p>
024 * Logs a warning to the {@link StatusLogger} when events are logged out of order to avoid deadlocks.
025 * </p>
026 */
027public final class AsyncQueueFullMessageUtil {
028    private AsyncQueueFullMessageUtil() {
029        // Utility Class
030    }
031
032    /**
033     * Logs a warning to the {@link StatusLogger} explaining why a message appears out of order in the appender.
034     */
035    public static void logWarningToStatusLogger() {
036        StatusLogger.getLogger()
037                .warn("LOG4J2-2031: Log4j2 logged an event out of order to prevent deadlock caused by domain " +
038                        "objects logging from their toString method when the async queue is full");
039    }
040}