Package org.glassfish.jersey.logging
Class LoggingFeature
java.lang.Object
org.glassfish.jersey.logging.LoggingFeature
- All Implemented Interfaces:
Feature
This feature enables logging request and/or response on client-side and/or server-side depending
on the context's
RuntimeType
.
The feature may be register programmatically like other features by calling any of Configurable
register(...)
method, i.e. Configurable.register(Class)
or by setting any of the
configuration property listed bellow.
Common configurable properties applies for both client and server and are following:
LOGGING_FEATURE_LOGGER_NAME
LOGGING_FEATURE_LOGGER_LEVEL
LOGGING_FEATURE_VERBOSITY
LOGGING_FEATURE_MAX_ENTITY_SIZE
LOGGING_FEATURE_SEPARATOR
LOGGING_FEATURE_REDACT_HEADERS
If any of the configuration value is not set, following default values are applied:
- logger name:
org.glassfish.jersey.logging.LoggingFeature
- logger level:
Level.FINE
- verbosity:
LoggingFeature.Verbosity.PAYLOAD_TEXT
- maximum entity size: 8192
- line separator:
DEFAULT_SEPARATOR
- redact headers: "Authorization"
Server configurable properties:
Client configurable properties:- Since:
- 2.23
- Author:
- Ondrej Kosatka
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Builder class for logging feature configuration.static enum
Verbosity
determines how detailed message will be logged. -
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Default logger level which will be used for logging request and response messages.static final String
Default logger name to log request and response messages.static final int
Default maximum entity bytes to be logged.static final String
Default headers to be redacted.static final String
Default separator for entity logging.static final LoggingFeature.Verbosity
Default verbosity for entity logging.static final String
Common logger level property.static final String
Client logger level property.static final String
Server logger level property.static final String
Common logger name property.static final String
Client logger name property.static final String
Server logger name property.static final String
Common property for configuring a maximum number of bytes of entity to be logged.static final String
Client property for configuring a maximum number of bytes of entity to be logged.static final String
Server property for configuring a maximum number of bytes of entity to be logged.static final String
Common property for configuring headers to be redacted.static final String
Client property for configuring headers to be redacted.static final String
Server property for configuring headers to be redacted.static final String
Common property for configuring logging separator.static final String
Client property for logging separator.static final String
Server property for configuring separator.static final String
Common property for configuring a verbosity of entity.static final String
Client property for configuring a verbosity of entity.static final String
Server property for configuring a verbosity of entity. -
Constructor Summary
ConstructorDescriptionCreates the feature with default values.LoggingFeature
(Logger logger) Creates the feature with custom logger.LoggingFeature
(Logger logger, Integer maxEntitySize) Creates the feature with custom logger and maximum number of bytes of entity to log.LoggingFeature
(Logger logger, Level level, LoggingFeature.Verbosity verbosity, Integer maxEntitySize) Creates the feature with custom logger, it's level, message verbosity and maximum number of bytes of entity to log.LoggingFeature
(Logger logger, LoggingFeature.Verbosity verbosity) Creates the feature with custom logger and verbosity.Constructor based on logging feature builder. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder method to create LoggingFeature with required settingsboolean
configure
(FeatureContext context)
-
Field Details
-
DEFAULT_LOGGER_NAME
Default logger name to log request and response messages. -
DEFAULT_LOGGER_LEVEL
Default logger level which will be used for logging request and response messages. -
DEFAULT_MAX_ENTITY_SIZE
public static final int DEFAULT_MAX_ENTITY_SIZEDefault maximum entity bytes to be logged.- See Also:
-
DEFAULT_VERBOSITY
Default verbosity for entity logging. SeeLoggingFeature.Verbosity
. -
DEFAULT_SEPARATOR
Default separator for entity logging.- See Also:
-
DEFAULT_REDACT_HEADERS
Default headers to be redacted. If multiple, separate each header with a semicolon.- See Also:
-
LOGGING_FEATURE_LOGGER_NAME
Common logger name property.- See Also:
-
LOGGING_FEATURE_LOGGER_LEVEL
Common logger level property.- See Also:
-
LOGGING_FEATURE_VERBOSITY
Common property for configuring a verbosity of entity.- See Also:
-
LOGGING_FEATURE_MAX_ENTITY_SIZE
Common property for configuring a maximum number of bytes of entity to be logged.- See Also:
-
LOGGING_FEATURE_SEPARATOR
Common property for configuring logging separator.- See Also:
-
LOGGING_FEATURE_REDACT_HEADERS
Common property for configuring headers to be redacted. The headers are semicolon-separated.- See Also:
-
LOGGING_FEATURE_LOGGER_NAME_SERVER
Server logger name property.- See Also:
-
LOGGING_FEATURE_LOGGER_LEVEL_SERVER
Server logger level property.- See Also:
-
LOGGING_FEATURE_VERBOSITY_SERVER
Server property for configuring a verbosity of entity.- See Also:
-
LOGGING_FEATURE_MAX_ENTITY_SIZE_SERVER
Server property for configuring a maximum number of bytes of entity to be logged.- See Also:
-
LOGGING_FEATURE_SEPARATOR_SERVER
Server property for configuring separator.- See Also:
-
LOGGING_FEATURE_REDACT_HEADERS_SERVER
Server property for configuring headers to be redacted. The headers are semicolon-separated.- See Also:
-
LOGGING_FEATURE_LOGGER_NAME_CLIENT
Client logger name property.- See Also:
-
LOGGING_FEATURE_LOGGER_LEVEL_CLIENT
Client logger level property.- See Also:
-
LOGGING_FEATURE_VERBOSITY_CLIENT
Client property for configuring a verbosity of entity.- See Also:
-
LOGGING_FEATURE_MAX_ENTITY_SIZE_CLIENT
Client property for configuring a maximum number of bytes of entity to be logged.- See Also:
-
LOGGING_FEATURE_SEPARATOR_CLIENT
Client property for logging separator.- See Also:
-
LOGGING_FEATURE_REDACT_HEADERS_CLIENT
Client property for configuring headers to be redacted. The headers are semicolon-separated.- See Also:
-
-
Constructor Details
-
LoggingFeature
public LoggingFeature()Creates the feature with default values. -
LoggingFeature
Creates the feature with custom logger.- Parameters:
logger
- the logger to log requests and responses.
-
LoggingFeature
Creates the feature with custom logger and verbosity.- Parameters:
logger
- the logger to log requests and responses.verbosity
- verbosity of logged messages. SeeLoggingFeature.Verbosity
.
-
LoggingFeature
Creates the feature with custom logger and maximum number of bytes of entity to log.- Parameters:
logger
- the logger to log requests and responses.maxEntitySize
- maximum number of entity bytes to be logged (and buffered) - if the entity is larger, logging filter will print (and buffer in memory) only the specified number of bytes and print "...more..." string at the end. Negative values are interpreted as zero.
-
LoggingFeature
public LoggingFeature(Logger logger, Level level, LoggingFeature.Verbosity verbosity, Integer maxEntitySize) Creates the feature with custom logger, it's level, message verbosity and maximum number of bytes of entity to log.- Parameters:
logger
- the logger to log requests and responses.level
- level on which the messages will be logged.verbosity
- verbosity of logged messages. SeeLoggingFeature.Verbosity
.maxEntitySize
- maximum number of entity bytes to be logged (and buffered) - if the entity is larger, logging filter will print (and buffer in memory) only the specified number of bytes and print "...more..." string at the end. Negative values are interpreted as zero.
-
LoggingFeature
Constructor based on logging feature builder. All parameters are passed through a builder instance.- Parameters:
builder
- instance of a builder with required logging feature parameters
-
-
Method Details