Package io.vertx.ext.web.handler
Interface LoggerHandler
-
- All Superinterfaces:
Handler<RoutingContext>
,PlatformHandler
public interface LoggerHandler extends PlatformHandler
A handler which logs request information to the Vert.x logger. You should mount this handler before any handler that could fail the routing context. Logs will be produced with the appropriate severity level depending on the status code of the response. To capture the logs configure the logger in your logging configuration with the name:io.vertx.ext.web.handler.LoggerHandler
.- Author:
- Tim Fox, Paulo Lopes
-
-
Field Summary
Fields Modifier and Type Field Description static LoggerFormat
DEFAULT_FORMAT
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static LoggerHandler
create()
Create a handler with default formatstatic LoggerHandler
create(boolean immediate, LoggerFormat format)
Create a handler with he specified formatstatic LoggerHandler
create(LoggerFormat format)
Create a handler with he specified formatLoggerHandler
customFormatter(LoggerFormatter formatter)
Set the custom formatter to be used by the handler.
-
-
-
Field Detail
-
DEFAULT_FORMAT
static final LoggerFormat DEFAULT_FORMAT
-
-
Method Detail
-
create
static LoggerHandler create()
Create a handler with default format- Returns:
- the handler
-
create
static LoggerHandler create(LoggerFormat format)
Create a handler with he specified format- Parameters:
format
- the format- Returns:
- the handler
-
create
static LoggerHandler create(boolean immediate, LoggerFormat format)
Create a handler with he specified format- Parameters:
immediate
- true if logging should occur as soon as request arrivesformat
- the format- Returns:
- the handler
-
customFormatter
LoggerHandler customFormatter(LoggerFormatter formatter)
Set the custom formatter to be used by the handler.- Parameters:
formatter
- the formatter- Returns:
- the formatted log string
- Throws:
IllegalStateException
- if current format is notLoggerFormat.CUSTOM
-
-