001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.flume.appender;
018
019import org.apache.logging.log4j.core.LogEvent;
020
021/**
022 * Factory to create Flume events.
023 */
024public interface FlumeEventFactory {
025
026    /**
027     * Creates a Flume event.
028     * @param event The Log4j LogEvent.
029     * @param includes A comma separated list of MDC elements to include.
030     * @param excludes A comma separated list of MDC elements to exclude.
031     * @param required A comma separated list of MDC elements that are required.
032     * @param mdcPrefix The value to prefix to MDC keys.
033     * @param eventPrefix The value to prefix to event keys.
034     * @param compress If true the event body should be compressed.
035     * @return A FlumeEvent.
036     */
037    FlumeEvent createEvent(LogEvent event, String includes, String excludes, String required,
038                      String mdcPrefix, String eventPrefix, boolean compress);
039}