Package io.envoyproxy.envoy.extensions.filters.http.grpc_stats.v3

Class FilterConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterConfigOrBuilder, Serializable
    public final class FilterConfig
extends com.google.protobuf.GeneratedMessageV3
implements FilterConfigOrBuilder
     gRPC statistics filter configuration
    Protobuf type envoy.extensions.filters.http.grpc_stats.v3.FilterConfig
    See Also:
    Serialized Form

    • Field Detail

      • EMIT_FILTER_STATE_FIELD_NUMBER

        public static final int EMIT_FILTER_STATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INDIVIDUAL_METHOD_STATS_ALLOWLIST_FIELD_NUMBER

        public static final int INDIVIDUAL_METHOD_STATS_ALLOWLIST_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STATS_FOR_ALL_METHODS_FIELD_NUMBER

        public static final int STATS_FOR_ALL_METHODS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_UPSTREAM_STATS_FIELD_NUMBER

        public static final int ENABLE_UPSTREAM_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getEmitFilterState

        public boolean getEmitFilterState()
         If true, the filter maintains a filter state object with the request and response message
 counts.
        bool emit_filter_state = 1;
        Specified by:
        getEmitFilterState in interface FilterConfigOrBuilder
        Returns:
        The emitFilterState.

      • hasIndividualMethodStatsAllowlist

        public 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.config.core.v3.GrpcMethodList individual_method_stats_allowlist = 2;
        Specified by:
        hasIndividualMethodStatsAllowlist in interface FilterConfigOrBuilder
        Returns:
        Whether the individualMethodStatsAllowlist field is set.

      • getIndividualMethodStatsAllowlist

        public 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.config.core.v3.GrpcMethodList individual_method_stats_allowlist = 2;
        Specified by:
        getIndividualMethodStatsAllowlist in interface FilterConfigOrBuilder
        Returns:
        The individualMethodStatsAllowlist.

      • getIndividualMethodStatsAllowlistOrBuilder

        public 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.config.core.v3.GrpcMethodList individual_method_stats_allowlist = 2;
        Specified by:
        getIndividualMethodStatsAllowlistOrBuilder in interface FilterConfigOrBuilder

      • hasStatsForAllMethods

        public 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=false``. This default value is changed due
   to the previous value being deprecated. This behavior can be changed with runtime override
   ``envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default``.
        .google.protobuf.BoolValue stats_for_all_methods = 3;
        Specified by:
        hasStatsForAllMethods in interface FilterConfigOrBuilder
        Returns:
        Whether the statsForAllMethods field is set.

      • getStatsForAllMethods

        public 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=false``. This default value is changed due
   to the previous value being deprecated. This behavior can be changed with runtime override
   ``envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default``.
        .google.protobuf.BoolValue stats_for_all_methods = 3;
        Specified by:
        getStatsForAllMethods in interface FilterConfigOrBuilder
        Returns:
        The statsForAllMethods.

      • getStatsForAllMethodsOrBuilder

        public 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=false``. This default value is changed due
   to the previous value being deprecated. This behavior can be changed with runtime override
   ``envoy.deprecated_features.grpc_stats_filter_enable_stats_for_all_methods_by_default``.
        .google.protobuf.BoolValue stats_for_all_methods = 3;
        Specified by:
        getStatsForAllMethodsOrBuilder in interface FilterConfigOrBuilder

      • getEnableUpstreamStats

        public boolean getEnableUpstreamStats()
         If true, the filter will gather a histogram for the request time of the upstream.
 It works with :ref:`stats_for_all_methods
 <envoy_v3_api_field_extensions.filters.http.grpc_stats.v3.FilterConfig.stats_for_all_methods>`
 and :ref:`individual_method_stats_allowlist
 <envoy_v3_api_field_extensions.filters.http.grpc_stats.v3.FilterConfig.individual_method_stats_allowlist>` the same way
 request_message_count and response_message_count works.
        bool enable_upstream_stats = 4;
        Specified by:
        getEnableUpstreamStats in interface FilterConfigOrBuilder
        Returns:
        The enableUpstreamStats.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static FilterConfig parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FilterConfig parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FilterConfig parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FilterConfig parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FilterConfig parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FilterConfig parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FilterConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public FilterConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public FilterConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected FilterConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static FilterConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<FilterConfig> parser()

      • getParserForType

        public com.google.protobuf.Parser<FilterConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public FilterConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder