io.envoyproxy.envoy.config.filter.http.grpc_stats.v2alpha

Interface FilterConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

FilterConfig, FilterConfig.Builder

public interface FilterConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getEmitFilterState() If true, the filter maintains a filter state object with the request and response message counts.
GrpcMethodList	getIndividualMethodStatsAllowlist() If set, specifies an allowlist of service/methods that will have individual stats emitted for them.
GrpcMethodListOrBuilder	getIndividualMethodStatsAllowlistOrBuilder() If set, specifies an allowlist of service/methods that will have individual stats emitted for them.
FilterConfig.PerMethodStatSpecifierCase	getPerMethodStatSpecifierCase()
com.google.protobuf.BoolValue	getStatsForAllMethods() If set to true, emit stats for all service/method names.
com.google.protobuf.BoolValueOrBuilder	getStatsForAllMethodsOrBuilder() If set to true, emit stats for all service/method names.
boolean	hasIndividualMethodStatsAllowlist() If set, specifies an allowlist of service/methods that will have individual stats emitted for them.
boolean	hasStatsForAllMethods() If set to true, emit stats for all service/method names.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getEmitFilterState

boolean getEmitFilterState()

 If true, the filter maintains a filter state object with the request and response message
 counts.
 

bool emit_filter_state = 1;

hasIndividualMethodStatsAllowlist

boolean hasIndividualMethodStatsAllowlist()

 If set, specifies an allowlist of service/methods that will have individual stats
 emitted for them. Any call that does not match the allowlist will be counted
 in a stat with no method specifier: `cluster.<name>.grpc.*`.
 

.envoy.api.v2.core.GrpcMethodList individual_method_stats_allowlist = 2;

getIndividualMethodStatsAllowlist

GrpcMethodList getIndividualMethodStatsAllowlist()

 If set, specifies an allowlist of service/methods that will have individual stats
 emitted for them. Any call that does not match the allowlist will be counted
 in a stat with no method specifier: `cluster.<name>.grpc.*`.
 

.envoy.api.v2.core.GrpcMethodList individual_method_stats_allowlist = 2;

getIndividualMethodStatsAllowlistOrBuilder

GrpcMethodListOrBuilder getIndividualMethodStatsAllowlistOrBuilder()

 If set, specifies an allowlist of service/methods that will have individual stats
 emitted for them. Any call that does not match the allowlist will be counted
 in a stat with no method specifier: `cluster.<name>.grpc.*`.
 

.envoy.api.v2.core.GrpcMethodList individual_method_stats_allowlist = 2;

hasStatsForAllMethods

boolean hasStatsForAllMethods()

 If set to true, emit stats for all service/method names.
 If set to false, emit stats for all service/message types to the same stats without including
 the service/method in the name, with prefix `cluster.<name>.grpc`. This can be useful if
 service/method granularity is not needed, or if each cluster only receives a single method.
 .. attention::
   This option is only safe if all clients are trusted. If this option is enabled
   with untrusted clients, the clients could cause unbounded growth in the number of stats in
   Envoy, using unbounded memory and potentially slowing down stats pipelines.
 .. attention::
   If neither `individual_method_stats_allowlist` nor `stats_for_all_methods` is set, the
   behavior will default to `stats_for_all_methods=true`. This default value is deprecated,
   and in a future release, if neither field is set, it will default to
   `stats_for_all_methods=false` in order to be safe by default. This behavior can be
   controlled with runtime override
   `envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default`.
 

.google.protobuf.BoolValue stats_for_all_methods = 3;

getStatsForAllMethods

com.google.protobuf.BoolValue getStatsForAllMethods()

 If set to true, emit stats for all service/method names.
 If set to false, emit stats for all service/message types to the same stats without including
 the service/method in the name, with prefix `cluster.<name>.grpc`. This can be useful if
 service/method granularity is not needed, or if each cluster only receives a single method.
 .. attention::
   This option is only safe if all clients are trusted. If this option is enabled
   with untrusted clients, the clients could cause unbounded growth in the number of stats in
   Envoy, using unbounded memory and potentially slowing down stats pipelines.
 .. attention::
   If neither `individual_method_stats_allowlist` nor `stats_for_all_methods` is set, the
   behavior will default to `stats_for_all_methods=true`. This default value is deprecated,
   and in a future release, if neither field is set, it will default to
   `stats_for_all_methods=false` in order to be safe by default. This behavior can be
   controlled with runtime override
   `envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default`.
 

.google.protobuf.BoolValue stats_for_all_methods = 3;

getStatsForAllMethodsOrBuilder

com.google.protobuf.BoolValueOrBuilder getStatsForAllMethodsOrBuilder()

 If set to true, emit stats for all service/method names.
 If set to false, emit stats for all service/message types to the same stats without including
 the service/method in the name, with prefix `cluster.<name>.grpc`. This can be useful if
 service/method granularity is not needed, or if each cluster only receives a single method.
 .. attention::
   This option is only safe if all clients are trusted. If this option is enabled
   with untrusted clients, the clients could cause unbounded growth in the number of stats in
   Envoy, using unbounded memory and potentially slowing down stats pipelines.
 .. attention::
   If neither `individual_method_stats_allowlist` nor `stats_for_all_methods` is set, the
   behavior will default to `stats_for_all_methods=true`. This default value is deprecated,
   and in a future release, if neither field is set, it will default to
   `stats_for_all_methods=false` in order to be safe by default. This behavior can be
   controlled with runtime override
   `envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default`.
 

.google.protobuf.BoolValue stats_for_all_methods = 3;

getPerMethodStatSpecifierCase

FilterConfig.PerMethodStatSpecifierCase getPerMethodStatSpecifierCase()