ModuleManagement

Handles the lifecycle of all modules known by Kamon. The most common implementations of modules are metrics and span reporters, but modules can be used to encapsulate any process that should be started automatically by Kamon and stopped when all modules are stopped (usually during shutdown).

Modules can be automatically discovered from the kamon.modules configuration path, using the following schema:

kamon.modules { module-name { enabled = true name = "My Module Name" description = "A module description" factory = "com.example.MyModuleFactory"

// For Metric Reporters only: metric-filter { includes = [] excludes = [] }

// For Periodic Collectors only: interval = 10 seconds } }

Take a look at the reference.conf file for more details.

Self Type: ModuleManagement with Configuration with Utilities with Metrics with Tracing with ContextStorage

Linear Supertypes

AnyRef, Any

Known Subclasses

Kamon

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
val _moduleRegistry: ModuleRegistry

Attributes
protected
def addReporter(name: String, description: String, reporter: MetricReporter, metricFilter: Filter): Registration
def addReporter(name: String, reporter: MetricReporter, metricFilter: Filter): Registration
def addReporter(name: String, reporter: MetricReporter): Registration
def addReporter(name: String, description: String, reporter: SpanReporter): Registration
def addReporter(name: String, reporter: SpanReporter): Registration
def addScheduledAction(name: String, description: Option[String], collector: ScheduledAction, interval: Duration): Registration
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
def loadModules(): Unit

Loads modules from Kamon's configuration.
def moduleRegistry(): ModuleRegistry

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def stopModules(): Future[Unit]

Stops all registered modules and returns a future that completes when the stop callback on all available modules have been completed.
Stops all registered modules and returns a future that completes when the stop callback on all available modules have been completed. This includes automatically and programmatically registered modules.
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( ... )

Deprecated Value Members

def registerModule(name: String, description: String, module: Module, configPath: String): Registration

Register a module instantiated by the user and returns a Registration that can be used to stop and deregister the module at any time.
Register a module instantiated by the user and returns a Registration that can be used to stop and deregister the module at any time.

Annotations
@deprecated
Deprecated
(Since version 2.3.0) Use addReporter or addScheduledAction instead
def registerModule(name: String, module: Module): Registration

Register a module instantiated by the user and returns a Registration that can be used to stop and deregister the module at any time.
Register a module instantiated by the user and returns a Registration that can be used to stop and deregister the module at any time.

Annotations
@deprecated
Deprecated
(Since version 2.3.0) Use addReporter or addScheduledAction instead

Related Doc: package kamon

trait ModuleManagement extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val _moduleRegistry: ModuleRegistry

def addReporter(name: String, description: String, reporter: MetricReporter, metricFilter: Filter): Registration

def addReporter(name: String, reporter: MetricReporter, metricFilter: Filter): Registration

def addReporter(name: String, reporter: MetricReporter): Registration

def addReporter(name: String, description: String, reporter: SpanReporter): Registration

def addReporter(name: String, reporter: SpanReporter): Registration

def addScheduledAction(name: String, description: Option[String], collector: ScheduledAction, interval: Duration): Registration

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

def loadModules(): Unit

def moduleRegistry(): ModuleRegistry

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def stopModules(): Future[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

Deprecated Value Members

def registerModule(name: String, description: String, module: Module, configPath: String): Registration

def registerModule(name: String, module: Module): Registration

Inherited from AnyRef

Inherited from Any

Ungrouped