com.google.cloud.dataflow.sdk.runners.worker.logging

Class DataflowWorkerLoggingHandler

java.lang.Object

java.util.logging.Handler

com.google.cloud.dataflow.sdk.runners.worker.logging.DataflowWorkerLoggingHandler

public class DataflowWorkerLoggingHandler
extends Handler

Formats LogRecord into JSON format for Cloud Logging. Any exception is represented using Throwable.printStackTrace().

Constructor Summary

Constructors

Constructor and Description
DataflowWorkerLoggingHandler(OutputStream output) Constructs a handler that writes to an arbitrary output stream.
DataflowWorkerLoggingHandler(String fileName) Constructs a handler that writes to a file.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
static String	formatException(Throwable thrown) Formats the throwable as per Throwable.printStackTrace().
boolean	isLoggable(LogRecord record) Check if a LogRecord will be logged.
void	publish(LogRecord record)

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

DataflowWorkerLoggingHandler

public DataflowWorkerLoggingHandler(String fileName)
                             throws IOException

Constructs a handler that writes to a file.

Throws:

IOException

DataflowWorkerLoggingHandler

public DataflowWorkerLoggingHandler(OutputStream output)
                             throws IOException

Constructs a handler that writes to an arbitrary output stream.

Throws:

IOException

Method Detail

formatException

public static String formatException(Throwable thrown)

Formats the throwable as per Throwable.printStackTrace().

Parameters:

thrown - The throwable to format.

Returns:

A string containing the contents of Throwable.printStackTrace().

publish

public void publish(LogRecord record)

Specified by:

publish in class Handler

isLoggable

public boolean isLoggable(LogRecord record)

Check if a LogRecord will be logged.

This method checks if the LogRecord has an appropriate level and whether it satisfies any Filter. It will also return false if the handler has been closed, or the LogRecord is null.

Overrides:

isLoggable in class Handler

flush

public void flush()

Specified by:

flush in class Handler

close

public void close()

Specified by:

close in class Handler