public class LoggingHandler extends HandlerA logging handler that outputs logs generated with java.util.logging.Logger to Cloud Logging.
Java logging levels (see java.util.logging.Level) are mapped to the following Google Cloud Logging severities:
| Java Level | Cloud Logging Severity |
|---|---|
| SEVERE | ERROR |
| WARNING | WARNING |
| INFO | INFO |
| CONFIG | INFO |
| FINE | DEBUG |
| FINER | DEBUG |
| FINEST | DEBUG |
Original Java logging levels are added as labels (with levelName and
levelValue keys, respectively) to the corresponding Cloud Logging LogEntry. You can read
entry labels using LogEntry#getLabels(). To use logging levels that correspond to Cloud
Logging severities you can use LoggingLevel.
Configuration: By default each LoggingHandler is initialized using the
following LogManager configuration properties (that you can set in the
logging.properties file). If properties are not defined (or have invalid values) then the
specified default values are used.
com.google.cloud.logging.LoggingHandler.logthe log name (defaults tojava.log).com.google.cloud.logging.LoggingHandler.levelspecifies the default level for the handler (defaults toLevel.INFO).com.google.cloud.logging.LoggingHandler.filterspecifies the name of a Filter class to use (defaults to no filter).com.google.cloud.logging.LoggingHandler.formatterspecifies the name of a Formatter class to use (defaults to SimpleFormatter).com.google.cloud.logging.LoggingHandler.flushLevelspecifies the flush log level. When a log with this level is published, logs are transmitted to the Cloud Logging service (defaults to LoggingLevel#ERROR).com.google.cloud.logging.LoggingHandler.enhancersspecifies a comma separated list of LoggingEnhancer classes. This handler will call each enhancer list whenever it builds a LogEntry instance (defaults to empty list).com.google.cloud.logging.LoggingHandler.resourceTypethe type name to use when creating the default MonitoredResource (defaults to auto-detected resource type, else "global").com.google.cloud.logging.Synchronicitythe synchronicity of the write method to use to write logs to the Cloud Logging service (defaults to Synchronicity#ASYNC).
To add a LoggingHandler to an existing Logger and be sure to avoid infinite
recursion when logging, use the #addHandler(Logger, LoggingHandler) method. Alternatively
you can add the handler via logging.properties. For example using the following line:
com.example.mypackage.handlers=com.google.cloud.logging.LoggingHandler
Constructors
LoggingHandler()
public LoggingHandler()Creates an handler that publishes messages to Cloud Logging.
LoggingHandler(String log)
public LoggingHandler(String log)Creates a handler that publishes messages to Cloud Logging.
| Name | Description |
| log | Stringthe name of the log to which log entries are written |
LoggingHandler(String log, LoggingOptions options)
public LoggingHandler(String log, LoggingOptions options)Creates a handler that publishes messages to Cloud Logging.
| Name | Description |
| log | Stringthe name of the log to which log entries are written |
| options | LoggingOptionsoptions for the Cloud Logging service |
LoggingHandler(String log, LoggingOptions options, MonitoredResource monitoredResource)
public LoggingHandler(String log, LoggingOptions options, MonitoredResource monitoredResource)Creates a handler that publishes messages to Cloud Logging.
| Name | Description |
| log | Stringthe name of the log to which log entries are written |
| options | LoggingOptionsoptions for the Cloud Logging service |
| monitoredResource | com.google.cloud.MonitoredResourcethe monitored resource to which log entries refer. If it is null then a default resource is created based on the project ID and deployment environment. |
LoggingHandler(String log, LoggingOptions options, MonitoredResource monitoredResource, List<LoggingEnhancer> enhancers)
public LoggingHandler(String log, LoggingOptions options, MonitoredResource monitoredResource, List<LoggingEnhancer> enhancers)Creates a handler that publishes messages to Cloud Logging.
| Name | Description |
| log | Stringthe name of the log to which log entries are written |
| options | LoggingOptionsoptions for the Cloud Logging service |
| monitoredResource | com.google.cloud.MonitoredResourcethe monitored resource to which log entries refer. If it is null then a default resource is created based on the project ID and deployment environment. |
| enhancers | List<LoggingEnhancer>List of LoggingEnhancer instances used to enhance anyLogEntry instances built by this handler. |
LoggingHandler(String log, LoggingOptions options, MonitoredResource monitoredResource, List<LoggingEnhancer> enhancers, LogDestinationName destination)
public LoggingHandler(String log, LoggingOptions options, MonitoredResource monitoredResource, List<LoggingEnhancer> enhancers, LogDestinationName destination)Creates a handler that publishes messages to Cloud Logging.
| Name | Description |
| log | Stringthe name of the log to which log entries are written |
| options | LoggingOptionsoptions for the Cloud Logging service |
| monitoredResource | com.google.cloud.MonitoredResourcethe monitored resource to which log entries refer. If it is null then a default resource is created based on the project ID and deployment environment. |
| enhancers | List<LoggingEnhancer>List of LoggingEnhancer instances used to enhance anyLogEntry instances built by this handler. |
| destination | LogDestinationNamethe log destination LogDestinationName (see 'logName' parameter in https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) |
Methods
addHandler(Logger logger, LoggingHandler handler)
public static void addHandler(Logger logger, LoggingHandler handler)Adds the provided LoggingHandler to logger. Use this method to register Cloud
Logging handlers instead of Logger#addHandler(Handler) to avoid infinite recursion when
logging.
| Name | Description |
| logger | Logger |
| handler | LoggingHandler |
close()
public synchronized void close()Closes the handler and the associated Logging object.
| Type | Description |
| SecurityException |
flush()
public void flush()getFlushLevel()
public Level getFlushLevel()Get the flush log level.
| Type | Description |
| Level |
getSynchronicity()
public Synchronicity getSynchronicity()Get the flush log level.
| Type | Description |
| Synchronicity |
publish(LogRecord record)
public void publish(LogRecord record)| Name | Description |
| record | LogRecord |
setFlushLevel(Level flushLevel)
public void setFlushLevel(Level flushLevel)Sets minimum logging level to log immediately and flush any pending writes.
| Name | Description |
| flushLevel | Levelminimum log level to trigger flush |
setSynchronicity(Synchronicity synchronicity)
public void setSynchronicity(Synchronicity synchronicity)Sets synchronicity of logging writes. By default, writes are asynchronous.
| Name | Description |
| synchronicity | SynchronicitySynchronicity |