| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache license, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the license for the specific language governing permissions and |
| * limitations under the license. |
| */ |
| package org.apache.logging.log4j.flumeog.appender; |
| |
| import org.apache.logging.log4j.core.LogEvent; |
| |
| /** |
| * Factory to create Flume events. |
| */ |
| public interface FlumeEventFactory { |
| /** |
| * Create a Flume event. |
| * @param event The Log4j LogEvent. |
| * @param hostname The name of the host. |
| * @param includes A comma separated list of MDC elements to include. |
| * @param excludes A comma separated list of MDC elements to exclude. |
| * @param required A comma separated list of MDC elements that are required. |
| * @param mdcPrefix The value to prefix to MDC keys. |
| * @param eventPrefix The value to prefix to event keys. |
| * @param compress If true the event body should be compressed. |
| * @return A FlumeEvent. |
| */ |
| FlumeEvent createEvent(LogEvent event, String hostname, String includes, String excludes, String required, |
| String mdcPrefix, String eventPrefix, boolean compress); |
| } |