Package io.envoyproxy.envoy.config.metrics.v3

Class StatsConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StatsConfigOrBuilder, java.io.Serializable
    public final class StatsConfig
extends com.google.protobuf.GeneratedMessage
implements StatsConfigOrBuilder
     Statistics configuration such as tagging.
    Protobuf type envoy.config.metrics.v3.StatsConfig
    See Also:
    Serialized Form

    • Field Detail

      • bitField0_

        private int bitField0_

      • STATS_TAGS_FIELD_NUMBER

        public static final int STATS_TAGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • statsTags_

        private java.util.List<TagSpecifier> statsTags_

      • USE_ALL_DEFAULT_TAGS_FIELD_NUMBER

        public static final int USE_ALL_DEFAULT_TAGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • useAllDefaultTags_

        private com.google.protobuf.BoolValue useAllDefaultTags_

      • STATS_MATCHER_FIELD_NUMBER

        public static final int STATS_MATCHER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HISTOGRAM_BUCKET_SETTINGS_FIELD_NUMBER

        public static final int HISTOGRAM_BUCKET_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final StatsConfig DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<StatsConfig> PARSER

    • Constructor Detail

      • StatsConfig

        private StatsConfig​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • StatsConfig

        private StatsConfig()

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getStatsTagsList

        public java.util.List<TagSpecifier> getStatsTagsList()
         Each stat name is independently processed through these tag specifiers. When a tag is
 matched, the first capture group is not immediately removed from the name, so later
 :ref:`TagSpecifiers <envoy_v3_api_msg_config.metrics.v3.TagSpecifier>` can also match that
 same portion of the match. After all tag matching is complete, a tag-extracted version of
 the name is produced and is used in stats sinks that represent tags, such as Prometheus.
        repeated .envoy.config.metrics.v3.TagSpecifier stats_tags = 1;
        Specified by:
        getStatsTagsList in interface StatsConfigOrBuilder

      • getStatsTagsOrBuilderList

        public java.util.List<? extends TagSpecifierOrBuilder> getStatsTagsOrBuilderList()
         Each stat name is independently processed through these tag specifiers. When a tag is
 matched, the first capture group is not immediately removed from the name, so later
 :ref:`TagSpecifiers <envoy_v3_api_msg_config.metrics.v3.TagSpecifier>` can also match that
 same portion of the match. After all tag matching is complete, a tag-extracted version of
 the name is produced and is used in stats sinks that represent tags, such as Prometheus.
        repeated .envoy.config.metrics.v3.TagSpecifier stats_tags = 1;
        Specified by:
        getStatsTagsOrBuilderList in interface StatsConfigOrBuilder

      • getStatsTagsCount

        public int getStatsTagsCount()
         Each stat name is independently processed through these tag specifiers. When a tag is
 matched, the first capture group is not immediately removed from the name, so later
 :ref:`TagSpecifiers <envoy_v3_api_msg_config.metrics.v3.TagSpecifier>` can also match that
 same portion of the match. After all tag matching is complete, a tag-extracted version of
 the name is produced and is used in stats sinks that represent tags, such as Prometheus.
        repeated .envoy.config.metrics.v3.TagSpecifier stats_tags = 1;
        Specified by:
        getStatsTagsCount in interface StatsConfigOrBuilder

      • getStatsTags

        public TagSpecifier getStatsTags​(int index)
         Each stat name is independently processed through these tag specifiers. When a tag is
 matched, the first capture group is not immediately removed from the name, so later
 :ref:`TagSpecifiers <envoy_v3_api_msg_config.metrics.v3.TagSpecifier>` can also match that
 same portion of the match. After all tag matching is complete, a tag-extracted version of
 the name is produced and is used in stats sinks that represent tags, such as Prometheus.
        repeated .envoy.config.metrics.v3.TagSpecifier stats_tags = 1;
        Specified by:
        getStatsTags in interface StatsConfigOrBuilder

      • getStatsTagsOrBuilder

        public TagSpecifierOrBuilder getStatsTagsOrBuilder​(int index)
         Each stat name is independently processed through these tag specifiers. When a tag is
 matched, the first capture group is not immediately removed from the name, so later
 :ref:`TagSpecifiers <envoy_v3_api_msg_config.metrics.v3.TagSpecifier>` can also match that
 same portion of the match. After all tag matching is complete, a tag-extracted version of
 the name is produced and is used in stats sinks that represent tags, such as Prometheus.
        repeated .envoy.config.metrics.v3.TagSpecifier stats_tags = 1;
        Specified by:
        getStatsTagsOrBuilder in interface StatsConfigOrBuilder

      • hasUseAllDefaultTags

        public boolean hasUseAllDefaultTags()
         Use all default tag regexes specified in Envoy. These can be combined with
 custom tags specified in :ref:`stats_tags
 <envoy_v3_api_field_config.metrics.v3.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;
        Specified by:
        hasUseAllDefaultTags in interface StatsConfigOrBuilder
        Returns:
        Whether the useAllDefaultTags field is set.

      • getUseAllDefaultTags

        public 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_v3_api_field_config.metrics.v3.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;
        Specified by:
        getUseAllDefaultTags in interface StatsConfigOrBuilder
        Returns:
        The useAllDefaultTags.

      • getUseAllDefaultTagsOrBuilder

        public 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_v3_api_field_config.metrics.v3.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;
        Specified by:
        getUseAllDefaultTagsOrBuilder in interface StatsConfigOrBuilder

      • hasStatsMatcher

        public 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.v3.StatsMatcher stats_matcher = 3;
        Specified by:
        hasStatsMatcher in interface StatsConfigOrBuilder
        Returns:
        Whether the statsMatcher field is set.

      • getStatsMatcher

        public 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.v3.StatsMatcher stats_matcher = 3;
        Specified by:
        getStatsMatcher in interface StatsConfigOrBuilder
        Returns:
        The statsMatcher.

      • getStatsMatcherOrBuilder

        public 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.v3.StatsMatcher stats_matcher = 3;
        Specified by:
        getStatsMatcherOrBuilder in interface StatsConfigOrBuilder

      • getHistogramBucketSettingsList

        public java.util.List<HistogramBucketSettings> getHistogramBucketSettingsList()
         Defines rules for setting the histogram buckets. Rules are evaluated in order, and the first
 match is applied. If no match is found (or if no rules are set), the following default buckets
 are used:

 .. code-block:: json

 [
 0.5,
 1,
 5,
 10,
 25,
 50,
 100,
 250,
 500,
 1000,
 2500,
 5000,
 10000,
 30000,
 60000,
 300000,
 600000,
 1800000,
 3600000
 ]
        repeated .envoy.config.metrics.v3.HistogramBucketSettings histogram_bucket_settings = 4;
        Specified by:
        getHistogramBucketSettingsList in interface StatsConfigOrBuilder

      • getHistogramBucketSettingsOrBuilderList

        public java.util.List<? extends HistogramBucketSettingsOrBuilder> getHistogramBucketSettingsOrBuilderList()
         Defines rules for setting the histogram buckets. Rules are evaluated in order, and the first
 match is applied. If no match is found (or if no rules are set), the following default buckets
 are used:

 .. code-block:: json

 [
 0.5,
 1,
 5,
 10,
 25,
 50,
 100,
 250,
 500,
 1000,
 2500,
 5000,
 10000,
 30000,
 60000,
 300000,
 600000,
 1800000,
 3600000
 ]
        repeated .envoy.config.metrics.v3.HistogramBucketSettings histogram_bucket_settings = 4;
        Specified by:
        getHistogramBucketSettingsOrBuilderList in interface StatsConfigOrBuilder

      • getHistogramBucketSettingsCount

        public int getHistogramBucketSettingsCount()
         Defines rules for setting the histogram buckets. Rules are evaluated in order, and the first
 match is applied. If no match is found (or if no rules are set), the following default buckets
 are used:

 .. code-block:: json

 [
 0.5,
 1,
 5,
 10,
 25,
 50,
 100,
 250,
 500,
 1000,
 2500,
 5000,
 10000,
 30000,
 60000,
 300000,
 600000,
 1800000,
 3600000
 ]
        repeated .envoy.config.metrics.v3.HistogramBucketSettings histogram_bucket_settings = 4;
        Specified by:
        getHistogramBucketSettingsCount in interface StatsConfigOrBuilder

      • getHistogramBucketSettings

        public HistogramBucketSettings getHistogramBucketSettings​(int index)
         Defines rules for setting the histogram buckets. Rules are evaluated in order, and the first
 match is applied. If no match is found (or if no rules are set), the following default buckets
 are used:

 .. code-block:: json

 [
 0.5,
 1,
 5,
 10,
 25,
 50,
 100,
 250,
 500,
 1000,
 2500,
 5000,
 10000,
 30000,
 60000,
 300000,
 600000,
 1800000,
 3600000
 ]
        repeated .envoy.config.metrics.v3.HistogramBucketSettings histogram_bucket_settings = 4;
        Specified by:
        getHistogramBucketSettings in interface StatsConfigOrBuilder

      • getHistogramBucketSettingsOrBuilder

        public HistogramBucketSettingsOrBuilder getHistogramBucketSettingsOrBuilder​(int index)
         Defines rules for setting the histogram buckets. Rules are evaluated in order, and the first
 match is applied. If no match is found (or if no rules are set), the following default buckets
 are used:

 .. code-block:: json

 [
 0.5,
 1,
 5,
 10,
 25,
 50,
 100,
 250,
 500,
 1000,
 2500,
 5000,
 10000,
 30000,
 60000,
 300000,
 600000,
 1800000,
 3600000
 ]
        repeated .envoy.config.metrics.v3.HistogramBucketSettings histogram_bucket_settings = 4;
        Specified by:
        getHistogramBucketSettingsOrBuilder in interface StatsConfigOrBuilder

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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 StatsConfig parseFrom​(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static StatsConfig parseFrom​(java.io.InputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static StatsConfig parseFrom​(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static StatsConfig parseDelimitedFrom​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static StatsConfig parseDelimitedFrom​(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static StatsConfig parseFrom​(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected StatsConfig.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static StatsConfig getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<StatsConfig> 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.GeneratedMessage

      • getDefaultInstanceForType

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