Class HystrixSink.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<HystrixSink.Builder>
com.google.protobuf.GeneratedMessage.Builder<HystrixSink.Builder>
io.envoyproxy.envoy.config.metrics.v3.HystrixSink.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HystrixSinkOrBuilder, Cloneable
Enclosing class:
HystrixSink

public static final class HystrixSink.Builder extends com.google.protobuf.GeneratedMessage.Builder<HystrixSink.Builder> implements HystrixSinkOrBuilder
 Stats configuration proto schema for built-in ``envoy.stat_sinks.hystrix`` sink.
 The sink emits stats in `text/event-stream
 <https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events>`_
 formatted stream for use by `Hystrix dashboard
 <https://github.com/Netflix-Skunkworks/hystrix-dashboard/wiki>`_.

 Note that only a single HystrixSink should be configured.

 Streaming is started through an admin endpoint :http:get:`/hystrix_event_stream`.
 [#extension: envoy.stat_sinks.hystrix]
 
Protobuf type envoy.config.metrics.v3.HystrixSink
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
     
    private long
     
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
    private
    Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
    private void
     
     
    The number of buckets the rolling statistical window is divided into.
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Descriptors.Descriptor
     
    long
    The number of buckets the rolling statistical window is divided into.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    mergeFrom(com.google.protobuf.Message other)
     
     
    setNumBuckets(long value)
    The number of buckets the rolling statistical window is divided into.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

    • bitField0_

      private int bitField0_
    • numBuckets_

      private long numBuckets_
  • Constructor Details

    • Builder

      private Builder()
    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)
  • Method Details

    • 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.Builder<HystrixSink.Builder>
    • clear

      public HystrixSink.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<HystrixSink.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<HystrixSink.Builder>
    • getDefaultInstanceForType

      public HystrixSink getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public HystrixSink build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public HystrixSink buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • buildPartial0

      private void buildPartial0(HystrixSink result)
    • mergeFrom

      public HystrixSink.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HystrixSink.Builder>
    • mergeFrom

      public HystrixSink.Builder mergeFrom(HystrixSink other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<HystrixSink.Builder>
    • mergeFrom

      public HystrixSink.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HystrixSink.Builder>
      Throws:
      IOException
    • getNumBuckets

      public long getNumBuckets()
       The number of buckets the rolling statistical window is divided into.
      
       Each time the sink is flushed, all relevant Envoy statistics are sampled and
       added to the rolling window (removing the oldest samples in the window
       in the process). The sink then outputs the aggregate statistics across the
       current rolling window to the event stream(s).
      
       ``rolling_window(ms)`` = ``stats_flush_interval(ms)`` * ``num_of_buckets``
      
       More detailed explanation can be found in `Hystrix wiki
       <https://github.com/Netflix/Hystrix/wiki/Metrics-and-Monitoring#hystrixrollingnumber>`_.
       
      int64 num_buckets = 1;
      Specified by:
      getNumBuckets in interface HystrixSinkOrBuilder
      Returns:
      The numBuckets.
    • setNumBuckets

      public HystrixSink.Builder setNumBuckets(long value)
       The number of buckets the rolling statistical window is divided into.
      
       Each time the sink is flushed, all relevant Envoy statistics are sampled and
       added to the rolling window (removing the oldest samples in the window
       in the process). The sink then outputs the aggregate statistics across the
       current rolling window to the event stream(s).
      
       ``rolling_window(ms)`` = ``stats_flush_interval(ms)`` * ``num_of_buckets``
      
       More detailed explanation can be found in `Hystrix wiki
       <https://github.com/Netflix/Hystrix/wiki/Metrics-and-Monitoring#hystrixrollingnumber>`_.
       
      int64 num_buckets = 1;
      Parameters:
      value - The numBuckets to set.
      Returns:
      This builder for chaining.
    • clearNumBuckets

      public HystrixSink.Builder clearNumBuckets()
       The number of buckets the rolling statistical window is divided into.
      
       Each time the sink is flushed, all relevant Envoy statistics are sampled and
       added to the rolling window (removing the oldest samples in the window
       in the process). The sink then outputs the aggregate statistics across the
       current rolling window to the event stream(s).
      
       ``rolling_window(ms)`` = ``stats_flush_interval(ms)`` * ``num_of_buckets``
      
       More detailed explanation can be found in `Hystrix wiki
       <https://github.com/Netflix/Hystrix/wiki/Metrics-and-Monitoring#hystrixrollingnumber>`_.
       
      int64 num_buckets = 1;
      Returns:
      This builder for chaining.