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