com.twitter.util.events

Sink

trait Sink extends AnyRef

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
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Sink
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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(...)
    }
  2. 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

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. 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(...)
    }
  18. def recording_=(enabled: Boolean): Unit

    Update the current state of recording.

    Update the current state of recording.

    For Java compatibility see setRecording.

  19. def setRecording(enabled: Boolean): Unit

    Update the current state of recording.

    Update the current state of recording.

    Java compatibility for recording_=.

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

    Definition Classes
    AnyRef
  21. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped