com.google.cloud.logging.logback

Class LoggingAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

com.google.cloud.logging.logback.LoggingAppender

All Implemented Interfaces:

ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.LifeCycle

public class LoggingAppender
extends ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

Logback appender for Google Cloud Logging.

Appender configuration in logback.xml:

    <appender name="CLOUD" class="com.google.cloud.logging.logback.LoggingAppender">
         <!-- Optional: filter logs at and above this level -->
         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>INFO</level>
         </filter>

         <!-- Optional: defaults to "java.log" -->
         <log>application.log</log>

         <!-- Optional: defaults to "ERROR" -->
         <flushLevel>WARNING</flushLevel>

         <!-- Optional: auto detects on App Engine Flex, Standard, GCE and GKE, defaults to "global". See supported resource types -->
         <resourceType></resourceType>

         <!-- Optional: defaults to the default credentials of the environment -->
         <credentialsFile>/path/to/credentials/file</credentialsFile>

         <!-- Optional: add custom labels to log entries using LoggingEnhancer classes -->
         <enhancer>com.example.enhancers.TestLoggingEnhancer</enhancer>
         <enhancer>com.example.enhancers.AnotherEnhancer</enhancer>
     </appender>
 

Field Summary

Fields inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

name, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
LoggingAppender()

Method Summary

Modifier and Type	Method and Description
void	addEnhancer(String enhancerClassName) Add extra labels using classes that implement LoggingEnhancer.
void	addLoggingEventEnhancer(String enhancerClassName)
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent e)
void	flush() Flushes any pending asynchronous logging writes.
protected com.google.cloud.logging.LoggingOptions	getLoggingOptions() Gets the LoggingOptions to use for this LoggingAppender.
void	setCredentialsFile(String credentialsFile) Sets the credentials file to use to create the LoggingOptions.
void	setFlushLevel(ch.qos.logback.classic.Level flushLevel) Batched logging requests get immediately flushed for logs at or above this level.
void	setLog(String log) Sets the log filename.
void	setResourceType(String resourceType) Sets the name of the monitored resource (Optional).
void	start() Initialize and configure the cloud logging service.
void	stop()

Methods inherited from class ch.qos.logback.core.UnsynchronizedAppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Constructor Detail

LoggingAppender

public LoggingAppender()

Method Detail

setFlushLevel

public void setFlushLevel(ch.qos.logback.classic.Level flushLevel)

Batched logging requests get immediately flushed for logs at or above this level.

Defaults to Error if not set.

Parameters:

flushLevel - Logback log level

setLog

public void setLog(String log)

Sets the log filename.

Parameters:

log - filename

setResourceType

public void setResourceType(String resourceType)

Sets the name of the monitored resource (Optional).

Must be a supported resource type. gae_app, gce_instance and container are auto-detected.

Defaults to "global"

Parameters:

resourceType - name of the monitored resource

setCredentialsFile

public void setCredentialsFile(String credentialsFile)

Sets the credentials file to use to create the LoggingOptions. The credentials returned by GoogleCredentials.getApplicationDefault() will be used if no custom credentials file has been set.

Parameters:

credentialsFile - The credentials file to use.

addEnhancer

public void addEnhancer(String enhancerClassName)

Add extra labels using classes that implement LoggingEnhancer.

addLoggingEventEnhancer

public void addLoggingEventEnhancer(String enhancerClassName)

start

public void start()

Initialize and configure the cloud logging service.

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

append

protected void append(ch.qos.logback.classic.spi.ILoggingEvent e)

Specified by:

append in class ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

stop

public void stop()

Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

stop in class ch.qos.logback.core.UnsynchronizedAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

flush

public void flush()

Flushes any pending asynchronous logging writes.

getLoggingOptions

protected com.google.cloud.logging.LoggingOptions getLoggingOptions()

Gets the LoggingOptions to use for this LoggingAppender.