Class FaultFilter

java.lang.Object

io.grpc.xds.FaultFilter

All Implemented Interfaces:

Filter, Filter.ClientInterceptorBuilder

final class FaultFilter
extends Object
implements Filter, Filter.ClientInterceptorBuilder

HttpFault filter implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	FaultFilter.DelayInjectedCall<ReqT,RespT>	A DelayedClientCall with a fixed delay.
private final class	FaultFilter.FailingClientCall<ReqT,RespT>	An implementation of ClientCall that fails when started.

Nested classes/interfaces inherited from interface Filter

Filter.ClientInterceptorBuilder, Filter.FilterConfig, Filter.NamedFilterConfig, Filter.ServerInterceptorBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicLong	activeFaultCounter
(package private) static final io.grpc.Metadata.Key<String>	HEADER_ABORT_GRPC_STATUS_KEY
(package private) static final io.grpc.Metadata.Key<String>	HEADER_ABORT_HTTP_STATUS_KEY
(package private) static final io.grpc.Metadata.Key<String>	HEADER_ABORT_PERCENTAGE_KEY
(package private) static final io.grpc.Metadata.Key<String>	HEADER_DELAY_KEY
(package private) static final io.grpc.Metadata.Key<String>	HEADER_DELAY_PERCENTAGE_KEY
(package private) static final FaultFilter	INSTANCE
private final ThreadSafeRandom	random
(package private) static final String	TYPE_URL

Constructor Summary

Constructors

Constructor	Description
FaultFilter(ThreadSafeRandom random, AtomicLong activeFaultCounter)

Method Summary

Modifier and Type	Method	Description
io.grpc.ClientInterceptor	buildClientInterceptor(Filter.FilterConfig config, Filter.FilterConfig overrideConfig, io.grpc.LoadBalancer.PickSubchannelArgs args, ScheduledExecutorService scheduler)
private io.grpc.Status	determineFaultAbortStatus(FaultConfig.FaultAbort faultAbort, io.grpc.Metadata headers)
private Long	determineFaultDelayNanos(FaultConfig.FaultDelay faultDelay, io.grpc.Metadata headers)
private static io.grpc.Status	getAbortStatusWithDescription(io.grpc.Status abortStatus)
private static int	getRatePerMillion(FaultConfig.FractionalPercent percent)
(package private) static ConfigOrError<FaultConfig.FaultAbort>	parseFaultAbort(FaultAbort faultAbort)
private static FaultConfig.FaultDelay	parseFaultDelay(FaultDelay faultDelay)
ConfigOrError<FaultConfig>	parseFilterConfig(com.google.protobuf.Message rawProtoMessage)	Parses the top-level filter config from raw proto message.
ConfigOrError<FaultConfig>	parseFilterConfigOverride(com.google.protobuf.Message rawProtoMessage)	Parses the per-filter override filter config from raw proto message.
private static ConfigOrError<FaultConfig>	parseHttpFault(HTTPFault httpFault)
private static FaultConfig.FractionalPercent	parsePercent(FractionalPercent proto)
String[]	typeUrls()	The proto message types supported by this filter.

Methods inherited from class Object

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

Field Details

INSTANCE

static final FaultFilter INSTANCE

HEADER_DELAY_KEY

static final io.grpc.Metadata.Key<String> HEADER_DELAY_KEY

HEADER_DELAY_PERCENTAGE_KEY

static final io.grpc.Metadata.Key<String> HEADER_DELAY_PERCENTAGE_KEY

HEADER_ABORT_HTTP_STATUS_KEY

static final io.grpc.Metadata.Key<String> HEADER_ABORT_HTTP_STATUS_KEY

HEADER_ABORT_GRPC_STATUS_KEY

static final io.grpc.Metadata.Key<String> HEADER_ABORT_GRPC_STATUS_KEY

HEADER_ABORT_PERCENTAGE_KEY

static final io.grpc.Metadata.Key<String> HEADER_ABORT_PERCENTAGE_KEY

TYPE_URL

static final String TYPE_URL

See Also:

• Constant Field Values

random

private final ThreadSafeRandom random

activeFaultCounter

private final AtomicLong activeFaultCounter

Constructor Details

FaultFilter

FaultFilter(ThreadSafeRandom random,
 AtomicLong activeFaultCounter)

Method Details

typeUrls

public String[] typeUrls()

Description copied from interface: Filter

The proto message types supported by this filter. A filter will be registered by each of its supported message types.

Specified by:

typeUrls in interface Filter

parseFilterConfig

public ConfigOrError<FaultConfig> parseFilterConfig(com.google.protobuf.Message rawProtoMessage)

Description copied from interface: Filter

Parses the top-level filter config from raw proto message. The message may be either a Any or a Struct.

Specified by:

parseFilterConfig in interface Filter

parseHttpFault

private static ConfigOrError<FaultConfig> parseHttpFault(HTTPFault httpFault)

parseFaultDelay

private static FaultConfig.FaultDelay parseFaultDelay(FaultDelay faultDelay)

parseFaultAbort

static ConfigOrError<FaultConfig.FaultAbort> parseFaultAbort(FaultAbort faultAbort)

parsePercent

private static FaultConfig.FractionalPercent parsePercent(FractionalPercent proto)

parseFilterConfigOverride

public ConfigOrError<FaultConfig> parseFilterConfigOverride(com.google.protobuf.Message rawProtoMessage)

Description copied from interface: Filter

Parses the per-filter override filter config from raw proto message. The message may be either a Any or a Struct.

Specified by:

parseFilterConfigOverride in interface Filter

buildClientInterceptor

@Nullable
public io.grpc.ClientInterceptor buildClientInterceptor(Filter.FilterConfig config,
 @Nullable
 Filter.FilterConfig overrideConfig,
 io.grpc.LoadBalancer.PickSubchannelArgs args,
 ScheduledExecutorService scheduler)

Specified by:

buildClientInterceptor in interface Filter.ClientInterceptorBuilder

getAbortStatusWithDescription

private static io.grpc.Status getAbortStatusWithDescription(io.grpc.Status abortStatus)

determineFaultDelayNanos

@Nullable
private Long determineFaultDelayNanos(FaultConfig.FaultDelay faultDelay,
 io.grpc.Metadata headers)

determineFaultAbortStatus

@Nullable
private io.grpc.Status determineFaultAbortStatus(FaultConfig.FaultAbort faultAbort,
 io.grpc.Metadata headers)

getRatePerMillion

private static int getRatePerMillion(FaultConfig.FractionalPercent percent)