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

Class StatsConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.metrics.v2.StatsConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StatsConfigOrBuilder, Serializable
public final class StatsConfig extends com.google.protobuf.GeneratedMessageV3 implements StatsConfigOrBuilder
 Statistics configuration such as tagging.
Protobuf type envoy.config.metrics.v2.StatsConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StatsConfig.Builder
    Statistics configuration such as tagging.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    STATS_MATCHER_FIELD_NUMBER
     
    static final int
    STATS_TAGS_FIELD_NUMBER
     
    static final int
    USE_ALL_DEFAULT_TAGS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static StatsConfig
    getDefaultInstance()
     
    StatsConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<StatsConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    StatsMatcher
    getStatsMatcher()
    Inclusion/exclusion matcher for stat name creation.
    StatsMatcherOrBuilder
    getStatsMatcherOrBuilder()
    Inclusion/exclusion matcher for stat name creation.
    TagSpecifier
    getStatsTags(int index)
    Each stat name is iteratively processed through these tag specifiers.
    int
    getStatsTagsCount()
    Each stat name is iteratively processed through these tag specifiers.
    List<TagSpecifier>
    getStatsTagsList()
    Each stat name is iteratively processed through these tag specifiers.
    TagSpecifierOrBuilder
    getStatsTagsOrBuilder(int index)
    Each stat name is iteratively processed through these tag specifiers.
    List<? extends TagSpecifierOrBuilder>
    getStatsTagsOrBuilderList()
    Each stat name is iteratively processed through these tag specifiers.
    com.google.protobuf.BoolValue
    getUseAllDefaultTags()
    Use all default tag regexes specified in Envoy.
    com.google.protobuf.BoolValueOrBuilder
    getUseAllDefaultTagsOrBuilder()
    Use all default tag regexes specified in Envoy.
    int
    hashCode()
     
    boolean
    hasStatsMatcher()
    Inclusion/exclusion matcher for stat name creation.
    boolean
    hasUseAllDefaultTags()
    Use all default tag regexes specified in Envoy.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static StatsConfig.Builder
    newBuilder()
     
    static StatsConfig.Builder
    newBuilder(StatsConfig prototype)
     
    StatsConfig.Builder
    newBuilderForType()
     
    protected StatsConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static StatsConfig
    parseDelimitedFrom(InputStream input)
     
    static StatsConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatsConfig
    parseFrom(byte[] data)
     
    static StatsConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatsConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static StatsConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatsConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StatsConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatsConfig
    parseFrom(InputStream input)
     
    static StatsConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StatsConfig
    parseFrom(ByteBuffer data)
     
    static StatsConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StatsConfig>
    parser()
     
    StatsConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • STATS_TAGS_FIELD_NUMBER

      public static final int STATS_TAGS_FIELD_NUMBER
      See Also:

    • USE_ALL_DEFAULT_TAGS_FIELD_NUMBER

      public static final int USE_ALL_DEFAULT_TAGS_FIELD_NUMBER
      See Also:

    • STATS_MATCHER_FIELD_NUMBER

      public static final int STATS_MATCHER_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getStatsTagsList

      public 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;
      Specified by:
      getStatsTagsList in interface StatsConfigOrBuilder

    • getStatsTagsOrBuilderList

      public 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;
      Specified by:
      getStatsTagsOrBuilderList in interface StatsConfigOrBuilder

    • getStatsTagsCount

      public 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;
      Specified by:
      getStatsTagsCount in interface StatsConfigOrBuilder

    • getStatsTags

      public 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;
      Specified by:
      getStatsTags in interface StatsConfigOrBuilder

    • getStatsTagsOrBuilder

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

    • 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 StatsConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StatsConfig parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static StatsConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StatsConfig.Builder newBuilder()

    • newBuilder

      public static StatsConfig.Builder newBuilder(StatsConfig prototype)

    • 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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • 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.GeneratedMessageV3

    • getDefaultInstanceForType

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