View Javadoc

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;
18  
19  import org.apache.logging.log4j.message.StructuredDataMessage;
20  import org.apache.logging.log4j.spi.AbstractLogger;
21  import org.apache.logging.log4j.spi.AbstractLoggerWrapper;
22  
23  /**
24   *  Logs "Events" that are represented as StructuredDataMessages.
25   */
26  public final class EventLogger {
27  
28      private static final String NAME = "EventLogger";
29  
30      /**
31       * Define the Event Marker.
32       */
33      public static final Marker EVENT_MARKER = MarkerManager.getMarker("EVENT");
34  
35      private static final String FQCN = EventLogger.class.getName();
36  
37      private static AbstractLoggerWrapper loggerWrapper;
38  
39      static {
40          final Logger eventLogger = LogManager.getLogger(NAME);
41          if (!(eventLogger instanceof AbstractLogger)) {
42              throw new LoggingException("Logger returned must be based on AbstractLogger");
43          }
44          loggerWrapper = new AbstractLoggerWrapper((AbstractLogger) eventLogger, NAME, null);
45      }
46  
47  
48      private EventLogger() {
49      }
50  
51      /**
52       * Log events with a level of ALL.
53       * @param msg The event StructuredDataMessage.
54       */
55      public static void logEvent(final StructuredDataMessage msg) {
56          loggerWrapper.log(EVENT_MARKER, FQCN, Level.OFF, msg, null);
57      }
58  
59      /**
60       * Log events and specify the logging level.
61       * @param msg The event StructuredDataMessage.
62       * @param level The logging Level.
63       */
64      public static void logEvent(final StructuredDataMessage msg, final Level level) {
65          loggerWrapper.log(EVENT_MARKER, FQCN, level, msg, null);
66      }
67  }