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 {@link StructuredDataMessage}.
24 */
25 public final class EventLogger {
26
27 /**
28 * Defines the Event Marker.
29 */
30 public static final Marker EVENT_MARKER = MarkerManager.getMarker("EVENT");
31
32 private static final String NAME = "EventLogger";
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 // empty
40 }
41
42 /**
43 * Logs events with a level of ALL.
44 * @param msg The event StructuredDataMessage.
45 */
46 public static void logEvent(final StructuredDataMessage msg) {
47 LOGGER.logIfEnabled(FQCN, Level.OFF, EVENT_MARKER, msg, null);
48 }
49
50 /**
51 * Logs events and specify the logging level.
52 * @param msg The event StructuredDataMessage.
53 * @param level The logging Level.
54 */
55 public static void logEvent(final StructuredDataMessage msg, final Level level) {
56 LOGGER.logIfEnabled(FQCN, level, EVENT_MARKER, msg, null);
57 }
58 }