Class TrackClusterStats

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.cluster.v3.TrackClusterStats
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TrackClusterStatsOrBuilder, Serializable
@Generated public final class TrackClusterStats extends com.google.protobuf.GeneratedMessage implements TrackClusterStatsOrBuilder
Protobuf type envoy.config.cluster.v3.TrackClusterStats
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TrackClusterStats.Builder
    Protobuf type envoy.config.cluster.v3.TrackClusterStats

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, 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

    Fields
    Modifier and Type
    Field
    Description
    private static final TrackClusterStats
    DEFAULT_INSTANCE
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<TrackClusterStats>
    PARSER
     
    static final int
    PER_ENDPOINT_STATS_FIELD_NUMBER
     
    private boolean
    perEndpointStats_
     
    static final int
    REQUEST_RESPONSE_SIZES_FIELD_NUMBER
     
    private boolean
    requestResponseSizes_
     
    private static final long
    serialVersionUID
     
    static final int
    TIMEOUT_BUDGETS_FIELD_NUMBER
     
    private boolean
    timeoutBudgets_
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    TrackClusterStats()
     
    private
    TrackClusterStats(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static TrackClusterStats
    getDefaultInstance()
     
    TrackClusterStats
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    com.google.protobuf.Parser<TrackClusterStats>
    getParserForType()
     
    boolean
    getPerEndpointStats()
    If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters`` output.
    boolean
    getRequestResponseSizes()
    If request_response_sizes is true, then the :ref:`histograms <config_cluster_manager_cluster_stats_request_response_sizes>` tracking header and body sizes of requests and responses will be published.
    int
    getSerializedSize()
     
    boolean
    getTimeoutBudgets()
    If timeout_budgets is true, the :ref:`timeout budget histograms <config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each request.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TrackClusterStats.Builder
    newBuilder()
     
    static TrackClusterStats.Builder
    newBuilder(TrackClusterStats prototype)
     
    TrackClusterStats.Builder
    newBuilderForType()
     
    protected TrackClusterStats.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static TrackClusterStats
    parseDelimitedFrom(InputStream input)
     
    static TrackClusterStats
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TrackClusterStats
    parseFrom(byte[] data)
     
    static TrackClusterStats
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TrackClusterStats
    parseFrom(com.google.protobuf.ByteString data)
     
    static TrackClusterStats
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TrackClusterStats
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TrackClusterStats
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TrackClusterStats
    parseFrom(InputStream input)
     
    static TrackClusterStats
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TrackClusterStats
    parseFrom(ByteBuffer data)
     
    static TrackClusterStats
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TrackClusterStats>
    parser()
     
    TrackClusterStats.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • TIMEOUT_BUDGETS_FIELD_NUMBER

      public static final int TIMEOUT_BUDGETS_FIELD_NUMBER
      See Also:

    • timeoutBudgets_

      private boolean timeoutBudgets_

    • REQUEST_RESPONSE_SIZES_FIELD_NUMBER

      public static final int REQUEST_RESPONSE_SIZES_FIELD_NUMBER
      See Also:

    • requestResponseSizes_

      private boolean requestResponseSizes_

    • PER_ENDPOINT_STATS_FIELD_NUMBER

      public static final int PER_ENDPOINT_STATS_FIELD_NUMBER
      See Also:

    • perEndpointStats_

      private boolean perEndpointStats_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final TrackClusterStats DEFAULT_INSTANCE

    • PARSER

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

  • Constructor Details

    • TrackClusterStats

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

    • TrackClusterStats

      private TrackClusterStats()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getTimeoutBudgets

      public boolean getTimeoutBudgets()
      If timeout_budgets is true, the :ref:`timeout budget histograms
<config_cluster_manager_cluster_stats_timeout_budgets>` will be published for each
request. These show what percentage of a request's per try and global timeout was used. A value
of 0 would indicate that none of the timeout was used or that the timeout was infinite. A value
of 100 would indicate that the request took the entirety of the timeout given to it.
      bool timeout_budgets = 1;
      Specified by:
      getTimeoutBudgets in interface TrackClusterStatsOrBuilder
      Returns:
      The timeoutBudgets.

    • getRequestResponseSizes

      public boolean getRequestResponseSizes()
      If request_response_sizes is true, then the :ref:`histograms
<config_cluster_manager_cluster_stats_request_response_sizes>`  tracking header and body sizes
of requests and responses will be published.
      bool request_response_sizes = 2;
      Specified by:
      getRequestResponseSizes in interface TrackClusterStatsOrBuilder
      Returns:
      The requestResponseSizes.

    • getPerEndpointStats

      public boolean getPerEndpointStats()
      If true, some stats will be emitted per-endpoint, similar to the stats in admin ``/clusters``
output.

This does not currently output correct stats during a hot-restart.

This is not currently implemented by all stat sinks.

These stats do not honor filtering or tag extraction rules in :ref:`StatsConfig
<envoy_v3_api_msg_config.metrics.v3.StatsConfig>` (but fixed-value tags are supported). Admin
endpoint filtering is supported.

This may not be used at the same time as
:ref:`load_stats_config <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.load_stats_config>`.
      bool per_endpoint_stats = 3;
      Specified by:
      getPerEndpointStats in interface TrackClusterStatsOrBuilder
      Returns:
      The perEndpointStats.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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 TrackClusterStats parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrackClusterStats parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TrackClusterStats parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TrackClusterStats.Builder newBuilder()

    • newBuilder

      public static TrackClusterStats.Builder newBuilder(TrackClusterStats prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TrackClusterStats getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<TrackClusterStats> 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 TrackClusterStats getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder