forked from logfellow/logstash-logback-encoder
-
Notifications
You must be signed in to change notification settings - Fork 1
/
LogstashLayout.java
282 lines (228 loc) · 9.29 KB
/
LogstashLayout.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/*
* Copyright 2013-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.logstash.logback.layout;
import java.util.List;
import net.logstash.logback.LogstashFormatter;
import net.logstash.logback.composite.AbstractCompositeJsonFormatter;
import net.logstash.logback.composite.JsonProvider;
import net.logstash.logback.composite.JsonProviders;
import net.logstash.logback.composite.loggingevent.mdc.MdcEntryWriter;
import net.logstash.logback.fieldnames.LogstashFieldNames;
import ch.qos.logback.classic.pattern.ThrowableHandlingConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;
public class LogstashLayout extends LoggingEventCompositeJsonLayout {
@Override
protected AbstractCompositeJsonFormatter<ILoggingEvent> createFormatter() {
return new LogstashFormatter(this);
}
@Override
protected LogstashFormatter getFormatter() {
return (LogstashFormatter) super.getFormatter();
}
public void addProvider(JsonProvider<ILoggingEvent> provider) {
getFormatter().addProvider(provider);
}
public void setCustomFields(String customFields) {
getFormatter().setCustomFieldsFromString(customFields);
}
public String getCustomFields() {
return getFormatter().getCustomFieldsAsString();
}
public boolean isIncludeCallerData() {
return getFormatter().isIncludeCallerData();
}
public void setIncludeCallerData(boolean includeCallerData) {
getFormatter().setIncludeCallerData(includeCallerData);
}
public LogstashFieldNames getFieldNames() {
return getFormatter().getFieldNames();
}
public void setFieldNames(LogstashFieldNames fieldNames) {
getFormatter().setFieldNames(fieldNames);
}
public boolean isIncludeMdc() {
return getFormatter().isIncludeMdc();
}
public void setIncludeMdc(boolean includeMdc) {
getFormatter().setIncludeMdc(includeMdc);
}
public List<String> getIncludeMdcKeyNames() {
return getFormatter().getIncludeMdcKeyNames();
}
public void addIncludeMdcKeyName(String includedMdcKeyName) {
getFormatter().addIncludeMdcKeyName(includedMdcKeyName);
}
public void setIncludeMdcKeyNames(List<String> includeMdcKeyNames) {
getFormatter().setIncludeMdcKeyNames(includeMdcKeyNames);
}
public List<String> getExcludeMdcKeyNames() {
return getFormatter().getExcludeMdcKeyNames();
}
public void addExcludeMdcKeyName(String excludedMdcKeyName) {
getFormatter().addExcludeMdcKeyName(excludedMdcKeyName);
}
public void setExcludeMdcKeyNames(List<String> excludeMdcKeyNames) {
getFormatter().setExcludeMdcKeyNames(excludeMdcKeyNames);
}
public void addMdcKeyFieldName(String mdcKeyFieldName) {
getFormatter().addMdcKeyFieldName(mdcKeyFieldName);
}
public List<MdcEntryWriter> getMdcEntryWriters() {
return getFormatter().getMdcEntryWriters();
}
public void addMdcEntryWriter(MdcEntryWriter mdcEntryWriter) {
getFormatter().addMdcEntryWriter(mdcEntryWriter);
}
public boolean isIncludeKeyValuePairs() {
return getFormatter().isIncludeKeyValuePairs();
}
public void setIncludeKeyValuePairs(boolean includeKeyValuePairs) {
getFormatter().setIncludeKeyValuePairs(includeKeyValuePairs);
}
public void addIncludeKeyValueKeyName(String includedKeyValueKeyName) {
getFormatter().addIncludeKeyValueKeyName(includedKeyValueKeyName);
}
public List<String> getIncludeKeyValueKeyNames() {
return getFormatter().getIncludeKeyValueKeyNames();
}
public void setIncludeKeyValueKeyNames(List<String> includeKeyValueKeyNames) {
getFormatter().setIncludeKeyValueKeyNames(includeKeyValueKeyNames);
}
public void addExcludeKeyValueKeyName(String excludedKeyValueKeyName) {
getFormatter().addExcludeKeyValueKeyName(excludedKeyValueKeyName);
}
public List<String> getExcludeKeyValueKeyNames() {
return getFormatter().getExcludeKeyValueKeyNames();
}
public void setExcludeKeyValueKeyNames(List<String> excludedKeyValueKeyNames) {
getFormatter().setExcludeKeyValueKeyNames(excludedKeyValueKeyNames);
}
public void addKeyValueKeyFieldName(String keyValueKeyFieldName) {
getFormatter().addKeyValueKeyFieldName(keyValueKeyFieldName);
}
public boolean isIncludeTags() {
return getFormatter().isIncludeTags();
}
public void setIncludeTags(boolean includeTags) {
getFormatter().setIncludeTags(includeTags);
}
public boolean isIncludeContext() {
return getFormatter().isIncludeContext();
}
public void setIncludeContext(boolean includeContext) {
getFormatter().setIncludeContext(includeContext);
}
public boolean isIncludeStructuredArguments() {
return getFormatter().isIncludeStructuredArguments();
}
public void setIncludeStructuredArguments(boolean includeStructuredArguments) {
getFormatter().setIncludeStructuredArguments(includeStructuredArguments);
}
public boolean isIncludeNonStructuredArguments() {
return getFormatter().isIncludeNonStructuredArguments();
}
public void setIncludeNonStructuredArguments(boolean includeNonStructuredArguments) {
getFormatter().setIncludeNonStructuredArguments(includeNonStructuredArguments);
}
public String getNonStructuredArgumentsFieldPrefix() {
return getFormatter().getNonStructuredArgumentsFieldPrefix();
}
public void setNonStructuredArgumentsFieldPrefix(String nonStructuredArgumentsFieldPrefix) {
getFormatter().setNonStructuredArgumentsFieldPrefix(nonStructuredArgumentsFieldPrefix);
}
public int getShortenedLoggerNameLength() {
return getFormatter().getShortenedLoggerNameLength();
}
public void setShortenedLoggerNameLength(int length) {
getFormatter().setShortenedLoggerNameLength(length);
}
public String getTimeZone() {
return getFormatter().getTimeZone();
}
public void setTimeZone(String timeZoneId) {
getFormatter().setTimeZone(timeZoneId);
}
public ThrowableHandlingConverter getThrowableConverter() {
return getFormatter().getThrowableConverter();
}
public String getTimestampPattern() {
return getFormatter().getTimestampPattern();
}
public void setTimestampPattern(String pattern) {
getFormatter().setTimestampPattern(pattern);
}
public void setThrowableConverter(ThrowableHandlingConverter throwableConverter) {
getFormatter().setThrowableConverter(throwableConverter);
}
public String getVersion() {
return getFormatter().getVersion();
}
public void setVersion(String version) {
getFormatter().setVersion(version);
}
public boolean isWriteVersionAsInteger() {
return getFormatter().isWriteVersionAsInteger();
}
public void setWriteVersionAsInteger(boolean writeVersionAsInteger) {
getFormatter().setWriteVersionAsInteger(writeVersionAsInteger);
}
/**
* Write the message as a JSON array by splitting the message text using the specified regex.
*
* @return The regex used to split the message text
*/
public String getMessageSplitRegex() {
return getFormatter().getMessageSplitRegex();
}
/**
* Write the message as a JSON array by splitting the message text using the specified regex.
*
* <p>The allowed values are:
* <ul>
* <li>Null/Empty : Disable message splitting. This is also the default behavior.</li>
* <li>Any valid regex : Use the specified regex.</li>
* <li>{@code SYSTEM} : Use the system-default line separator.</li>
* <li>{@code UNIX} : Use {@code \n}.</li>
* <li>{@code WINDOWS} : Use {@code \r\n}.</li>
* </ul>
*
* For example, if this parameter is set to the regex {@code #+}, then the logging statement:
* <pre>
* log.info("First line##Second line###Third line")
* </pre>
* will produce:
* <pre>
* {
* ...
* "message": [
* "First line",
* "Second line",
* "Third line"
* ],
* ...
* }
* </pre>
*
* @param messageSplitRegex The regex used to split the message text
*/
public void setMessageSplitRegex(String messageSplitRegex) {
getFormatter().setMessageSplitRegex(messageSplitRegex);
}
@Override
public void setProviders(JsonProviders<ILoggingEvent> jsonProviders) {
throw new IllegalArgumentException("Using the <providers> configuration property is not allowed. Use <provider> instead to registerd additional " + JsonProvider.class.getSimpleName() + ".");
}
}