Package eu.mulk.quarkus.googlecloud.jsonlogging

Class Formatter

java.lang.Object

java.util.logging.Formatter

org.jboss.logmanager.ExtFormatter

eu.mulk.quarkus.googlecloud.jsonlogging.Formatter

public class Formatter
extends org.jboss.logmanager.ExtFormatter

Formats log records as JSON for consumption by Google Cloud Logging.

Meant to be used in containers running on Google Kubernetes Engine (GKE).

See Also:

• LogEntry

Constructor Summary

Constructors

Constructor	Description
Formatter(Collection<StructuredParameterProvider> parameterProviders, Collection<LabelProvider> labelProviders)	Constructs a Formatter with custom configuration.

Method Summary

Modifier and Type	Method	Description
String	format(org.jboss.logmanager.ExtLogRecord logRecord)
static Formatter	load(Collection<StructuredParameterProvider> parameterProviders, Collection<LabelProvider> labelProviders)	Constructs a Formatter with parameter and label providers supplied by ServiceLoader.

Methods inherited from class org.jboss.logmanager.ExtFormatter

format, formatMessage, formatMessageLegacy, formatMessageNone, formatMessagePrintf, isCallerCalculationRequired

Methods inherited from class java.util.logging.Formatter

getHead, getTail

Methods inherited from class java.lang.Object

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

Constructor Details

Formatter

public Formatter(Collection<StructuredParameterProvider> parameterProviders,
 Collection<LabelProvider> labelProviders)

Constructs a Formatter with custom configuration.

Note: This constructor does not automatically discover providers using the ServiceLoader mechanism. See load(java.util.Collection<eu.mulk.quarkus.googlecloud.jsonlogging.StructuredParameterProvider>, java.util.Collection<eu.mulk.quarkus.googlecloud.jsonlogging.LabelProvider>) for this case use.

Parameters:

parameterProviders - the StructuredParameterProviders to apply to each log entry.

labelProviders - the LabelProviders to apply to each log entry.

Method Details

load

public static Formatter load(Collection<StructuredParameterProvider> parameterProviders,
 Collection<LabelProvider> labelProviders)

Constructs a Formatter with parameter and label providers supplied by ServiceLoader.

In addition to the providers supplied as parameters, this factory method loads all StructuredParameterProviders and LabelProviders found through the ServiceLoader mechanism.

Parameters:

parameterProviders - the StructuredParameterProviders to apply to each log entry.

labelProviders - the LabelProviders to apply to each log entry.

Returns:

a new formatter.

format

public String format(org.jboss.logmanager.ExtLogRecord logRecord)

Specified by:

format in class org.jboss.logmanager.ExtFormatter