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