Class LoggingUtils (2.79.0) 

public class LoggingUtils

Inheritance

java.lang.Object > LoggingUtils

Static Methods

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

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

Log request based on logging level configured

Parameters
Name Description
message RespT
logDataBuilder LogData.Builder
loggerProvider LoggerProvider

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

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

Sets logDataBuilder with respond payload based on logging level

Parameters
Name Description
message RespT
logDataBuilder LogData.Builder
loggerProvider LoggerProvider

executeWithTryCatch(LoggingUtils.ThrowingRunnable action)

public static void executeWithTryCatch(LoggingUtils.ThrowingRunnable action)
Parameter
Name Description
action LoggingUtils.ThrowingRunnable

isLoggingEnabled()

public static boolean isLoggingEnabled()

Returns whether client-side logging is enabled.

Returns
Type Description
boolean

true if logging is enabled, false otherwise.

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

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
Name Description
logContext Map<String,Object>

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

The provider used to obtain the logger.
message String

The human-readable error message.

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

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

Log response based on logging level configured

Parameters
Name Description
status String
logDataBuilder LogData.Builder
loggerProvider LoggerProvider

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

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

Sets logDataBuilder with response headers based on logging level

Parameters
Name Description
headers Map<String,String>
logDataBuilder LogData.Builder
loggerProvider LoggerProvider

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

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
Name Description
serviceName String
rpcName String
endpoint String
requestHeaders Map<String,String>
logDataBuilder LogData.Builder
loggerProvider LoggerProvider

Constructors

LoggingUtils()

public LoggingUtils()