Class ExceptionResolver
- All Implemented Interfaces:
EventResolver
,TemplateResolver<LogEvent>
- Direct Known Subclasses:
ExceptionRootCauseResolver
Note that this resolver is toggled by stackTraceEnabled
layout configuration, which is by default populated from log4j.layout.jsonTemplate.stackTraceEnabled
system property.
Configuration
config = field , [ stringified ] , [ stackTrace ] field = "field" -> ( "className" | "message" | "stackTrace" ) stackTrace = "stackTrace" -> ( [ stringified ] , [ elementTemplate ] ) stringified = "stringified" -> ( boolean | truncation ) truncation = "truncation" -> ( [ suffix ] , [ pointMatcherStrings ] , [ pointMatcherRegexes ] ) suffix = "suffix" -> string pointMatcherStrings = "pointMatcherStrings" -> string[] pointMatcherRegexes = "pointMatcherRegexes" -> string[] elementTemplate = "elementTemplate" -> objectstringified is set to false by default. stringified at the root level is deprecated in favor of stackTrace.stringified, which has precedence if both are provided.
pointMatcherStrings and pointMatcherRegexes enable the truncation of stringified stack traces after the given matching point. If both parameters are provided, pointMatcherStrings will be checked first.
If a stringified stack trace truncation takes place, it will be indicated with suffix, which by default is set to the configured truncatedStringSuffix in the layout, unless explicitly provided.
elementTemplate is an object describing the template to be used
while resolving the StackTraceElement
array. If stringified
is set to true, elementTemplate will be discarded. By
default, elementTemplate is set to null and rather
populated from the layout configuration. That is, the stack trace element
template can also be provided using stackTraceElementTemplate
and setStackTraceElementTemplateUri
layout configuration parameters. The template to be employed is determined
in the following order:
- elementTemplate provided in the resolver configuration
- stackTraceElementTemplate parameter from layout configuration (the default is populated from log4j.layout.jsonTemplate.stackTraceElementTemplate system property)
- stackTraceElementTemplateUri parameter from layout configuration (the default is populated from log4j.layout.jsonTemplate.stackTraceElementTemplateUri system property)
See StackTraceElementResolver
for the list of available resolvers in a stack trace element template.
Examples
Resolve logEvent.getThrown().getClass().getCanonicalName():{ "$resolver": "exception", "field": "className" }Resolve the stack trace into a list of StackTraceElement objects:
{ "$resolver": "exception", "field": "stackTrace" }Resolve the stack trace into a string field:
{ "$resolver": "exception", "field": "stackTrace", "stackTrace": { "stringified": true } }Resolve the stack trace into a string field such that the content will be truncated after the given point matcher:
{ "$resolver": "exception", "field": "stackTrace", "stackTrace": { "stringified": { "truncation": { "suffix": ">", "pointMatcherStrings": ["at javax.servlet.http.HttpServlet.service"] } } } }Resolve the stack trace into an object described by the provided stack trace element template:
{ "$resolver": "exception", "field": "stackTrace", "stackTrace": { "elementTemplate": { "class": { "$resolver": "stackTraceElement", "field": "className" }, "method": { "$resolver": "stackTraceElement", "field": "methodName" }, "file": { "$resolver": "stackTraceElement", "field": "fileName" }, "line": { "$resolver": "stackTraceElement", "field": "lineNumber" } } } }
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final EventResolver
private static final Logger
private static final EventResolver
private static final Map
<String, StackTraceElementResolverFactory> private final boolean
-
Constructor Summary
ConstructorsConstructorDescriptionExceptionResolver
(EventResolverContext context, TemplateResolverConfig config) -
Method Summary
Modifier and TypeMethodDescriptionprivate EventResolver
(package private) EventResolver
createInternalResolver
(EventResolverContext context, TemplateResolverConfig config) private EventResolver
private static TemplateResolver
<StackTraceElement> createStackTraceElementResolver
(EventResolverContext context, TemplateResolverConfig config) private EventResolver
createStackTraceObjectResolver
(EventResolverContext context, TemplateResolverConfig config) private EventResolver
createStackTraceResolver
(EventResolverContext context, TemplateResolverConfig config) private EventResolver
createStackTraceStringResolver
(EventResolverContext context, TemplateResolverConfig config) (package private) Throwable
extractThrowable
(LogEvent logEvent) private static String
(package private) static String
getName()
boolean
Indicates if the resolver if applicable at all.boolean
isResolvable
(LogEvent logEvent) Indicates if the resolver if applicable for the givenvalue
.private static boolean
private static String
readTruncationSuffix
(EventResolverContext context, TemplateResolverConfig config) void
resolve
(LogEvent logEvent, JsonWriter jsonWriter) Resolves the givenvalue
using the providedJsonWriter
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.logging.log4j.layout.template.json.resolver.TemplateResolver
isFlattening, resolve
-
Field Details
-
LOGGER
-
NULL_RESOLVER
-
stackTraceEnabled
private final boolean stackTraceEnabled -
internalResolver
-
STACK_TRACE_ELEMENT_RESOLVER_FACTORY_BY_NAME
private static final Map<String,StackTraceElementResolverFactory> STACK_TRACE_ELEMENT_RESOLVER_FACTORY_BY_NAME
-
-
Constructor Details
-
ExceptionResolver
ExceptionResolver(EventResolverContext context, TemplateResolverConfig config)
-
-
Method Details
-
createInternalResolver
-
createClassNameResolver
-
createMessageResolver
-
createStackTraceResolver
private EventResolver createStackTraceResolver(EventResolverContext context, TemplateResolverConfig config) -
isStackTraceStringified
-
createStackTraceStringResolver
private EventResolver createStackTraceStringResolver(EventResolverContext context, TemplateResolverConfig config) -
readTruncationSuffix
private static String readTruncationSuffix(EventResolverContext context, TemplateResolverConfig config) -
readTruncationPointMatcherStrings
-
readTruncationPointMatcherRegexes
-
createStackTraceObjectResolver
private EventResolver createStackTraceObjectResolver(EventResolverContext context, TemplateResolverConfig config) -
createStackTraceElementResolver
private static TemplateResolver<StackTraceElement> createStackTraceElementResolver(EventResolverContext context, TemplateResolverConfig config) -
findEffectiveStackTraceElementTemplate
private static String findEffectiveStackTraceElementTemplate(EventResolverContext context, TemplateResolverConfig config) -
extractThrowable
-
getName
-
isResolvable
public boolean isResolvable()Description copied from interface:TemplateResolver
Indicates if the resolver if applicable at all.For instance, the source line resolver can be short-circuited using this check if the location information is disabled in the layout configuration.
- Specified by:
isResolvable
in interfaceTemplateResolver<LogEvent>
-
isResolvable
Description copied from interface:TemplateResolver
Indicates if the resolver if applicable for the givenvalue
.For instance, the stack trace resolver can be short-circuited using this check if the stack traces are disabled in the layout configuration.
- Specified by:
isResolvable
in interfaceTemplateResolver<LogEvent>
-
resolve
Description copied from interface:TemplateResolver
Resolves the givenvalue
using the providedJsonWriter
.- Specified by:
resolve
in interfaceTemplateResolver<LogEvent>
-