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