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
21 import org.apache.logging.log4j.core.Filter;
22 import org.apache.logging.log4j.core.Layout;
23 import org.apache.logging.log4j.core.config.Configuration;
24 import org.apache.logging.log4j.core.config.plugins.Plugin;
25 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
26 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
27 import org.apache.logging.log4j.core.config.plugins.PluginElement;
28 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
29 import org.apache.logging.log4j.core.helpers.Booleans;
30 import org.apache.logging.log4j.core.layout.LoggerFields;
31 import org.apache.logging.log4j.core.layout.RFC5424Layout;
32 import org.apache.logging.log4j.core.layout.SyslogLayout;
33 import org.apache.logging.log4j.core.net.AbstractSocketManager;
34 import org.apache.logging.log4j.core.net.Advertiser;
35 import org.apache.logging.log4j.core.net.Protocol;
36 import org.apache.logging.log4j.util.EnglishEnums;
37
38
39
40
41 @Plugin(name = "Syslog", category = "Core", elementType = "appender", printObject = true)
42 public class SyslogAppender extends SocketAppender {
43
44 protected static final String RFC5424 = "RFC5424";
45
46 protected SyslogAppender(final String name, final Layout<? extends Serializable> layout, final Filter filter,
47 final boolean ignoreExceptions, final boolean immediateFlush,
48 final AbstractSocketManager manager, final Advertiser advertiser) {
49 super(name, layout, filter, manager, ignoreExceptions, immediateFlush, advertiser);
50
51 }
52
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 @PluginFactory
90 public static SyslogAppender createAppender(
91 @PluginAttribute("host") final String host,
92 @PluginAttribute("port") final String portNum,
93 @PluginAttribute("protocol") final String protocol,
94 @PluginAttribute("reconnectionDelay") final String delay,
95 @PluginAttribute("immediateFail") final String immediateFail,
96 @PluginAttribute("name") final String name,
97 @PluginAttribute("immediateFlush") final String immediateFlush,
98 @PluginAttribute("ignoreExceptions") final String ignore,
99 @PluginAttribute("facility") final String facility,
100 @PluginAttribute("id") final String id,
101 @PluginAttribute("enterpriseNumber") final String ein,
102 @PluginAttribute("includeMDC") final String includeMDC,
103 @PluginAttribute("mdcId") final String mdcId,
104 @PluginAttribute("mdcPrefix") final String mdcPrefix,
105 @PluginAttribute("eventPrefix") final String eventPrefix,
106 @PluginAttribute("newLine") final String includeNL,
107 @PluginAttribute("newLineEscape") final String escapeNL,
108 @PluginAttribute("appName") final String appName,
109 @PluginAttribute("messageId") final String msgId,
110 @PluginAttribute("mdcExcludes") final String excludes,
111 @PluginAttribute("mdcIncludes") final String includes,
112 @PluginAttribute("mdcRequired") final String required,
113 @PluginAttribute("format") final String format,
114 @PluginElement("Filters") final Filter filter,
115 @PluginConfiguration final Configuration config,
116 @PluginAttribute("charset") final String charsetName,
117 @PluginAttribute("exceptionPattern") final String exceptionPattern,
118 @PluginElement("LoggerFields") final LoggerFields[] loggerFields,
119 @PluginAttribute("advertise") final String advertise) {
120
121 final boolean isFlush = Booleans.parseBoolean(immediateFlush, true);
122 final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
123 final int reconnectDelay = AbstractAppender.parseInt(delay, 0);
124 final boolean fail = Booleans.parseBoolean(immediateFail, true);
125 final int port = AbstractAppender.parseInt(portNum, 0);
126 final boolean isAdvertise = Boolean.parseBoolean(advertise);
127 final Layout<? extends Serializable> layout = (RFC5424.equalsIgnoreCase(format) ?
128 RFC5424Layout.createLayout(facility, id, ein, includeMDC, mdcId, mdcPrefix, eventPrefix, includeNL,
129 escapeNL, appName, msgId, excludes, includes, required, exceptionPattern, "false", loggerFields,
130 config) :
131 SyslogLayout.createLayout(facility, includeNL, escapeNL, charsetName));
132
133 if (name == null) {
134 LOGGER.error("No name provided for SyslogAppender");
135 return null;
136 }
137 final Protocol p = EnglishEnums.valueOf(Protocol.class, protocol);
138 final AbstractSocketManager manager = createSocketManager(p, host, port, reconnectDelay, fail, layout);
139 if (manager == null) {
140 return null;
141 }
142
143 return new SyslogAppender(name, layout, filter, ignoreExceptions, isFlush, manager,
144 isAdvertise ? config.getAdvertiser() : null);
145 }
146 }