io.grpc.gcp.observability.interceptors

Class ConfigFilterHelper

java.lang.Object

io.grpc.gcp.observability.interceptors.ConfigFilterHelper

@Internal
public class ConfigFilterHelper
extends Object

Parses gRPC GcpObservability configuration filters for interceptors usage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigFilterHelper.FilterParams Class containing results for method/service filter information, such as flag for logging method/service and payload limits to be used for filtering.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigFilterHelper.FilterParams	NO_FILTER_PARAMS

Method Summary

Modifier and Type	Method and Description
static ConfigFilterHelper	getInstance(ObservabilityConfig config) Creates and returns helper instance for log filtering.
ConfigFilterHelper.FilterParams	logRpcMethod(String fullMethodName, boolean client) Checks if the corresponding service/method passed needs to be logged according to user provided observability configuration.

Methods inherited from class java.lang.Object

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

Field Detail

NO_FILTER_PARAMS

public static final ConfigFilterHelper.FilterParams NO_FILTER_PARAMS

Method Detail

getInstance

public static ConfigFilterHelper getInstance(ObservabilityConfig config)

Creates and returns helper instance for log filtering.

Parameters:

config - processed ObservabilityConfig object

Returns:

helper instance for filtering

logRpcMethod

public ConfigFilterHelper.FilterParams logRpcMethod(String fullMethodName,
                                                    boolean client)

Checks if the corresponding service/method passed needs to be logged according to user provided observability configuration. Filters are evaluated in text order, first match is used.

Parameters:

fullMethodName - the fully qualified name of the method

client - set to true if method being checked is a client method; false otherwise

Returns:

FilterParams object 1. specifies if the corresponding method needs to be logged (log field will be set to true) 2. values of payload limits retrieved from configuration