StatsDClient

Instance Constructors

new StatsDClient(hostname: String = "localhost", port: Int = MetricSender.DEFAULT_STATSD_PORT, prefix: String = "", defaultSampleRate: Double = 1.0, asynchronous: Boolean = true, allowExceptions: Boolean = false)

Creates a new client instance
Creates a new client instance
hostname
the host to send metrics to, defaults to localhost
port
the port to send metrics to, defaults to 8125
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!
allowExceptions
If false, any SocketExceptions will be swallowed silently

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

Definition Classes
Client
def counter(name: String, value: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

Emit a counter metric.
Emit a counter metric.
name
The name of the metric
value
The value of the metric, or how much to increment by
sampleRate
The rate at which to sample this metric.
bypassSampler
If true, the metric will always be passed through, but the sample rate will be included in the emitted metric. This is useful for when you occasionally do your own sampling.
def decrement(name: String, value: Double = 1, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

Emit a decrement metric.
Emit a decrement metric.
name
The name of the metric
value
The value of the metric, or how much to decrement by. Defaults to -1
sampleRate
The rate at which to sample this metric.
bypassSampler
If true, the metric will always be passed through, but the sample rate will be included in the emitted metric. This is useful for when you occasionally do your own sampling.
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

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

Definition Classes
Client
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def gauge(name: String, value: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

Emit a gauge metric.
Emit a gauge metric.
name
The name of the metric
value
The value of the metric, or current value of the gauge
sampleRate
The rate at which to sample this metric.
bypassSampler
If true, the metric will always be passed through, but the sample rate will be included in the emitted metric. This is useful for when you occasionally do your own sampling.
final def getClass(): Class[_]

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

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def increment(name: String, value: Double = 1, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

Emit an increment metric.
Emit an increment metric.
name
The name of the metric
value
The value of the metric, or the amount to increment by. Defaults to 1
sampleRate
The rate at which to sample this metric.
bypassSampler
If true, the metric will always be passed through, but the sample rate will be included in the emitted metric. This is useful for when you occasionally do your own sampling.
final def isInstanceOf[T0]: Boolean

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

Attributes
protected
Definition Classes
Client
val maxBatchSize: Option[Int]

maximum size of byte buffer supplied to sender
maximum size of byte buffer supplied to sender

Definition Classes
Client
def meter(name: String, value: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

Emit a meter metric.
Emit a meter metric.
name
The name of the metric
value
The value of the meter
sampleRate
The rate at which to sample this metric.
bypassSampler
If true, the metric will always be passed through, but the sample rate will be included in the emitted metric. This is useful for when you occasionally do your own sampling.
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 set(name: String, value: String): Unit

Emit e a set metric.
Emit e a set metric.
name
The name of the metric
value
The item to add to the set
def shutdown(): Unit

Explicitly shut down the client and it's underlying bits.
Explicitly shut down the client and it's underlying bits.

Definition Classes
Client
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def timer(name: String, milliseconds: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

Emit a timer metric.
Emit a timer metric.
name
The name of the metric
sampleRate
The rate at which to sample this metric.
bypassSampler
If true, the metric will always be passed through, but the sample rate will be included in the emitted metric. This is useful for when you occasionally do your own sampling.
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): 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 Doc: package censorinus

class StatsDClient extends Client

Instance Constructors

new StatsDClient(hostname: String = "localhost", port: Int = MetricSender.DEFAULT_STATSD_PORT, prefix: String = "", defaultSampleRate: Double = 1.0, asynchronous: Boolean = true, allowExceptions: Boolean = false)

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

def counter(name: String, value: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

def decrement(name: String, value: Double = 1, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

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

def gauge(name: String, value: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

final def getClass(): Class[_]

def hashCode(): Int

def increment(name: String, value: Double = 1, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

final def isInstanceOf[T0]: Boolean

def makeName(name: String): String

val maxBatchSize: Option[Int]

def meter(name: String, value: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def set(name: String, value: String): Unit

def shutdown(): Unit

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

def timer(name: String, milliseconds: Double, sampleRate: Double = defaultSampleRate, bypassSampler: Boolean = false): Unit

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from Client

Inherited from AnyRef

Inherited from Any

Ungrouped