1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.appender;
18
19 import java.io.Serializable;
20 import java.nio.charset.Charset;
21
22 import org.apache.logging.log4j.core.Filter;
23 import org.apache.logging.log4j.core.Layout;
24 import org.apache.logging.log4j.core.config.Configuration;
25 import org.apache.logging.log4j.core.config.plugins.Plugin;
26 import org.apache.logging.log4j.core.config.plugins.PluginAliases;
27 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
28 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
29 import org.apache.logging.log4j.core.config.plugins.PluginElement;
30 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
31 import org.apache.logging.log4j.core.layout.LoggerFields;
32 import org.apache.logging.log4j.core.layout.Rfc5424Layout;
33 import org.apache.logging.log4j.core.layout.SyslogLayout;
34 import org.apache.logging.log4j.core.net.AbstractSocketManager;
35 import org.apache.logging.log4j.core.net.Advertiser;
36 import org.apache.logging.log4j.core.net.Facility;
37 import org.apache.logging.log4j.core.net.Protocol;
38 import org.apache.logging.log4j.core.net.ssl.SslConfiguration;
39 import org.apache.logging.log4j.util.EnglishEnums;
40
41
42
43
44 @Plugin(name = "Syslog", category = "Core", elementType = "appender", printObject = true)
45 public class SyslogAppender extends SocketAppender {
46
47 protected static final String RFC5424 = "RFC5424";
48
49 protected SyslogAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,
50 final boolean ignoreExceptions, final boolean immediateFlush,
51 final AbstractSocketManager manager, final Advertiser advertiser) {
52 super(name, layout, filter, manager, ignoreExceptions, immediateFlush, advertiser);
53
54 }
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95 @PluginFactory
96 public static SyslogAppender createAppender(
97
98 @PluginAttribute("host") final String host,
99 @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")
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
130
131
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 }