1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.layout;
18
19 import java.util.HashMap;
20 import java.util.Map;
21 import org.apache.logging.log4j.core.LogEvent;
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.PluginFactory;
25 import org.apache.logging.log4j.core.helpers.Charsets;
26 import org.apache.logging.log4j.core.net.Facility;
27 import org.apache.logging.log4j.core.net.Priority;
28
29 import java.net.InetAddress;
30 import java.net.UnknownHostException;
31 import java.nio.charset.Charset;
32 import java.text.SimpleDateFormat;
33 import java.util.Date;
34 import java.util.Locale;
35 import java.util.regex.Matcher;
36 import java.util.regex.Pattern;
37
38
39
40
41
42 @Plugin(name = "SyslogLayout", type = "Core", elementType = "layout", printObject = true)
43 public class SyslogLayout extends AbstractStringLayout {
44
45
46
47 public static final Pattern NEWLINE_PATTERN = Pattern.compile("\\r?\\n");
48
49 private final Facility facility;
50 private final boolean includeNewLine;
51 private final String escapeNewLine;
52
53
54
55
56 private final SimpleDateFormat dateFormat = new SimpleDateFormat("MMM dd HH:mm:ss ", Locale.ENGLISH);
57
58
59
60 private final String localHostname = getLocalHostname();
61
62
63
64 protected SyslogLayout(final Facility facility, final boolean includeNL, final String escapeNL, final Charset c) {
65 super(c);
66 this.facility = facility;
67 this.includeNewLine = includeNL;
68 this.escapeNewLine = escapeNL == null ? null : Matcher.quoteReplacement(escapeNL);
69 }
70
71
72
73
74
75
76
77 public String toSerializable(final LogEvent event) {
78 final StringBuilder buf = new StringBuilder();
79
80 buf.append("<");
81 buf.append(Priority.getPriority(facility, event.getLevel()));
82 buf.append(">");
83 addDate(event.getMillis(), buf);
84 buf.append(" ");
85 buf.append(localHostname);
86 buf.append(" ");
87
88 String message = event.getMessage().getFormattedMessage();
89 if (null != escapeNewLine) {
90 message = NEWLINE_PATTERN.matcher(message).replaceAll(escapeNewLine);
91 }
92 buf.append(message);
93
94 if (includeNewLine) {
95 buf.append("\n");
96 }
97 return buf.toString();
98 }
99
100
101
102
103
104
105
106
107 private String getLocalHostname() {
108 try {
109 final InetAddress addr = InetAddress.getLocalHost();
110 return addr.getHostName();
111 } catch (final UnknownHostException uhe) {
112 LOGGER.error("Could not determine local host name", uhe);
113 return "UNKNOWN_LOCALHOST";
114 }
115 }
116
117 private synchronized void addDate(final long timestamp, final StringBuilder buf) {
118 final int index = buf.length() + 4;
119 buf.append(dateFormat.format(new Date(timestamp)));
120
121 if (buf.charAt(index) == '0') {
122 buf.setCharAt(index, ' ');
123 }
124 }
125
126
127
128
129
130
131
132
133
134 public Map<String, String> getContentFormat()
135 {
136 Map<String, String> result = new HashMap<String, String>();
137 result.put("structured", "false");
138 result.put("formatType", "logfilepatternreceiver");
139 result.put("dateFormat", dateFormat.toPattern());
140 result.put("format", "<LEVEL>TIMESTAMP PROP(HOSTNAME) MESSAGE");
141 return result;
142 }
143
144
145
146
147
148
149
150
151
152 @PluginFactory
153 public static SyslogLayout createLayout(@PluginAttr("facility") final String facility,
154 @PluginAttr("newLine") final String includeNL,
155 @PluginAttr("newLineEscape") final String escapeNL,
156 @PluginAttr("charset") final String charsetName) {
157 final Charset charset = Charsets.getSupportedCharset(charsetName);
158 final boolean includeNewLine = includeNL == null ? false : Boolean.valueOf(includeNL);
159 final Facility f = Facility.toFacility(facility, Facility.LOCAL0);
160 return new SyslogLayout(f, includeNewLine, escapeNL, charset);
161 }
162 }