Package org.microproxy.extras

Class HttpLogger.Builder

java.lang.Object

org.microproxy.extras.HttpLogger.Builder

Enclosing class:

HttpLogger

public static final class HttpLogger.Builder
extends Object

Configures an HttpLogger.

Method Summary

Modifier and Type	Method	Description
HttpLogger	build()	Creates the configured HTTP exchange logger.
HttpLogger.Builder	contentView(String name)	The content view to render bodies with: "auto" (the default) for the best one for each body, or a view's name, such as grpc.
HttpLogger.Builder	contentViews(ContentViews views)	At HttpLogger.Level.BODY, renders bodies through views where one applies (see contentView(java.lang.String)): protobuf and gRPC message by message, JSON indented, form data, GraphQL, msgpack.
HttpLogger.Builder	format(HttpLogger.Format format)	Readable blocks (default) or JSON lines.
HttpLogger.Builder	level(HttpLogger.Level level)	How much to log (default HttpLogger.Level.HEADERS).
HttpLogger.Builder	maxBodyBytes(int maxBodyBytes)	At HttpLogger.Level.BODY, keeps at most this many bytes of each body (and of each WebSocket frame's text); the rest is counted but not kept.
HttpLogger.Builder	only(BiPredicate<HttpRequest,FlowContext> predicate)	Logs only the exchanges whose request (as the client sent it) matches.
HttpLogger.Builder	redact(String... headerNames)	Also replaces the values of these headers (any case) with "\u2588\u2588", on both sides of the proxy.
HttpLogger.Builder	redactNothing()	Redacts nothing, not even the default headers; later redact calls add to that.
HttpLogger.Builder	redactQueryParams(String... names)	Also replaces the values of these query parameters (any case) in logged URLs.
HttpLogger.Builder	sink(Consumer<String> sink)	Where each message goes, as one string (several lines in HttpLogger.Format.TEXT).
HttpLogger.Builder	webSocketFrames(boolean log)	At HttpLogger.Level.BODY, also logs WebSocket frames after an upgrade: text frames' text (up to maxBodyBytes), other frames' sizes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

level

public HttpLogger.Builder level(HttpLogger.Level level)

How much to log (default HttpLogger.Level.HEADERS).

Parameters:

level - the amount of HTTP detail to log

Returns:

this builder

format

public HttpLogger.Builder format(HttpLogger.Format format)

Readable blocks (default) or JSON lines.

Parameters:

format - the log output format

Returns:

this builder

redact

public HttpLogger.Builder redact(String... headerNames)

Also replaces the values of these headers (any case) with "\u2588\u2588", on both sides of the proxy. HttpLogger.DEFAULT_REDACTED_HEADERS are redacted already.

Parameters:

headerNames - the header names whose values to redact

Returns:

this builder

redactQueryParams

public HttpLogger.Builder redactQueryParams(String... names)

Also replaces the values of these query parameters (any case) in logged URLs.

Parameters:

names - the query parameter names whose values to redact

Returns:

this builder

redactNothing

public HttpLogger.Builder redactNothing()

Redacts nothing, not even the default headers; later redact calls add to that.

Returns:

this builder

maxBodyBytes

public HttpLogger.Builder maxBodyBytes(int maxBodyBytes)

At HttpLogger.Level.BODY, keeps at most this many bytes of each body (and of each WebSocket frame's text); the rest is counted but not kept. Default 4096.

Parameters:

maxBodyBytes - the maximum body bytes to retain in each log entry

Returns:

this builder

only

public HttpLogger.Builder only(BiPredicate<HttpRequest,FlowContext> predicate)

Logs only the exchanges whose request (as the client sent it) matches.

Parameters:

predicate - the predicate deciding which exchanges to log

Returns:

this builder

sink

public HttpLogger.Builder sink(Consumer<String> sink)

Where each message goes, as one string (several lines in HttpLogger.Format.TEXT). Default: the System.Logger "org.microproxy.http" at INFO.

Parameters:

sink - the consumer receiving each formatted log entry

Returns:

this builder

webSocketFrames

public HttpLogger.Builder webSocketFrames(boolean log)

At HttpLogger.Level.BODY, also logs WebSocket frames after an upgrade: text frames' text (up to maxBodyBytes), other frames' sizes. Off by default, since it makes the proxy parse every frame.

Parameters:

log - whether to log WebSocket frames

Returns:

this builder

contentViews

public HttpLogger.Builder contentViews(ContentViews views)

At HttpLogger.Level.BODY, renders bodies through views where one applies (see contentView(java.lang.String)): protobuf and gRPC message by message, JSON indented, form data, GraphQL, msgpack. Bodies no view renders are shown as before. With views, gRPC's grpc-status, grpc-message and grpc-status-details-bin fields are explained at HttpLogger.Level.HEADERS and HttpLogger.Level.BODY. Off by default.

Parameters:

views - the views, such as ContentViews.defaults() or one with a schema

Returns:

this builder

contentView

public HttpLogger.Builder contentView(String name)

The content view to render bodies with: "auto" (the default) for the best one for each body, or a view's name, such as grpc. Turns content views on with ContentViews.defaults() if contentViews(org.microproxy.contentviews.ContentViews) was not called.

Parameters:

name - "auto" or a view's name

Returns:

this builder

Throws:

IllegalArgumentException - if there is no view of that name

build

public HttpLogger build()

Creates the configured HTTP exchange logger.

Returns:

the configured exchange logger