Package io.envoyproxy.envoy.config.metrics.v2

Interface StatsConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    StatsConfig, StatsConfig.Builder
    public interface StatsConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getStatsTagsList

        List<TagSpecifier> getStatsTagsList()
         Each stat name is iteratively processed through these tag specifiers.
 When a tag is matched, the first capture group is removed from the name so
 later :ref:`TagSpecifiers <envoy_api_msg_config.metrics.v2.TagSpecifier>` cannot match that
 same portion of the match.
        repeated .envoy.config.metrics.v2.TagSpecifier stats_tags = 1;

      • getStatsTags

        TagSpecifier getStatsTags​(int index)
         Each stat name is iteratively processed through these tag specifiers.
 When a tag is matched, the first capture group is removed from the name so
 later :ref:`TagSpecifiers <envoy_api_msg_config.metrics.v2.TagSpecifier>` cannot match that
 same portion of the match.
        repeated .envoy.config.metrics.v2.TagSpecifier stats_tags = 1;

      • getStatsTagsCount

        int getStatsTagsCount()
         Each stat name is iteratively processed through these tag specifiers.
 When a tag is matched, the first capture group is removed from the name so
 later :ref:`TagSpecifiers <envoy_api_msg_config.metrics.v2.TagSpecifier>` cannot match that
 same portion of the match.
        repeated .envoy.config.metrics.v2.TagSpecifier stats_tags = 1;

      • getStatsTagsOrBuilderList

        List<? extends TagSpecifierOrBuilder> getStatsTagsOrBuilderList()
         Each stat name is iteratively processed through these tag specifiers.
 When a tag is matched, the first capture group is removed from the name so
 later :ref:`TagSpecifiers <envoy_api_msg_config.metrics.v2.TagSpecifier>` cannot match that
 same portion of the match.
        repeated .envoy.config.metrics.v2.TagSpecifier stats_tags = 1;

      • getStatsTagsOrBuilder

        TagSpecifierOrBuilder getStatsTagsOrBuilder​(int index)
         Each stat name is iteratively processed through these tag specifiers.
 When a tag is matched, the first capture group is removed from the name so
 later :ref:`TagSpecifiers <envoy_api_msg_config.metrics.v2.TagSpecifier>` cannot match that
 same portion of the match.
        repeated .envoy.config.metrics.v2.TagSpecifier stats_tags = 1;

      • hasUseAllDefaultTags

        boolean hasUseAllDefaultTags()
         Use all default tag regexes specified in Envoy. These can be combined with
 custom tags specified in :ref:`stats_tags
 <envoy_api_field_config.metrics.v2.StatsConfig.stats_tags>`. They will be processed before
 the custom tags.
 .. note::
   If any default tags are specified twice, the config will be considered
   invalid.
 See :repo:`well_known_names.h <source/common/config/well_known_names.h>` for a list of the
 default tags in Envoy.
 If not provided, the value is assumed to be true.
        .google.protobuf.BoolValue use_all_default_tags = 2;
        Returns:
        Whether the useAllDefaultTags field is set.

      • getUseAllDefaultTags

        com.google.protobuf.BoolValue getUseAllDefaultTags()
         Use all default tag regexes specified in Envoy. These can be combined with
 custom tags specified in :ref:`stats_tags
 <envoy_api_field_config.metrics.v2.StatsConfig.stats_tags>`. They will be processed before
 the custom tags.
 .. note::
   If any default tags are specified twice, the config will be considered
   invalid.
 See :repo:`well_known_names.h <source/common/config/well_known_names.h>` for a list of the
 default tags in Envoy.
 If not provided, the value is assumed to be true.
        .google.protobuf.BoolValue use_all_default_tags = 2;
        Returns:
        The useAllDefaultTags.

      • getUseAllDefaultTagsOrBuilder

        com.google.protobuf.BoolValueOrBuilder getUseAllDefaultTagsOrBuilder()
         Use all default tag regexes specified in Envoy. These can be combined with
 custom tags specified in :ref:`stats_tags
 <envoy_api_field_config.metrics.v2.StatsConfig.stats_tags>`. They will be processed before
 the custom tags.
 .. note::
   If any default tags are specified twice, the config will be considered
   invalid.
 See :repo:`well_known_names.h <source/common/config/well_known_names.h>` for a list of the
 default tags in Envoy.
 If not provided, the value is assumed to be true.
        .google.protobuf.BoolValue use_all_default_tags = 2;

      • hasStatsMatcher

        boolean hasStatsMatcher()
         Inclusion/exclusion matcher for stat name creation. If not provided, all stats are instantiated
 as normal. Preventing the instantiation of certain families of stats can improve memory
 performance for Envoys running especially large configs.
 .. warning::
   Excluding stats may affect Envoy's behavior in undocumented ways. See
   `issue #8771 <https://github.com/envoyproxy/envoy/issues/8771>`_ for more information.
   If any unexpected behavior changes are observed, please open a new issue immediately.
        .envoy.config.metrics.v2.StatsMatcher stats_matcher = 3;
        Returns:
        Whether the statsMatcher field is set.

      • getStatsMatcher

        StatsMatcher getStatsMatcher()
         Inclusion/exclusion matcher for stat name creation. If not provided, all stats are instantiated
 as normal. Preventing the instantiation of certain families of stats can improve memory
 performance for Envoys running especially large configs.
 .. warning::
   Excluding stats may affect Envoy's behavior in undocumented ways. See
   `issue #8771 <https://github.com/envoyproxy/envoy/issues/8771>`_ for more information.
   If any unexpected behavior changes are observed, please open a new issue immediately.
        .envoy.config.metrics.v2.StatsMatcher stats_matcher = 3;
        Returns:
        The statsMatcher.

      • getStatsMatcherOrBuilder

        StatsMatcherOrBuilder getStatsMatcherOrBuilder()
         Inclusion/exclusion matcher for stat name creation. If not provided, all stats are instantiated
 as normal. Preventing the instantiation of certain families of stats can improve memory
 performance for Envoys running especially large configs.
 .. warning::
   Excluding stats may affect Envoy's behavior in undocumented ways. See
   `issue #8771 <https://github.com/envoyproxy/envoy/issues/8771>`_ for more information.
   If any unexpected behavior changes are observed, please open a new issue immediately.
        .envoy.config.metrics.v2.StatsMatcher stats_matcher = 3;