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 */
017 package org.apache.logging.log4j.core.appender;
018
019 import org.apache.logging.log4j.core.Filter;
020 import org.apache.logging.log4j.core.Layout;
021 import org.apache.logging.log4j.core.config.Configuration;
022 import org.apache.logging.log4j.core.config.plugins.Plugin;
023 import org.apache.logging.log4j.core.config.plugins.PluginAttr;
024 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
025 import org.apache.logging.log4j.core.config.plugins.PluginElement;
026 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
027 import org.apache.logging.log4j.core.layout.RFC5424Layout;
028 import org.apache.logging.log4j.core.layout.SyslogLayout;
029 import org.apache.logging.log4j.core.net.AbstractSocketManager;
030 import org.apache.logging.log4j.core.net.Advertiser;
031 import org.apache.logging.log4j.core.net.Protocol;
032
033 import java.io.Serializable;
034
035 /**
036 * The Syslog Appender.
037 */
038 @Plugin(name = "Syslog", category = "Core", elementType = "appender", printObject = true)
039 public class SyslogAppender<T extends Serializable> extends SocketAppender<T> {
040
041 private static final String BSD = "bsd";
042
043 private static final String RFC5424 = "RFC5424";
044
045 protected SyslogAppender(final String name, final Layout<T> layout, final Filter filter,
046 final boolean handleException, final boolean immediateFlush,
047 final AbstractSocketManager manager, Advertiser advertiser) {
048 super(name, layout, filter, manager, handleException, immediateFlush, advertiser);
049
050 }
051
052 /**
053 * Create a SyslogAppender.
054 * @param host The name of the host to connect to.
055 * @param portNum The port to connect to on the target host.
056 * @param protocol The Protocol to use.
057 * @param delay The interval in which failed writes should be retried.
058 * @param immediateFail True if the write should fail if no socket is immediately available.
059 * @param name The name of the Appender.
060 * @param immediateFlush "true" if data should be flushed on each write.
061 * @param suppress "true" if exceptions should be hidden from the application, "false" otherwise.
062 * The default is "true".
063 * @param facility The Facility is used to try to classify the message.
064 * @param id The default structured data id to use when formatting according to RFC 5424.
065 * @param ein The IANA enterprise number.
066 * @param includeMDC Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog
067 * record. Defaults to "true:.
068 * @param mdcId The id to use for the MDC Structured Data Element.
069 * @param mdcPrefix The prefix to add to MDC key names.
070 * @param eventPrefix The prefix to add to event key names.
071 * @param includeNL If true, a newline will be appended to the end of the syslog record. The default is false.
072 * @param escapeNL String that should be used to replace newlines within the message text.
073 * @param appName The value to use as the APP-NAME in the RFC 5424 syslog record.
074 * @param msgId The default value to be used in the MSGID field of RFC 5424 syslog records.
075 * @param excludes A comma separated list of mdc keys that should be excluded from the LogEvent.
076 * @param includes A comma separated list of mdc keys that should be included in the FlumeEvent.
077 * @param required A comma separated list of mdc keys that must be present in the MDC.
078 * @param format If set to "RFC5424" the data will be formatted in accordance with RFC 5424. Otherwise,
079 * it will be formatted as a BSD Syslog record.
080 * @param filter A Filter to determine if the event should be handled by this Appender.
081 * @param config The Configuration.
082 * @param charsetName The character set to use when converting the syslog String to a byte array.
083 * @param exceptionPattern The converter pattern to use for formatting exceptions.
084 * @return A SyslogAppender.
085 */
086 @PluginFactory
087 public static <S extends Serializable> SyslogAppender<S> createAppender(@PluginAttr("host") final String host,
088 @PluginAttr("port") final String portNum,
089 @PluginAttr("protocol") final String protocol,
090 @PluginAttr("reconnectionDelay") final String delay,
091 @PluginAttr("immediateFail") final String immediateFail,
092 @PluginAttr("name") final String name,
093 @PluginAttr("immediateFlush") final String immediateFlush,
094 @PluginAttr("suppressExceptions") final String suppress,
095 @PluginAttr("facility") final String facility,
096 @PluginAttr("id") final String id,
097 @PluginAttr("enterpriseNumber") final String ein,
098 @PluginAttr("includeMDC") final String includeMDC,
099 @PluginAttr("mdcId") final String mdcId,
100 @PluginAttr("mdcPrefix") final String mdcPrefix,
101 @PluginAttr("eventPrefix") final String eventPrefix,
102 @PluginAttr("newLine") final String includeNL,
103 @PluginAttr("newLineEscape") final String escapeNL,
104 @PluginAttr("appName") final String appName,
105 @PluginAttr("messageId") final String msgId,
106 @PluginAttr("mdcExcludes") final String excludes,
107 @PluginAttr("mdcIncludes") final String includes,
108 @PluginAttr("mdcRequired") final String required,
109 @PluginAttr("format") final String format,
110 @PluginElement("filters") final Filter filter,
111 @PluginConfiguration final Configuration config,
112 @PluginAttr("charset") final String charsetName,
113 @PluginAttr("exceptionPattern") final String exceptionPattern,
114 @PluginAttr("advertise") final String advertise) {
115
116 final boolean isFlush = immediateFlush == null ? true : Boolean.valueOf(immediateFlush);
117 final boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress);
118 final int reconnectDelay = delay == null ? 0 : Integer.parseInt(delay);
119 final boolean fail = immediateFail == null ? true : Boolean.valueOf(immediateFail);
120 final int port = portNum == null ? 0 : Integer.parseInt(portNum);
121 boolean isAdvertise = advertise == null ? false : Boolean.valueOf(advertise);
122 @SuppressWarnings("unchecked")
123 final Layout<S> layout = (Layout<S>)(RFC5424.equalsIgnoreCase(format) ?
124 RFC5424Layout.createLayout(facility, id, ein, includeMDC, mdcId, mdcPrefix, eventPrefix, includeNL,
125 escapeNL, appName, msgId, excludes, includes, required, charsetName, exceptionPattern, config) :
126 SyslogLayout.createLayout(facility, includeNL, escapeNL, charsetName));
127
128 if (name == null) {
129 LOGGER.error("No name provided for SyslogAppender");
130 return null;
131 }
132 final String prot = protocol != null ? protocol : Protocol.UDP.name();
133 final AbstractSocketManager manager = createSocketManager(prot, host, port, reconnectDelay, fail);
134 if (manager == null) {
135 return null;
136 }
137
138 return new SyslogAppender<S>(name, layout, filter, handleExceptions, isFlush, manager,
139 isAdvertise ? config.getAdvertiser() : null);
140 }
141 }