Index (Spring Framework on Google Cloud Module - Stackdriver Logging 6.1.1 API)

A C E F G I J L M P R S T X
All Classes and Interfaces|All Packages|Constant Field Values

A

addInterceptors(InterceptorRegistry) - Method in class com.google.cloud.spring.logging.LoggingWebMvcConfigurer
addLoggingEventEnhancer(String) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: Add additional logging enhancers that implement JsonLoggingEventEnhancer.
afterCompletion(HttpServletRequest, HttpServletResponse, Object, Exception) - Method in class com.google.cloud.spring.logging.TraceIdLoggingWebMvcInterceptor

C

CloudTraceIdExtractor - Class in com.google.cloud.spring.logging.extractors: Extracts trace IDs from HTTP requests using the x-cloud-trace-context header.
CloudTraceIdExtractor() - Constructor for class com.google.cloud.spring.logging.extractors.CloudTraceIdExtractor
com.google.cloud.spring.logging - package com.google.cloud.spring.logging
com.google.cloud.spring.logging.aot - package com.google.cloud.spring.logging.aot
com.google.cloud.spring.logging.extensions - package com.google.cloud.spring.logging.extensions
com.google.cloud.spring.logging.extractors - package com.google.cloud.spring.logging.extractors: Auto-configuration for Spring Cloud GCP Logging module's request trace ID extractors.
composeFullTraceName(String, String) - Static method in interface com.google.cloud.spring.logging.StackdriverTraceConstants: Composes the full trace name as expected by the Google Developers Console log viewer, to enable trace correlation with log entries.

E

enhanceJsonLogEntry(Map<String, Object>, ILoggingEvent) - Method in class com.google.cloud.spring.logging.extensions.LogstashLoggingEventEnhancer
enhanceJsonLogEntry(Map<String, Object>, ILoggingEvent) - Method in interface com.google.cloud.spring.logging.JsonLoggingEventEnhancer: Add additional JSON data to the JSON log entry, based on the ILoggingEvent.
enhanceLogEntry(LogEntry.Builder) - Method in class com.google.cloud.spring.logging.TraceIdLoggingEnhancer: Set the trace and span ID fields of the log entry to the current one.
enhanceLogEntry(LogEntry.Builder, ILoggingEvent) - Method in class com.google.cloud.spring.logging.extensions.LogstashLoggingEventEnhancer
enhanceLogEntry(LogEntry.Builder, ILoggingEvent) - Method in class com.google.cloud.spring.logging.TraceIdLoggingEnhancer: See: TraceIdLoggingEnhancer.enhanceLogEntry(LogEntry.Builder) This method adds support for AsyncAppender when retrieving MDC properties.
extractTraceIdFromRequest(HttpServletRequest) - Method in class com.google.cloud.spring.logging.extractors.CloudTraceIdExtractor
extractTraceIdFromRequest(HttpServletRequest) - Method in interface com.google.cloud.spring.logging.extractors.TraceIdExtractor: Extract trace ID from the HTTP request.

F

formatTraceId(String) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout

G

getCurrentTraceId() - Static method in class com.google.cloud.spring.logging.TraceIdLoggingEnhancer: Get the current trace id.
getLoggingOptions() - Method in class com.google.cloud.spring.logging.LoggingAppender: Wraps LoggingAppender.getLoggingOptions() to add UserAgentHeaderProvider configuration, so that usage can be properly attributed to Spring Cloud GCP.
getProjectId() - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: Get the project id.
getService() - Method in class com.google.cloud.spring.logging.StackdriverErrorReportingServiceContext
getSpanIdMdcField() - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: Get the MDC field name for span id.
getTraceIdExtractor() - Method in class com.google.cloud.spring.logging.TraceIdLoggingWebMvcInterceptor
getTraceIdMdcField() - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: Get the MDC filed name for trace id.
getVersion() - Method in class com.google.cloud.spring.logging.StackdriverErrorReportingServiceContext

I

isIncludeExceptionInMessage() - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: check if there is an included exception in the message.
isIncludeSpanId() - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: check if the span id is included.
isIncludeTraceId() - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: check if the trace id is included.

J

JsonLoggingEventEnhancer - Interface in com.google.cloud.spring.logging: This interface allows users to write additional JSON record the JSON log layout.

L

LoggingAppender - Class in com.google.cloud.spring.logging: A Google Cloud Java Logback LoggingAppender wrapper that configures it for Spring Cloud GCP.
LoggingAppender() - Constructor for class com.google.cloud.spring.logging.LoggingAppender
LoggingRuntimeHints - Class in com.google.cloud.spring.logging.aot
LoggingRuntimeHints() - Constructor for class com.google.cloud.spring.logging.aot.LoggingRuntimeHints
LoggingWebMvcConfigurer - Class in com.google.cloud.spring.logging: MVC Adapter that adds the TraceIdLoggingWebMvcInterceptor.
LoggingWebMvcConfigurer(TraceIdLoggingWebMvcInterceptor, GcpProjectIdProvider) - Constructor for class com.google.cloud.spring.logging.LoggingWebMvcConfigurer: Constructor that accepts an TraceIdLoggingWebMvcInterceptor.
LogstashLoggingEventEnhancer - Class in com.google.cloud.spring.logging.extensions: Logging enhancer which adds Logstash markers to Logging API calls and JSON log entries.
LogstashLoggingEventEnhancer() - Constructor for class com.google.cloud.spring.logging.extensions.LogstashLoggingEventEnhancer

