1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.pattern;
18
19 import java.io.PrintWriter;
20 import java.io.StringWriter;
21 import java.util.ArrayList;
22 import java.util.Collections;
23 import java.util.List;
24
25 import org.apache.logging.log4j.core.LogEvent;
26 import org.apache.logging.log4j.core.config.Configuration;
27 import org.apache.logging.log4j.core.config.plugins.Plugin;
28 import org.apache.logging.log4j.core.impl.ThrowableFormatOptions;
29 import org.apache.logging.log4j.core.layout.PatternLayout;
30 import org.apache.logging.log4j.util.Strings;
31
32
33
34
35
36
37
38 @Plugin(name = "ThrowablePatternConverter", category = PatternConverter.CATEGORY)
39 @ConverterKeys({ "ex", "throwable", "exception" })
40 public class ThrowablePatternConverter extends LogEventPatternConverter {
41
42
43
44
45 protected final List<PatternFormatter> formatters;
46 private String rawOption;
47
48
49
50
51 protected final ThrowableFormatOptions options;
52
53
54
55
56
57
58
59
60 protected ThrowablePatternConverter(final String name, final String style, final String[] options, final Configuration config) {
61 super(name, style);
62 this.options = ThrowableFormatOptions.newInstance(options);
63 if (options != null && options.length > 0) {
64 rawOption = options[0];
65 }
66 if (this.options.getSuffix() != null) {
67 final PatternParser parser = PatternLayout.createPatternParser(config);
68 final List<PatternFormatter> parsedSuffixFormatters = parser.parse(this.options.getSuffix());
69
70 boolean hasThrowableSuffixFormatter = false;
71 for (final PatternFormatter suffixFormatter : parsedSuffixFormatters) {
72 if (suffixFormatter.handlesThrowable()) {
73 hasThrowableSuffixFormatter = true;
74 }
75 }
76 if (!hasThrowableSuffixFormatter) {
77 this.formatters = parsedSuffixFormatters;
78 } else {
79 final List<PatternFormatter> suffixFormatters = new ArrayList<>();
80 for (final PatternFormatter suffixFormatter : parsedSuffixFormatters) {
81 if (!suffixFormatter.handlesThrowable()) {
82 suffixFormatters.add(suffixFormatter);
83 }
84 }
85 this.formatters = suffixFormatters;
86 }
87 } else {
88 this.formatters = Collections.emptyList();
89 }
90
91 }
92
93
94
95
96
97
98
99
100
101 public static ThrowablePatternConverter newInstance(final Configuration config, final String[] options) {
102 return new ThrowablePatternConverter("Throwable", "throwable", options, config);
103 }
104
105
106
107
108 @Override
109 public void format(final LogEvent event, final StringBuilder buffer) {
110 final Throwable t = event.getThrown();
111
112 if (isSubShortOption()) {
113 formatSubShortOption(t, getSuffix(event), buffer);
114 }
115 else if (t != null && options.anyLines()) {
116 formatOption(t, getSuffix(event), buffer);
117 }
118 }
119
120 private boolean isSubShortOption() {
121 return ThrowableFormatOptions.MESSAGE.equalsIgnoreCase(rawOption) ||
122 ThrowableFormatOptions.LOCALIZED_MESSAGE.equalsIgnoreCase(rawOption) ||
123 ThrowableFormatOptions.FILE_NAME.equalsIgnoreCase(rawOption) ||
124 ThrowableFormatOptions.LINE_NUMBER.equalsIgnoreCase(rawOption) ||
125 ThrowableFormatOptions.METHOD_NAME.equalsIgnoreCase(rawOption) ||
126 ThrowableFormatOptions.CLASS_NAME.equalsIgnoreCase(rawOption);
127 }
128
129 private void formatSubShortOption(final Throwable t, final String suffix, final StringBuilder buffer) {
130 StackTraceElement[] trace;
131 StackTraceElement throwingMethod = null;
132 int len;
133
134 if (t != null) {
135 trace = t.getStackTrace();
136 if (trace !=null && trace.length > 0) {
137 throwingMethod = trace[0];
138 }
139 }
140
141 if (t != null && throwingMethod != null) {
142 String toAppend = Strings.EMPTY;
143
144 if (ThrowableFormatOptions.CLASS_NAME.equalsIgnoreCase(rawOption)) {
145 toAppend = throwingMethod.getClassName();
146 }
147 else if (ThrowableFormatOptions.METHOD_NAME.equalsIgnoreCase(rawOption)) {
148 toAppend = throwingMethod.getMethodName();
149 }
150 else if (ThrowableFormatOptions.LINE_NUMBER.equalsIgnoreCase(rawOption)) {
151 toAppend = String.valueOf(throwingMethod.getLineNumber());
152 }
153 else if (ThrowableFormatOptions.MESSAGE.equalsIgnoreCase(rawOption)) {
154 toAppend = t.getMessage();
155 }
156 else if (ThrowableFormatOptions.LOCALIZED_MESSAGE.equalsIgnoreCase(rawOption)) {
157 toAppend = t.getLocalizedMessage();
158 }
159 else if (ThrowableFormatOptions.FILE_NAME.equalsIgnoreCase(rawOption)) {
160 toAppend = throwingMethod.getFileName();
161 }
162
163 len = buffer.length();
164 if (len > 0 && !Character.isWhitespace(buffer.charAt(len - 1))) {
165 buffer.append(' ');
166 }
167 buffer.append(toAppend);
168
169 if (Strings.isNotBlank(suffix)) {
170 buffer.append(' ');
171 buffer.append(suffix);
172 }
173 }
174 }
175
176 private void formatOption(final Throwable throwable, final String suffix, final StringBuilder buffer) {
177 final StringWriter w = new StringWriter();
178
179 throwable.printStackTrace(new PrintWriter(w));
180 final int len = buffer.length();
181 if (len > 0 && !Character.isWhitespace(buffer.charAt(len - 1))) {
182 buffer.append(' ');
183 }
184 if (!options.allLines() || !Strings.LINE_SEPARATOR.equals(options.getSeparator()) || Strings.isNotBlank(suffix)) {
185 final StringBuilder sb = new StringBuilder();
186 final String[] array = w.toString().split(Strings.LINE_SEPARATOR);
187 final int limit = options.minLines(array.length) - 1;
188 final boolean suffixNotBlank = Strings.isNotBlank(suffix);
189 for (int i = 0; i <= limit; ++i) {
190 sb.append(array[i]);
191 if (suffixNotBlank) {
192 sb.append(' ');
193 sb.append(suffix);
194 }
195 if (i < limit) {
196 sb.append(options.getSeparator());
197 }
198 }
199 buffer.append(sb.toString());
200
201 } else {
202 buffer.append(w.toString());
203 }
204 }
205
206
207
208
209
210
211 @Override
212 public boolean handlesThrowable() {
213 return true;
214 }
215
216 protected String getSuffix(final LogEvent event) {
217
218 final StringBuilder toAppendTo = new StringBuilder();
219 for (int i = 0, size = formatters.size(); i < size; i++) {
220 formatters.get(i).format(event, toAppendTo);
221 }
222 return toAppendTo.toString();
223 }
224
225 public ThrowableFormatOptions getOptions() {
226 return options;
227 }
228 }