Class StatsConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.metrics.v3.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.GeneratedMessage
implements StatsConfigOrBuilder
Statistics configuration such as tagging.Protobuf type
envoy.config.metrics.v3.StatsConfig
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Statistics configuration such as tagging.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final StatsConfig
static final int
private List
<HistogramBucketSettings> private byte
private static final com.google.protobuf.Parser
<StatsConfig> private static final long
static final int
static final int
private StatsMatcher
private List
<TagSpecifier> static final int
private com.google.protobuf.BoolValue
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
StatsConfig
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static StatsConfig
static final com.google.protobuf.Descriptors.Descriptor
getHistogramBucketSettings
(int index) Defines rules for setting the histogram buckets.int
Defines rules for setting the histogram buckets.Defines rules for setting the histogram buckets.getHistogramBucketSettingsOrBuilder
(int index) Defines rules for setting the histogram buckets.List
<? extends HistogramBucketSettingsOrBuilder> Defines rules for setting the histogram buckets.com.google.protobuf.Parser
<StatsConfig> int
Inclusion/exclusion matcher for stat name creation.Inclusion/exclusion matcher for stat name creation.getStatsTags
(int index) Each stat name is independently processed through these tag specifiers.int
Each stat name is independently processed through these tag specifiers.Each stat name is independently processed through these tag specifiers.getStatsTagsOrBuilder
(int index) Each stat name is independently processed through these tag specifiers.List
<? extends TagSpecifierOrBuilder> Each stat name is independently processed through these tag specifiers.com.google.protobuf.BoolValue
Use all default tag regexes specified in Envoy.com.google.protobuf.BoolValueOrBuilder
Use all default tag regexes specified in Envoy.int
hashCode()
boolean
Inclusion/exclusion matcher for stat name creation.boolean
Use all default tag regexes specified in Envoy.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static StatsConfig.Builder
static StatsConfig.Builder
newBuilder
(StatsConfig prototype) protected StatsConfig.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) 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()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
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
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
STATS_TAGS_FIELD_NUMBER
public static final int STATS_TAGS_FIELD_NUMBER- See Also:
-
statsTags_
-
USE_ALL_DEFAULT_TAGS_FIELD_NUMBER
public static final int USE_ALL_DEFAULT_TAGS_FIELD_NUMBER- See Also:
-
useAllDefaultTags_
private com.google.protobuf.BoolValue useAllDefaultTags_ -
STATS_MATCHER_FIELD_NUMBER
public static final int STATS_MATCHER_FIELD_NUMBER- See Also:
-
statsMatcher_
-
HISTOGRAM_BUCKET_SETTINGS_FIELD_NUMBER
public static final int HISTOGRAM_BUCKET_SETTINGS_FIELD_NUMBER- See Also:
-
histogramBucketSettings_
-
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
StatsConfig
private StatsConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
StatsConfig
private StatsConfig()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
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 interfaceStatsConfigOrBuilder
-
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 interfaceStatsConfigOrBuilder
-
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 interfaceStatsConfigOrBuilder
-
getStatsTags
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 interfaceStatsConfigOrBuilder
-
getStatsTagsOrBuilder
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 interfaceStatsConfigOrBuilder
-
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 interfaceStatsConfigOrBuilder
- 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 interfaceStatsConfigOrBuilder
- 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 interfaceStatsConfigOrBuilder
-
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 interfaceStatsConfigOrBuilder
- Returns:
- Whether the statsMatcher field is set.
-
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 interfaceStatsConfigOrBuilder
- Returns:
- The statsMatcher.
-
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 interfaceStatsConfigOrBuilder
-
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 interfaceStatsConfigOrBuilder
-
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 interfaceStatsConfigOrBuilder
-
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 interfaceStatsConfigOrBuilder
-
getHistogramBucketSettings
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 interfaceStatsConfigOrBuilder
-
getHistogramBucketSettingsOrBuilder
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 interfaceStatsConfigOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static StatsConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static StatsConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static StatsConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected StatsConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-