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 Summary
Modifier and TypeMethodDescriptiongetHistogramBucketSettings
(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.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.boolean
Inclusion/exclusion matcher for stat name creation.boolean
Use all default tag regexes specified in Envoy.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getStatsTagsList
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;
-
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;
-
getStatsTagsCount
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;
-
getStatsTagsOrBuilderList
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;
-
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;
-
hasUseAllDefaultTags
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;
- 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_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;
- 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_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;
-
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.v3.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.v3.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.v3.StatsMatcher stats_matcher = 3;
-
getHistogramBucketSettingsList
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;
-
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;
-
getHistogramBucketSettingsCount
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;
-
getHistogramBucketSettingsOrBuilderList
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;
-
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;
-