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 private static final long serialVersionUID = 1L;
48 protected static final String RFC5424 = "RFC5424";
49
50 protected SyslogAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,
51 final boolean ignoreExceptions, final boolean immediateFlush,
52 final AbstractSocketManager manager, final Advertiser advertiser) {
53 super(name, layout, filter, manager, ignoreExceptions, immediateFlush, advertiser);
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 @PluginFactory
95 public static SyslogAppender createAppender(
96
97 @PluginAttribute("host") final String host,
98 @PluginAttribute(value = "port", defaultInt = 0) final int port,
99 @PluginAttribute("protocol") final String protocolStr,
100 @PluginElement("SSL") final SslConfiguration sslConfig,
101 @PluginAliases("reconnectionDelay")
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
129
130
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 }