1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.async;
18
19 import org.apache.logging.log4j.status.StatusLogger;
20
21 /**
22 * <b>Consider this class private.</b>
23 * <p>
24 * Logs a warning to the {@link StatusLogger} when events are logged out of order to avoid deadlocks.
25 * </p>
26 */
27 public final class AsyncQueueFullMessageUtil {
28 private AsyncQueueFullMessageUtil() {
29 // Utility Class
30 }
31
32 /**
33 * Logs a warning to the {@link StatusLogger} explaining why a message appears out of order in the appender.
34 */
35 public static void logWarningToStatusLogger() {
36 StatusLogger.getLogger()
37 .warn("LOG4J2-2031: Log4j2 logged an event out of order to prevent deadlock caused by domain " +
38 "objects logging from their toString method when the async queue is full");
39 }
40 }