M

MDC_FIELD_SPAN_EXPORT - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The name of the MDC parameter Micrometer is storing the span export information at.
MDC_FIELD_SPAN_ID - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The name of the MDC parameter Micrometer is storing the span id at.
MDC_FIELD_TRACE_ID - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The name of the MDC parameter Micrometer is storing the trace id at.

P

preHandle(HttpServletRequest, HttpServletResponse, Object) - Method in class com.google.cloud.spring.logging.TraceIdLoggingWebMvcInterceptor

R

registerHints(RuntimeHints, ClassLoader) - Method in class com.google.cloud.spring.logging.aot.LoggingRuntimeHints

S

SERVICE_CONTEXT_ATTRIBUTE - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The JSON field name for the service context.
setCurrentTraceId(String) - Static method in class com.google.cloud.spring.logging.TraceIdLoggingEnhancer: Sets or removes the current trace ID.
setCustomJson(String) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: set custom json data to include in log output.
setIncludeExceptionInMessage(boolean) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: set whether the exception is included in the message.
setIncludeSpanId(boolean) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: set whether the span id is included.
setIncludeTraceId(boolean) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: set whether the trace id is included.
setProjectId(String) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: set the project id.
setService(String) - Method in class com.google.cloud.spring.logging.StackdriverErrorReportingServiceContext
setServiceContext(StackdriverErrorReportingServiceContext) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: set the service context for stackdriver.
setSpanIdMdcField(String) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: Set the MDC field name for span id.
setTraceIdMdcField(String) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: Set the MDC filed name for trace id.
setVersion(String) - Method in class com.google.cloud.spring.logging.StackdriverErrorReportingServiceContext
SEVERITY_ATTRIBUTE - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The JSON field name for the log level (severity).
SPAN_ID_ATTRIBUTE - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The JSON field name for the span-id.
StackdriverErrorReportingServiceContext - Class in com.google.cloud.spring.logging: This class provides the service context data for stackdriver error reporting.
StackdriverErrorReportingServiceContext() - Constructor for class com.google.cloud.spring.logging.StackdriverErrorReportingServiceContext
StackdriverErrorReportingServiceContext(String, String) - Constructor for class com.google.cloud.spring.logging.StackdriverErrorReportingServiceContext
StackdriverJsonLayout - Class in com.google.cloud.spring.logging: This class provides a JSON layout for a Logback appender compatible to the Stackdriver log format.
StackdriverJsonLayout() - Constructor for class com.google.cloud.spring.logging.StackdriverJsonLayout: creates a layout for a Logback appender compatible to the Stackdriver log format.
StackdriverTraceConstants - Interface in com.google.cloud.spring.logging: Constants for Stackdriver Trace.
start() - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout

T

TIMESTAMP_NANOS_ATTRIBUTE - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The JSON field name for the nanos of the timestamp.
TIMESTAMP_SECONDS_ATTRIBUTE - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The JSON field name for the seconds of the timestamp.
toJsonMap(ILoggingEvent) - Method in class com.google.cloud.spring.logging.StackdriverJsonLayout: Convert a logging event into a Map.
TRACE_ID_ATTRIBUTE - Static variable in interface com.google.cloud.spring.logging.StackdriverTraceConstants: The JSON field name for the trace-id.
TraceIdExtractor - Interface in com.google.cloud.spring.logging.extractors: An extractor that can provide a trace ID from an HTTP request.
TraceIdLoggingEnhancer - Class in com.google.cloud.spring.logging: Adds the trace ID and span ID to the logging entry, in its correct format to be displayed in the Logs viewer.
TraceIdLoggingEnhancer() - Constructor for class com.google.cloud.spring.logging.TraceIdLoggingEnhancer
TraceIdLoggingWebMvcInterceptor - Class in com.google.cloud.spring.logging: HandlerInterceptor that extracts the request trace ID from the "x-cloud-trace-context" HTTP header and stores it in a thread-local using TraceIdLoggingEnhancer.setCurrentTraceId(java.lang.String).
TraceIdLoggingWebMvcInterceptor(TraceIdExtractor) - Constructor for class com.google.cloud.spring.logging.TraceIdLoggingWebMvcInterceptor

X

X_CLOUD_TRACE_HEADER - Static variable in class com.google.cloud.spring.logging.extractors.CloudTraceIdExtractor: The name of the header that contains the trace id.

A C E F G I J L M P R S T X
All Classes and Interfaces|All Packages|Constant Field Values