Documentation ¶
Index ¶
- Variables
- type FilterConfig
- func (*FilterConfig) Descriptor() ([]byte, []int)deprecated
- func (x *FilterConfig) GetEmitFilterState() bool
- func (x *FilterConfig) GetEnableUpstreamStats() bool
- func (x *FilterConfig) GetIndividualMethodStatsAllowlist() *v3.GrpcMethodList
- func (m *FilterConfig) GetPerMethodStatSpecifier() isFilterConfig_PerMethodStatSpecifier
- func (x *FilterConfig) GetStatsForAllMethods() *wrappers.BoolValue
- func (*FilterConfig) ProtoMessage()
- func (x *FilterConfig) ProtoReflect() protoreflect.Message
- func (x *FilterConfig) Reset()
- func (x *FilterConfig) String() string
- func (m *FilterConfig) Validate() error
- type FilterConfigValidationError
- func (e FilterConfigValidationError) Cause() error
- func (e FilterConfigValidationError) Error() string
- func (e FilterConfigValidationError) ErrorName() string
- func (e FilterConfigValidationError) Field() string
- func (e FilterConfigValidationError) Key() bool
- func (e FilterConfigValidationError) Reason() string
- type FilterConfig_IndividualMethodStatsAllowlist
- type FilterConfig_StatsForAllMethods
- type FilterObject
- func (*FilterObject) Descriptor() ([]byte, []int)deprecated
- func (x *FilterObject) GetRequestMessageCount() uint64
- func (x *FilterObject) GetResponseMessageCount() uint64
- func (*FilterObject) ProtoMessage()
- func (x *FilterObject) ProtoReflect() protoreflect.Message
- func (x *FilterObject) Reset()
- func (x *FilterObject) String() string
- func (m *FilterObject) Validate() error
- type FilterObjectValidationError
- func (e FilterObjectValidationError) Cause() error
- func (e FilterObjectValidationError) Error() string
- func (e FilterObjectValidationError) ErrorName() string
- func (e FilterObjectValidationError) Field() string
- func (e FilterObjectValidationError) Key() bool
- func (e FilterObjectValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_http_grpc_stats_v3_config_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type FilterConfig ¶
type FilterConfig struct { // If true, the filter maintains a filter state object with the request and response message // counts. EmitFilterState bool `protobuf:"varint,1,opt,name=emit_filter_state,json=emitFilterState,proto3" json:"emit_filter_state,omitempty"` // Types that are assignable to PerMethodStatSpecifier: // *FilterConfig_IndividualMethodStatsAllowlist // *FilterConfig_StatsForAllMethods PerMethodStatSpecifier isFilterConfig_PerMethodStatSpecifier `protobuf_oneof:"per_method_stat_specifier"` // If true, the filter will gather a histogram for the request time of the upstream. // It works with :ref:`stats_for_all_methods // <envoy_api_field_extensions.filters.http.grpc_stats.v3.FilterConfig.stats_for_all_methods>` // and :ref:`individual_method_stats_allowlist // <envoy_api_field_extensions.filters.http.grpc_stats.v3.FilterConfig.individual_method_stats_allowlist>` the same way // request_message_count and response_message_count works. EnableUpstreamStats bool `protobuf:"varint,4,opt,name=enable_upstream_stats,json=enableUpstreamStats,proto3" json:"enable_upstream_stats,omitempty"` // contains filtered or unexported fields }
gRPC statistics filter configuration
func (*FilterConfig) Descriptor
deprecated
func (*FilterConfig) Descriptor() ([]byte, []int)
Deprecated: Use FilterConfig.ProtoReflect.Descriptor instead.
func (*FilterConfig) GetEmitFilterState ¶
func (x *FilterConfig) GetEmitFilterState() bool
func (*FilterConfig) GetEnableUpstreamStats ¶ added in v1.7.0
func (x *FilterConfig) GetEnableUpstreamStats() bool
func (*FilterConfig) GetIndividualMethodStatsAllowlist ¶
func (x *FilterConfig) GetIndividualMethodStatsAllowlist() *v3.GrpcMethodList
func (*FilterConfig) GetPerMethodStatSpecifier ¶
func (m *FilterConfig) GetPerMethodStatSpecifier() isFilterConfig_PerMethodStatSpecifier
func (*FilterConfig) GetStatsForAllMethods ¶
func (x *FilterConfig) GetStatsForAllMethods() *wrappers.BoolValue
func (*FilterConfig) ProtoMessage ¶
func (*FilterConfig) ProtoMessage()
func (*FilterConfig) ProtoReflect ¶ added in v1.7.0
func (x *FilterConfig) ProtoReflect() protoreflect.Message
func (*FilterConfig) Reset ¶
func (x *FilterConfig) Reset()
func (*FilterConfig) String ¶
func (x *FilterConfig) String() string
func (*FilterConfig) Validate ¶
func (m *FilterConfig) Validate() error
Validate checks the field values on FilterConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type FilterConfigValidationError ¶
type FilterConfigValidationError struct {
// contains filtered or unexported fields
}
FilterConfigValidationError is the validation error returned by FilterConfig.Validate if the designated constraints aren't met.
func (FilterConfigValidationError) Cause ¶
func (e FilterConfigValidationError) Cause() error
Cause function returns cause value.
func (FilterConfigValidationError) Error ¶
func (e FilterConfigValidationError) Error() string
Error satisfies the builtin error interface
func (FilterConfigValidationError) ErrorName ¶
func (e FilterConfigValidationError) ErrorName() string
ErrorName returns error name.
func (FilterConfigValidationError) Field ¶
func (e FilterConfigValidationError) Field() string
Field function returns field value.
func (FilterConfigValidationError) Key ¶
func (e FilterConfigValidationError) Key() bool
Key function returns key value.
func (FilterConfigValidationError) Reason ¶
func (e FilterConfigValidationError) Reason() string
Reason function returns reason value.
type FilterConfig_IndividualMethodStatsAllowlist ¶
type FilterConfig_IndividualMethodStatsAllowlist struct { // 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.*`. IndividualMethodStatsAllowlist *v3.GrpcMethodList `protobuf:"bytes,2,opt,name=individual_method_stats_allowlist,json=individualMethodStatsAllowlist,proto3,oneof"` }
type FilterConfig_StatsForAllMethods ¶
type FilterConfig_StatsForAllMethods struct { // 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`. StatsForAllMethods *wrappers.BoolValue `protobuf:"bytes,3,opt,name=stats_for_all_methods,json=statsForAllMethods,proto3,oneof"` }
type FilterObject ¶
type FilterObject struct { // Count of request messages in the request stream. RequestMessageCount uint64 `protobuf:"varint,1,opt,name=request_message_count,json=requestMessageCount,proto3" json:"request_message_count,omitempty"` // Count of response messages in the response stream. ResponseMessageCount uint64 `protobuf:"varint,2,opt,name=response_message_count,json=responseMessageCount,proto3" json:"response_message_count,omitempty"` // contains filtered or unexported fields }
gRPC statistics filter state object in protobuf form.
func (*FilterObject) Descriptor
deprecated
func (*FilterObject) Descriptor() ([]byte, []int)
Deprecated: Use FilterObject.ProtoReflect.Descriptor instead.
func (*FilterObject) GetRequestMessageCount ¶
func (x *FilterObject) GetRequestMessageCount() uint64
func (*FilterObject) GetResponseMessageCount ¶
func (x *FilterObject) GetResponseMessageCount() uint64
func (*FilterObject) ProtoMessage ¶
func (*FilterObject) ProtoMessage()
func (*FilterObject) ProtoReflect ¶ added in v1.7.0
func (x *FilterObject) ProtoReflect() protoreflect.Message
func (*FilterObject) Reset ¶
func (x *FilterObject) Reset()
func (*FilterObject) String ¶
func (x *FilterObject) String() string
func (*FilterObject) Validate ¶
func (m *FilterObject) Validate() error
Validate checks the field values on FilterObject with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type FilterObjectValidationError ¶
type FilterObjectValidationError struct {
// contains filtered or unexported fields
}
FilterObjectValidationError is the validation error returned by FilterObject.Validate if the designated constraints aren't met.
func (FilterObjectValidationError) Cause ¶
func (e FilterObjectValidationError) Cause() error
Cause function returns cause value.
func (FilterObjectValidationError) Error ¶
func (e FilterObjectValidationError) Error() string
Error satisfies the builtin error interface
func (FilterObjectValidationError) ErrorName ¶
func (e FilterObjectValidationError) ErrorName() string
ErrorName returns error name.
func (FilterObjectValidationError) Field ¶
func (e FilterObjectValidationError) Field() string
Field function returns field value.
func (FilterObjectValidationError) Key ¶
func (e FilterObjectValidationError) Key() bool
Key function returns key value.
func (FilterObjectValidationError) Reason ¶
func (e FilterObjectValidationError) Reason() string
Reason function returns reason value.