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

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 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;
        Returns:
        The emitFilterState.

      • 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.config.core.v3.GrpcMethodList individual_method_stats_allowlist = 2;
        Returns:
        Whether the individualMethodStatsAllowlist field is set.

      • 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.config.core.v3.GrpcMethodList individual_method_stats_allowlist = 2;
        Returns:
        The individualMethodStatsAllowlist.

      • 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.config.core.v3.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=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;
        Returns:
        Whether the statsForAllMethods field is set.

      • 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=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;
        Returns:
        The statsForAllMethods.

      • 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=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;

      • getEnableUpstreamStats

        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;
        Returns:
        The enableUpstreamStats.