Sink

Where runtime events such as logging, stats and tracing can be sent to allow for analysis.

Note: while the API is public it should be considered as experimental and subject to changes.

Design notes

Implementations must be thread-safe.
Implementations should have very low runtime overhead such that as many events as possible can be sent here. In particular, object allocations should be kept to a minimum.
event is expected to be called many orders of magnitude more frequently than events.

Linear Supertypes

AnyRef, Any

Known Subclasses

SizedSink

Abstract Value Members

abstract def event(etype: Type, longVal: Long = Event.NoLong, objectVal: AnyRef = Event.NoObject, doubleVal: Double = Event.NoDouble, traceIdVal: Long = Event.NoTraceId, spanIdVal: Long = Event.NoSpanId): Unit

Event input is captured as individual fields in service of avoiding an allocation to wrap the event.
Event input is captured as individual fields in service of avoiding an allocation to wrap the event.
Note that callers should check recording before calling into this method:
```
if (sink.recording) {
  sink.event(...)
}
```
abstract def events: Iterator[Event]

Returns all currently available events.
Returns all currently available events.
Note: the events are not returned in any particular order.

Concrete 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
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def recording: Boolean

Whether or not this sink should be recording events.
Whether or not this sink should be recording events.
This is external to the event() and managed by caller because there is some expense in capturing the data sent to that call.
The expectation is for callers to do:
```
if (sink.recording) {
  sink.event(...)
}
```
def recording_=(enabled: Boolean): Unit

Update the current state of recording.
Update the current state of recording.
For Java compatibility see setRecording.
def setRecording(enabled: Boolean): Unit

Update the current state of recording.
Update the current state of recording.
Java compatibility for recording_=.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )

Related Docs: object Sink | package events

trait Sink extends AnyRef

Design notes

Abstract Value Members

abstract def event(etype: Type, longVal: Long = Event.NoLong, objectVal: AnyRef = Event.NoObject, doubleVal: Double = Event.NoDouble, traceIdVal: Long = Event.NoTraceId, spanIdVal: Long = Event.NoSpanId): Unit

abstract def events: Iterator[Event]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def recording: Boolean

def recording_=(enabled: Boolean): Unit

def setRecording(enabled: Boolean): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped