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