Package com.arpnetworking.tsdcore.sinks.circonus

Class CirconusSink.Builder

java.lang.Object
com.arpnetworking.commons.builder.OvalBuilder<S>
com.arpnetworking.tsdcore.sinks.BaseSink.Builder<CirconusSink.Builder,CirconusSink>
com.arpnetworking.tsdcore.sinks.circonus.CirconusSink.Builder
All Implemented Interfaces:
com.arpnetworking.commons.builder.Builder<CirconusSink>
Enclosing class:
CirconusSink
public static class CirconusSink.Builder extends BaseSink.Builder<CirconusSink.Builder,CirconusSink>
Builder for CirconusSink.

  • Constructor Details

    • Builder

      public Builder()
      Public constructor.

  • Method Details

    • setActorSystem

      public CirconusSink.Builder setActorSystem(org.apache.pekko.actor.ActorSystem value)
      Sets the actor system to create the sink actor in.
      Parameters:
      value - the actor system
      Returns:
      this builder

    • setUri

      public CirconusSink.Builder setUri(URI value)
      Sets the base url for the Circonus API.
      Parameters:
      value - the base uri
      Returns:
      this builder

    • setBroker

      public CirconusSink.Builder setBroker(String value)
      Sets the broker name to push metrics to.
      Parameters:
      value - the Circonus broker to push to
      Returns:
      this builder

    • setAppName

      public CirconusSink.Builder setAppName(String value)
      Sets the app name in Circonus.
      Parameters:
      value - the name of the app
      Returns:
      this builder

    • setAuthToken

      public CirconusSink.Builder setAuthToken(String value)
      Sets the auth token.
      Parameters:
      value - the auth token
      Returns:
      this builder

    • setSafeHttps

      public CirconusSink.Builder setSafeHttps(Boolean value)
      Sets the safety of HTTPS. Optional. Default is true. Setting this to false will accept any certificate and disables the hostname verifier. You may also need to supply the "-Djsse.enableSNIExtension=false" JVM argument to disable SNI.
      Parameters:
      value - the authentication token
      Returns:
      this Builder

    • setMaximumConcurrency

      public CirconusSink.Builder setMaximumConcurrency(Integer value)
      Sets the maximum concurrency of the http requests. Optional. Cannot be null. Default is 1. Minimum is 1.
      Parameters:
      value - the maximum concurrency
      Returns:
      this builder

    • setSpreadPeriod

      public CirconusSink.Builder setSpreadPeriod(Duration value)
      Sets the maximum delay before starting to send data to the server. Optional. Cannot be null. Default is 0.
      Parameters:
      value - the maximum delay before sending new data
      Returns:
      this builder

    • setMaximumQueueSize

      public CirconusSink.Builder setMaximumQueueSize(Integer value)
      Sets the maximum pending queue size. Optional Cannot be null. Default is 2500. Minimum is 1.
      Parameters:
      value - the maximum pending queue size
      Returns:
      this builder

    • setEnableHistograms

      public CirconusSink.Builder setEnableHistograms(Boolean value)
      Controls publication of histograms. Optional. Default is false.
      Parameters:
      value - true to enable histograms
      Returns:
      this Builder

    • setPartitionSet

      public CirconusSink.Builder setPartitionSet(PartitionSet value)
      Sets the partition set to partition check bundles. Required. Cannot be null.
      Parameters:
      value - a partition set
      Returns:
      this Builder

    • self

      protected CirconusSink.Builder self()
      Called by setters to always return appropriate subclass of CirconusSink.Builder, even from setters of base class.
      Specified by:
      self in class BaseSink.Builder<CirconusSink.Builder,CirconusSink>
      Returns:
      instance with correct CirconusSink.Builder class type.