Module

Modules provide additional capabilities to Kamon, like collecting JVM metrics or exporting the metrics and trace data to external services. Additionally, modules can be automatically registered in Kamon by simply being present in the classpath and having the appropriate entry in the configuration file. All modules get a dedicated execution context which will be used to call the stop and reconfigure hooks, as well as any data processing callbacks.

Besides the basic lifecycle hooks, when registering a MetricReporter and/or SpanReporter module, Kamon will also schedule calls to MetricReporter.reportPeriodSnapshot() and SpanReporter.reportSpans() in the module's execution context.

Linear Supertypes

AnyRef, Any

Known Subclasses

CombinedReporter, MetricReporter, SpanReporter, Wrapped

Abstract Value Members

abstract def reconfigure(newConfig: Config): Unit

Signals that a new configuration object has been provided to Kamon.
Signals that a new configuration object has been provided to Kamon. Modules should ensure that their internal settings are in sync with the provided configuration.
abstract def stop(): Unit

Signals that the module should be stopped and all acquired resources, if any, should be released.

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
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 Module | package module

trait Module extends AnyRef

Abstract Value Members

abstract def reconfigure(newConfig: Config): Unit

abstract def stop(): Unit

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

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