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 String	globalPattern
static ConfigFilterHelper.FilterParams	NO_FILTER_PARAMS

Method Summary

Modifier and Type	Method and Description
static ConfigFilterHelper	factory(ObservabilityConfig config) Creates and returns helper instance for log filtering.
boolean	isEventToBeLogged(io.grpc.observabilitylog.v1.GrpcLogRecord.EventType event) Checks if the corresponding event passed needs to be logged as per the user provided configuration.
ConfigFilterHelper.FilterParams	isMethodToBeLogged(io.grpc.MethodDescriptor<?,?> method) Checks if the corresponding service/method passed needs to be logged as per the user provided 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

globalPattern

public static final String globalPattern

See Also:

Constant Field Values

Method Detail

factory

public static ConfigFilterHelper factory(ObservabilityConfig config)

Creates and returns helper instance for log filtering.

Parameters:

config - processed ObservabilityConfig object

Returns:

helper instance for filtering

isMethodToBeLogged

public ConfigFilterHelper.FilterParams isMethodToBeLogged(io.grpc.MethodDescriptor<?,?> method)

Checks if the corresponding service/method passed needs to be logged as per the user provided configuration.

Parameters:

method - the fully qualified name of the method

Returns:

MethodFilterParams 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

isEventToBeLogged

public boolean isEventToBeLogged(io.grpc.observabilitylog.v1.GrpcLogRecord.EventType event)

Checks if the corresponding event passed needs to be logged as per the user provided configuration.

All events are logged by default if event_types is not specified or {} in configuration. If event_types is specified as [], no events will be logged. If events types is specified as a non-empty list, only the events specified in the list will be logged.

Parameters:

event - gRPC observability event

Returns:

true if event needs to be logged, false otherwise