Package com.google.api.gax.logging

Class LoggingUtils

java.lang.Object

com.google.api.gax.logging.LoggingUtils

@InternalApi
public class LoggingUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoggingUtils.ThrowingRunnable

Constructor Summary

Constructors

Constructor	Description
LoggingUtils()

Method Summary

Modifier and Type	Method	Description
static void	executeWithTryCatch(LoggingUtils.ThrowingRunnable action)
static boolean	isLoggingEnabled()	Returns whether client-side logging is enabled.
static void	logActionableError(Map<String,Object> logContext, LoggerProvider loggerProvider, String message)	Logs an actionable error message with structured context at a specific log level.
static <RespT> void	logRequest(RespT message, LogData.Builder logDataBuilder, LoggerProvider loggerProvider)	Log request based on logging level configured
static void	logResponse(String status, LogData.Builder logDataBuilder, LoggerProvider loggerProvider)	Log response based on logging level configured
static void	recordResponseHeaders(Map<String,String> headers, LogData.Builder logDataBuilder, LoggerProvider loggerProvider)	Sets logDataBuilder with response headers based on logging level
static <RespT> void	recordResponsePayload(RespT message, LogData.Builder logDataBuilder, LoggerProvider loggerProvider)	Sets logDataBuilder with respond payload based on logging level
static void	recordServiceRpcAndRequestHeaders(String serviceName, String rpcName, String endpoint, Map<String,String> requestHeaders, LogData.Builder logDataBuilder, LoggerProvider loggerProvider)	Sets logDataBuilder with service name, rpc name, endpoint and request headers based on logging level

Methods inherited from class java.lang.Object

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

Constructor Details

LoggingUtils

public LoggingUtils()

Method Details

isLoggingEnabled

public static boolean isLoggingEnabled()

Returns whether client-side logging is enabled.

Returns:

true if logging is enabled, false otherwise.

recordServiceRpcAndRequestHeaders

public static void recordServiceRpcAndRequestHeaders(String serviceName,
 String rpcName,
 String endpoint,
 Map<String,String> requestHeaders,
 LogData.Builder logDataBuilder,
 LoggerProvider loggerProvider)

Sets logDataBuilder with service name, rpc name, endpoint and request headers based on logging level

Parameters:

serviceName -

rpcName -

endpoint -

requestHeaders -

logDataBuilder -

loggerProvider -

recordResponseHeaders

public static void recordResponseHeaders(Map<String,String> headers,
 LogData.Builder logDataBuilder,
 LoggerProvider loggerProvider)

Sets logDataBuilder with response headers based on logging level

Parameters:

headers -

logDataBuilder -

loggerProvider -

recordResponsePayload

public static <RespT> void recordResponsePayload(RespT message,
 LogData.Builder logDataBuilder,
 LoggerProvider loggerProvider)

Sets logDataBuilder with respond payload based on logging level

Type Parameters:

RespT -

Parameters:

message -

logDataBuilder -

loggerProvider -

logResponse

public static void logResponse(String status,
 LogData.Builder logDataBuilder,
 LoggerProvider loggerProvider)

Log response based on logging level configured

Parameters:

status -

logDataBuilder -

loggerProvider -

logRequest

public static <RespT> void logRequest(RespT message,
 LogData.Builder logDataBuilder,
 LoggerProvider loggerProvider)

Log request based on logging level configured

Type Parameters:

RespT -

Parameters:

message -

logDataBuilder -

loggerProvider -

logActionableError

public static void logActionableError(Map<String,Object> logContext,
 LoggerProvider loggerProvider,
 String message)

Logs an actionable error message with structured context at a specific log level.

Parameters:

logContext - A map containing the structured logging context (e.g., RPC service, method, error details).

loggerProvider - The provider used to obtain the logger.

message - The human-readable error message.

executeWithTryCatch

public static void executeWithTryCatch(LoggingUtils.ThrowingRunnable action)