Packages

t

kamon

ModuleManagement

trait ModuleManagement extends AnyRef

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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ModuleManagement
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val _moduleRegistry: ModuleRegistry
    Attributes
    protected
  5. def addReporter(name: String, description: String, reporter: MetricReporter, metricFilter: Filter): Registration
  6. def addReporter(name: String, reporter: MetricReporter, metricFilter: Filter): Registration
  7. def addReporter(name: String, reporter: MetricReporter): Registration
  8. def addReporter(name: String, description: String, reporter: SpanReporter): Registration
  9. def addReporter(name: String, reporter: SpanReporter): Registration
  10. def addScheduledAction(name: String, description: Option[String], collector: ScheduledAction, interval: Duration): Registration
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def loadModules(): Unit

    Loads modules from Kamon's configuration.

  20. def moduleRegistry(): ModuleRegistry
    Attributes
    protected
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. 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.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. 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

  2. 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

Inherited from AnyRef

Inherited from Any

Ungrouped