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.core.appender; 018 019import java.io.Serializable; 020import java.nio.charset.Charset; 021 022import org.apache.logging.log4j.core.Filter; 023import org.apache.logging.log4j.core.Layout; 024import org.apache.logging.log4j.core.config.Configuration; 025import org.apache.logging.log4j.core.config.plugins.Plugin; 026import org.apache.logging.log4j.core.config.plugins.PluginAliases; 027import org.apache.logging.log4j.core.config.plugins.PluginAttribute; 028import org.apache.logging.log4j.core.config.plugins.PluginConfiguration; 029import org.apache.logging.log4j.core.config.plugins.PluginElement; 030import org.apache.logging.log4j.core.config.plugins.PluginFactory; 031import org.apache.logging.log4j.core.layout.LoggerFields; 032import org.apache.logging.log4j.core.layout.Rfc5424Layout; 033import org.apache.logging.log4j.core.layout.SyslogLayout; 034import org.apache.logging.log4j.core.net.AbstractSocketManager; 035import org.apache.logging.log4j.core.net.Advertiser; 036import org.apache.logging.log4j.core.net.Facility; 037import org.apache.logging.log4j.core.net.Protocol; 038import org.apache.logging.log4j.core.net.ssl.SslConfiguration; 039import org.apache.logging.log4j.util.EnglishEnums; 040 041/** 042 * The Syslog Appender. 043 */ 044@Plugin(name = "Syslog", category = "Core", elementType = "appender", printObject = true) 045public class SyslogAppender extends SocketAppender { 046 047 protected static final String RFC5424 = "RFC5424"; 048 049 protected SyslogAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter, 050 final boolean ignoreExceptions, final boolean immediateFlush, 051 final AbstractSocketManager manager, final Advertiser advertiser) { 052 super(name, layout, filter, manager, ignoreExceptions, immediateFlush, advertiser); 053 054 } 055 056 /** 057 * Create a SyslogAppender. 058 * @param host The name of the host to connect to. 059 * @param port The port to connect to on the target host. 060 * @param protocolStr The Protocol to use. 061 * @param sslConfig TODO 062 * @param connectTimeoutMillis the connect timeout in milliseconds. 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 * @param connectTimeoutMillis the connect timeout in milliseconds. 093 * @return A SyslogAppender. 094 */ 095 @PluginFactory 096 public static SyslogAppender createAppender( 097 // @formatter:off 098 @PluginAttribute("host") final String host, 099 @PluginAttribute(value = "port", defaultInt = 0) final int port, 100 @PluginAttribute("protocol") final String protocolStr, 101 @PluginElement("SSL") final SslConfiguration sslConfig, 102 @PluginAttribute(value = "connectTimeoutMillis", defaultInt = 0) final int connectTimeoutMillis, 103 @PluginAliases("reconnectionDelay") // deprecated 104 @PluginAttribute(value = "reconnectionDelayMillis", defaultInt = 0) final int reconnectionDelayMillis, 105 @PluginAttribute(value = "immediateFail", defaultBoolean = true) final boolean immediateFail, 106 @PluginAttribute("name") final String name, 107 @PluginAttribute(value = "immediateFlush", defaultBoolean = true) final boolean immediateFlush, 108 @PluginAttribute(value = "ignoreExceptions", defaultBoolean = true) final boolean ignoreExceptions, 109 @PluginAttribute(value = "facility", defaultString = "LOCAL0") final Facility facility, 110 @PluginAttribute("id") final String id, 111 @PluginAttribute(value = "enterpriseNumber", defaultInt = Rfc5424Layout.DEFAULT_ENTERPRISE_NUMBER) final int enterpriseNumber, 112 @PluginAttribute(value = "includeMdc", defaultBoolean = true) final boolean includeMdc, 113 @PluginAttribute("mdcId") final String mdcId, 114 @PluginAttribute("mdcPrefix") final String mdcPrefix, 115 @PluginAttribute("eventPrefix") final String eventPrefix, 116 @PluginAttribute(value = "newLine", defaultBoolean = false) final boolean newLine, 117 @PluginAttribute("newLineEscape") final String escapeNL, 118 @PluginAttribute("appName") final String appName, 119 @PluginAttribute("messageId") final String msgId, 120 @PluginAttribute("mdcExcludes") final String excludes, 121 @PluginAttribute("mdcIncludes") final String includes, 122 @PluginAttribute("mdcRequired") final String required, 123 @PluginAttribute("format") final String format, 124 @PluginElement("Filter") final Filter filter, 125 @PluginConfiguration final Configuration config, 126 @PluginAttribute(value = "charset", defaultString = "UTF-8") final Charset charsetName, 127 @PluginAttribute("exceptionPattern") final String exceptionPattern, 128 @PluginElement("LoggerFields") final LoggerFields[] loggerFields, @PluginAttribute(value = "advertise", defaultBoolean = false) final boolean advertise) { 129 // @formatter:on 130 131 // TODO: add Protocol to TypeConverters 132 final Protocol protocol = EnglishEnums.valueOf(Protocol.class, protocolStr); 133 final boolean useTlsMessageFormat = sslConfig != null || protocol == Protocol.SSL; 134 final Layout<? extends Serializable> layout = RFC5424.equalsIgnoreCase(format) ? 135 Rfc5424Layout.createLayout(facility, id, enterpriseNumber, includeMdc, mdcId, mdcPrefix, eventPrefix, newLine, 136 escapeNL, appName, msgId, excludes, includes, required, exceptionPattern, useTlsMessageFormat, loggerFields, 137 config) : 138 SyslogLayout.createLayout(facility, newLine, escapeNL, charsetName); 139 140 if (name == null) { 141 LOGGER.error("No name provided for SyslogAppender"); 142 return null; 143 } 144 final AbstractSocketManager manager = createSocketManager(name, protocol, host, port, connectTimeoutMillis, 145 sslConfig, reconnectionDelayMillis, immediateFail, layout); 146 147 return new SyslogAppender(name, layout, filter, ignoreExceptions, immediateFlush, manager, 148 advertise ? config.getAdvertiser() : null); 149 } 150}