com.google.cloud.spring.logging

Class TraceIdLoggingEnhancer

java.lang.Object

com.google.cloud.spring.logging.TraceIdLoggingEnhancer

All Implemented Interfaces:

LoggingEventEnhancer, LoggingEnhancer

public class TraceIdLoggingEnhancer
extends Object
implements LoggingEnhancer, LoggingEventEnhancer

Adds the trace ID and span ID to the logging entry, in its correct format to be displayed in the Logs viewer.

Constructor Summary

Constructors

Constructor and Description
TraceIdLoggingEnhancer()

Method Summary

Modifier and Type	Method and Description
void	enhanceLogEntry(LogEntry.Builder builder) Set the trace and span ID fields of the log entry to the current one.
void	enhanceLogEntry(LogEntry.Builder builder, ch.qos.logback.classic.spi.ILoggingEvent e) See: enhanceLogEntry(LogEntry.Builder) This method adds support for AsyncAppender when retrieving MDC properties.
static String	getCurrentTraceId() Get the current trace id.
static void	setCurrentTraceId(String id) Sets or removes the current trace ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraceIdLoggingEnhancer

public TraceIdLoggingEnhancer()

Method Detail

setCurrentTraceId

public static void setCurrentTraceId(String id)

Sets or removes the current trace ID.

Parameters:

id - current ID or null to unset

getCurrentTraceId

public static String getCurrentTraceId()

Get the current trace id.

Returns:

the trace ID stored through setCurrentTraceId(String)

enhanceLogEntry

public void enhanceLogEntry(LogEntry.Builder builder)

Set the trace and span ID fields of the log entry to the current one.

The current trace ID is either the trace ID stored in the Mapped Diagnostic Context (MDC) under the "X-B3-TraceId" key or, if none set, the current trace ID set by setCurrentTraceId(String). The current span ID is retrieved from the MDC under the "X-B3-SpanId" key, if set.

The trace ID is set in the log entry in the "projects/[GCP_PROJECT_ID]/traces/[TRACE_ID]" format, in order to be associated to traces by the Google Cloud Console.

If an application is running on Google App Engine, the trace ID is also stored in the "appengine.googleapis.com/trace_id" field, in order to enable log correlation on the logs viewer.

Specified by:

enhanceLogEntry in interface LoggingEnhancer

Parameters:

builder - log entry builder

enhanceLogEntry

public void enhanceLogEntry(LogEntry.Builder builder,
                            ch.qos.logback.classic.spi.ILoggingEvent e)

See: enhanceLogEntry(LogEntry.Builder) This method adds support for AsyncAppender when retrieving MDC properties.

Specified by:

enhanceLogEntry in interface LoggingEventEnhancer

Parameters:

builder - log entry builder

e - logging event