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.ExtendedLogger;
    21
    22  /**
    23   *  Logs "Events" that are represented as StructuredDataMessages.
    24   */
    25  public final class EventLogger {
    26
    27      private static final String NAME = "EventLogger";
    28
    29      /**
    30       * Define the Event Marker.
    31       */
    32      public static final Marker EVENT_MARKER = MarkerManager.getMarker("EVENT");
    33
    34      private static final String FQCN = EventLogger.class.getName();
    35
    36      private static final ExtendedLogger LOGGER = LogManager.getContext(false).getLogger(NAME);
    37
    38      private EventLogger() {
    39      }
    40
    41      /**
    42       * Log events with a level of ALL.
    43       * @param msg The event StructuredDataMessage.
    44       */
    45      public static void logEvent(final StructuredDataMessage msg) {
    46          LOGGER.logIfEnabled(FQCN, Level.OFF, EVENT_MARKER, msg, null);
    47      }
    48
    49      /**
    50       * Log events and specify the logging level.
    51       * @param msg The event StructuredDataMessage.
    52       * @param level The logging Level.
    53       */
    54      public static void logEvent(final StructuredDataMessage msg, final Level level) {
    55          LOGGER.logIfEnabled(FQCN, level, EVENT_MARKER, msg, null);
    56      }
    57  }