Client

A Censorinus client! You should create one of these and reuse it across your application.

If maxBatchSize is defined, metrics will be batched before being sent to sender. The maxBatchSize param controls the maximum size of the ByteBuffers sent to sender. This should generally be smaller than the maximum allowable size of UDP packets on the system.

Linear Supertypes

AnyRef, Any

Known Subclasses

DogStatsDClient, StatsDClient

Instance Constructors

new Client(encoder: MetricEncoder, sender: MetricSender, prefix: String = "", defaultSampleRate: Double = 1.0, asynchronous: Boolean = true, maxQueueSize: Option[Int] = None, consecutiveDropWarnThreshold: Long = 1000, consecutiveDroppedMetrics: AtomicLong = new AtomicLong(0), maxBatchSize: Option[Int] = None)

Creates a new client instance
Creates a new client instance
encoder
The MetricEncoder implementation this client will use
sender
The MetricSender implementation this client will use
prefix
A prefix to add to all metric names. A period will be added to the end, resulting in prefix.metricname.
defaultSampleRate
A sample rate default to be used for all metric methods. Defaults to 1.0
asynchronous
True if you want the client to asynch, false for blocking!
maxQueueSize
Maximum amount of metrics allowed to be queued at a time.
maxBatchSize
maximum size of byte buffer supplied to sender

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
val consecutiveDroppedMetrics: AtomicLong
val defaultSampleRate: Double

A sample rate default to be used for all metric methods.
A sample rate default to be used for all metric methods. Defaults to 1.0
def enqueue(metric: Metric, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def makeName(name: String): String

Attributes
protected
val maxBatchSize: Option[Int]

maximum size of byte buffer supplied to sender
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def shutdown(): Unit

Explicitly shut down the client and it's underlying bits.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Docs: object Client | package censorinus

class Client extends AnyRef

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val consecutiveDroppedMetrics: AtomicLong

val defaultSampleRate: Double

def enqueue(metric: Metric, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def makeName(name: String): String

val maxBatchSize: Option[Int]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def shutdown(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped