org.apache.juneau.rest.annotation

Annotation Type LoggingRule

public @interface LoggingRule

Represents a single logging rule for how to handle logging of HTTP requests/responses.

• RestContext.REST_callLoggerConfig
• RestMethodContext.RESTMETHOD_callLoggerConfig

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	codes Defines the status codes that match this rule.
String	debugOnly Specifies whether only debug requests match against this rule.
String	disabled Disables logging entirely for this rule.
String	exceptions Defines Java exceptions that match this rule.
String	level Identifies the logging level at which to log REST calls.
String	req Identifies the level of detail to log on HTTP requests.
String	res Identifies the level of detail to log on HTTP responses.
String	verbose Shortcut for specifying "long" for @LoggingRule(req) and @LoggingRule(res).

Element Detail

codes

public abstract String codes

Defines the status codes that match this rule.

Possible values:

• A single value (e.g. "404").
• A closed range of values (e.g. "400-499").
• An open range of values (e.g. "400-", "-299", ">=500").
• The value "*" to match any code. This is the default value.

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

"*"

debugOnly

public abstract String debugOnly

Specifies whether only debug requests match against this rule.

Allows you to tailor logging on debug requests.

See the @Rest(debug) annotation on details of how to enable debugging.

The possible values are (case-insensitive):

• "true - Match debug requests only.
• "false" - Match any requests.

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

"false"

disabled

public abstract String disabled

Disables logging entirely for this rule.

The possible values are (case-insensitive):

• "true - Disable logging.
• "false" (default) - Don't disable logging.
• "per-request" - Disable logging if No-Trace is set on the request.

The No-Trace setting on a request can be set by adding X-NoTrace: true to the request header. It can also be set programmatically by calling either the RestRequest.setNoTrace(Boolean) or RestResponse.setNoTrace(Boolean) methods.

Setting this value to "true" is equivalent to setting the level to "off".

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

"false"

exceptions

public abstract String exceptions

Defines Java exceptions that match this rule.

Possible values:

• A fully-qualified class name (e.g. "java.lang.StringIndexOutOfBoundsException").
• A simple class name (e.g. "StringIndexOutOfBoundsException").
• A pattern with metacharacters (e.g. "String*Exception").
• Multiple patterns separated by spaces or commas (e.g. "String*Exception, IO*Exception").

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

""

level

public abstract String level

Identifies the logging level at which to log REST calls.

See the Level class for possible values.

Values are case-insensitive.

If not specified, uses the value specified by the @Logging(level) annotation value.

Level.OFF can be used to turn off logging.

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

""

req

public abstract String req

Identifies the level of detail to log on HTTP requests.

The possible values are (case-insensitive):

• "short (default) - Just the HTTP method and URL.
• "medium" (default) - Also the URL parameters, body size, and request headers.
• "long" - Also the request body as UTF-8 and spaced-hex text (debug must be enabled).

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

"short"

res

public abstract String res

Identifies the level of detail to log on HTTP responses.

The possible values are (case-insensitive):

• "short (default) - Just the response code.
• "medium" (default) - Also the body size, response headers, and execution time.
• "long" - Also the response body as UTF-8 and spaced-hex text (debug must be enabled).

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

"short"

verbose

public abstract String verbose

Shortcut for specifying "long" for @LoggingRule(req) and @LoggingRule(res).

• Supports Default REST SVL Variables (e.g. "$L{my.localized.variable}").

• Overview > juneau-rest-server > Logging / Debugging

Default:

"false"