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.flume.appender;
18
19 import org.apache.logging.log4j.core.LogEvent;
20
21 /**
22 * Factory to create Flume events.
23 */
24 public interface FlumeEventFactory {
25 /**
26 * Create a Flume event.
27 * @param event The Log4j LogEvent.
28 * @param includes A comma separated list of MDC elements to include.
29 * @param excludes A comma separated list of MDC elements to exclude.
30 * @param required A comma separated list of MDC elements that are required.
31 * @param mdcPrefix The value to prefix to MDC keys.
32 * @param eventPrefix The value to prefix to event keys.
33 * @param compress If true the event body should be compressed.
34 * @return A FlumeEvent.
35 */
36 FlumeEvent createEvent(LogEvent event, String includes, String excludes, String required,
37 String mdcPrefix, String eventPrefix, boolean compress);
38 }