Object

kamon

Kamon

Related Doc: package kamon

Permalink

object Kamon extends Configuration with Utilities with Metrics with Tracing with ModuleLoading with ContextPropagation with ContextStorage with CurrentStatus with Init

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Kamon
  2. Init
  3. CurrentStatus
  4. ContextStorage
  5. ContextPropagation
  6. ModuleLoading
  7. Tracing
  8. Metrics
  9. MetricBuilding
  10. Utilities
  11. Configuration
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val _metricRegistry: MetricRegistry

    Permalink
    Attributes
    protected
    Definition Classes
    Metrics
  5. val _moduleRegistry: ModuleRegistry

    Permalink
    Attributes
    protected
    Definition Classes
    ModuleLoading
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def attachInstrumentation(): Unit

    Permalink

    Tries to attach the Kanela instrumentation agent, if the Kamon Bundle dependency is available on the classpath.

    Tries to attach the Kanela instrumentation agent, if the Kamon Bundle dependency is available on the classpath. If the Status module indicates that instrumentation has been already applied this method will not try to do anything.

    Definition Classes
    Init
  8. def binaryPropagation(channelName: String): Option[Propagation[ByteStreamReader, ByteStreamWriter]]

    Permalink

    Retrieves the binary propagation channel with the supplied name.

    Retrieves the binary propagation channel with the supplied name. Propagation channels are configured on the kamon.propagation.binary configuration section.

    Definition Classes
    ContextPropagation
  9. def clientSpanBuilder(operationName: String, component: String): SpanBuilder

    Permalink

    Creates a new SpanBuilder for a Client Span and applies the provided component name as a metric tag.

    Creates a new SpanBuilder for a Client Span and applies the provided component name as a metric tag. It is recommended that all Spans include a "component" metric tag that indicates what library or library section is generating the Span.

    Definition Classes
    Tracing
  10. def clock(): Clock

    Permalink

    Kamon's Clock implementation.

    Kamon's Clock implementation.

    Definition Classes
    Utilities
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def config(): Config

    Permalink

    Retrieve Kamon's current configuration.

    Retrieve Kamon's current configuration.

    Definition Classes
    Configuration
  13. def consumerSpanBuilder(operationName: String, component: String): SpanBuilder

    Permalink

    Creates a new SpanBuilder for a Consumer Span and applies the provided component name as a metric tag.

    Creates a new SpanBuilder for a Consumer Span and applies the provided component name as a metric tag. It is recommended that all Spans include a "component" metric tag that indicates what library or library section is generating the Span.

    Definition Classes
    Tracing
  14. def counter(name: String, description: String, settings: ForValueInstrument): Counter

    Permalink

    Creates or retrieves a Counter-backed metric with the provided settings

    Creates or retrieves a Counter-backed metric with the provided settings

    Definition Classes
    MetricBuilding
  15. def counter(name: String, description: String, unit: MeasurementUnit): Counter

    Permalink

    Creates or retrieves a Counter-backed metric with the provided unit

    Creates or retrieves a Counter-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  16. def counter(name: String, unit: MeasurementUnit): Counter

    Permalink

    Creates or retrieves a Counter-backed metric with the provided unit

    Creates or retrieves a Counter-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  17. def counter(name: String, description: String): Counter

    Permalink

    Creates or retrieves a Counter-backed metric

    Creates or retrieves a Counter-backed metric

    Definition Classes
    MetricBuilding
  18. def counter(name: String): Counter

    Permalink

    Creates or retrieves a Counter-backed metric

    Creates or retrieves a Counter-backed metric

    Definition Classes
    MetricBuilding
  19. def currentContext(): Context

    Permalink

    Returns the current Context on Kamon's Context Storage.

    Returns the current Context on Kamon's Context Storage. As the default behavior, this will return Context.Empty if no other Context has been stored on the calling thread.

    Definition Classes
    ContextStorage
  20. def currentSpan(): Span

    Permalink

    Returns the Span held by the current Context, if any.

    Returns the Span held by the current Context, if any. As the default behavior, this will return Span.Empty if the current Context does not contain a Span.

    Definition Classes
    ContextStorage
  21. def defaultBinaryPropagation(): Propagation[ByteStreamReader, ByteStreamWriter]

    Permalink

    Retrieves the default binary propagation channel.

    Retrieves the default binary propagation channel. Configuration for this channel can be found under the kamon.propagation.binary.default configuration section.

    Definition Classes
    ContextPropagation
  22. def defaultHttpPropagation(): Propagation[HeaderReader, HeaderWriter]

    Permalink

    Retrieves the default HTTP propagation channel.

    Retrieves the default HTTP propagation channel. Configuration for this channel can be found under the kamon.propagation.http.default configuration section.

    Definition Classes
    ContextPropagation
  23. def environment: Environment

    Permalink

    Returns the current enviroment instance constructed by Kamon using the "kamon.environment" settings.

    Returns the current enviroment instance constructed by Kamon using the "kamon.environment" settings.

    Definition Classes
    CurrentStatus
  24. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. def filter(configKey: String): Filter

    Permalink

    Creates a new composite Filter by looking up the provided key on Kamon's configuration.

    Creates a new composite Filter by looking up the provided key on Kamon's configuration. All inputs matching any of the include filters and none of the exclude filters will be accepted. The configuration is expected to have the following structure:

    config { includes = [ "some/pattern", "regex:some[0-9]" ] excludes = [ ] }

    By default, the patterns are treated as Glob patterns but users can explicitly configure the pattern type by prefixing the pattern with either "glob:" or "regex:". If any of the elements are missing they will be considered empty.

    Definition Classes
    Utilities
  27. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def gauge(name: String, description: String, settings: ForValueInstrument): Gauge

    Permalink

    Creates or retrieves a Gauge-backed metric with the provided settings

    Creates or retrieves a Gauge-backed metric with the provided settings

    Definition Classes
    MetricBuilding
  29. def gauge(name: String, description: String, unit: MeasurementUnit): Gauge

    Permalink

    Creates or retrieves a Gauge-backed metric with the provided unit

    Creates or retrieves a Gauge-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  30. def gauge(name: String, unit: MeasurementUnit): Gauge

    Permalink

    Creates or retrieves a Gauge-backed metric with the provided unit

    Creates or retrieves a Gauge-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  31. def gauge(name: String, description: String): Gauge

    Permalink

    Creates or retrieves a Gauge-backed metric

    Creates or retrieves a Gauge-backed metric

    Definition Classes
    MetricBuilding
  32. def gauge(name: String): Gauge

    Permalink

    Creates or retrieves a Gauge-backed metric

    Creates or retrieves a Gauge-backed metric

    Definition Classes
    MetricBuilding
  33. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  35. def histogram(name: String, description: String, settings: ForDistributionInstrument): Histogram

    Permalink

    Creates or retrieves a Histogram-backed metric with the provided settings

    Creates or retrieves a Histogram-backed metric with the provided settings

    Definition Classes
    MetricBuilding
  36. def histogram(name: String, description: String, unit: MeasurementUnit, dynamicRange: DynamicRange): Histogram

    Permalink

    Creates or retrieves a Histogram-backed metric with the provided unit and dynamic range

    Creates or retrieves a Histogram-backed metric with the provided unit and dynamic range

    Definition Classes
    MetricBuilding
  37. def histogram(name: String, unit: MeasurementUnit, dynamicRange: DynamicRange): Histogram

    Permalink

    Creates or retrieves a Histogram-backed metric with the provided unit and dynamic range

    Creates or retrieves a Histogram-backed metric with the provided unit and dynamic range

    Definition Classes
    MetricBuilding
  38. def histogram(name: String, description: String, unit: MeasurementUnit): Histogram

    Permalink

    Creates or retrieves a Histogram-backed metric with the provided unit

    Creates or retrieves a Histogram-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  39. def histogram(name: String, unit: MeasurementUnit): Histogram

    Permalink

    Creates or retrieves a Histogram-backed metric with the provided unit

    Creates or retrieves a Histogram-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  40. def histogram(name: String, description: String): Histogram

    Permalink

    Creates or retrieves a Histogram-backed metric

    Creates or retrieves a Histogram-backed metric

    Definition Classes
    MetricBuilding
  41. def histogram(name: String): Histogram

    Permalink

    Creates or retrieves a Histogram-backed metric

    Creates or retrieves a Histogram-backed metric

    Definition Classes
    MetricBuilding
  42. def httpPropagation(channelName: String): Option[Propagation[HeaderReader, HeaderWriter]]

    Permalink

    Retrieves the HTTP propagation channel with the supplied name.

    Retrieves the HTTP propagation channel with the supplied name. Propagation channels are configured on the kamon.propagation.http configuration section.

    Definition Classes
    ContextPropagation
  43. def identifierScheme: Scheme

    Permalink

    Returns the Identifier Scheme currently used by the tracer.

    Returns the Identifier Scheme currently used by the tracer.

    Definition Classes
    Tracing
  44. def init(config: Config): Unit

    Permalink

    Reconfigures Kamon to use the provided configuration and then attempts to attach the instrumentation agent and start all registered modules.

    Reconfigures Kamon to use the provided configuration and then attempts to attach the instrumentation agent and start all registered modules.

    Definition Classes
    Init
  45. def init(): Unit

    Permalink

    Attempts to attach the instrumentation agent and start all registered modules.

    Attempts to attach the instrumentation agent and start all registered modules.

    Definition Classes
    Init
  46. def internalSpanBuilder(operationName: String, component: String): SpanBuilder

    Permalink

    Creates a new SpanBuilder for an Internal Span and applies the provided component name as a metric tag.

    Creates a new SpanBuilder for an Internal Span and applies the provided component name as a metric tag. It is recommended that all Spans include a "component" metric tag that indicates what library or library section is generating the Span.

    Definition Classes
    Tracing
  47. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  48. def loadModules(): Unit

    Permalink

    Loads modules from Kamon's configuration.

    Loads modules from Kamon's configuration.

    Definition Classes
    ModuleLoading
  49. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  50. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  51. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  52. def onReconfigure(hook: (Config) ⇒ Unit): Unit

    Permalink

    Register a reconfigure hook that will be run when the a call to Kamon.reconfigure(config) is performed.

    Register a reconfigure hook that will be run when the a call to Kamon.reconfigure(config) is performed. All registered hooks will run sequentially in the same Thread that calls Kamon.reconfigure(config).

    Definition Classes
    Configuration
  53. def onReconfigure(hook: OnReconfigureHook): Unit

    Permalink

    Register a reconfigure hook that will be run when the a call to Kamon.reconfigure(config) is performed.

    Register a reconfigure hook that will be run when the a call to Kamon.reconfigure(config) is performed. All registered hooks will run sequentially in the same Thread that calls Kamon.reconfigure(config).

    Definition Classes
    Configuration
  54. def producerSpanBuilder(operationName: String, component: String): SpanBuilder

    Permalink

    Creates a new SpanBuilder for a Producer Span and applies the provided component name as a metric tag.

    Creates a new SpanBuilder for a Producer Span and applies the provided component name as a metric tag. It is recommended that all Spans include a "component" metric tag that indicates what library or library section is generating the Span.

    Definition Classes
    Tracing
  55. def rangeSampler(name: String, description: String, settings: ForDistributionInstrument): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric with the provided settings

    Creates or retrieves a RangeSampler-backed metric with the provided settings

    Definition Classes
    MetricBuilding
  56. def rangeSampler(name: String, description: String, unit: MeasurementUnit, dynamicRange: DynamicRange): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric with the provided unit and dynamic range

    Creates or retrieves a RangeSampler-backed metric with the provided unit and dynamic range

    Definition Classes
    MetricBuilding
  57. def rangeSampler(name: String, unit: MeasurementUnit, dynamicRange: DynamicRange): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric with the provided unit and dynamic range

    Creates or retrieves a RangeSampler-backed metric with the provided unit and dynamic range

    Definition Classes
    MetricBuilding
  58. def rangeSampler(name: String, description: String, unit: MeasurementUnit, autoUpdateInterval: Duration): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric with the provided unit and auto-update interval

    Creates or retrieves a RangeSampler-backed metric with the provided unit and auto-update interval

    Definition Classes
    MetricBuilding
  59. def rangeSampler(name: String, description: String, unit: MeasurementUnit): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric with the provided unit

    Creates or retrieves a RangeSampler-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  60. def rangeSampler(name: String, unit: MeasurementUnit, autoUpdateInterval: Duration): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric with the provided unit and auto-update interval

    Creates or retrieves a RangeSampler-backed metric with the provided unit and auto-update interval

    Definition Classes
    MetricBuilding
  61. def rangeSampler(name: String, unit: MeasurementUnit): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric with the provided unit

    Creates or retrieves a RangeSampler-backed metric with the provided unit

    Definition Classes
    MetricBuilding
  62. def rangeSampler(name: String, description: String): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric

    Creates or retrieves a RangeSampler-backed metric

    Definition Classes
    MetricBuilding
  63. def rangeSampler(name: String): RangeSampler

    Permalink

    Creates or retrieves a RangeSampler-backed metric

    Creates or retrieves a RangeSampler-backed metric

    Definition Classes
    MetricBuilding
  64. def reconfigure(newConfig: Config): Unit

    Permalink

    Supply a new Config instance to rule Kamon's world.

    Supply a new Config instance to rule Kamon's world.

    Definition Classes
    Configuration
  65. def registerModule(name: String, description: String, module: Module, configPath: String): Registration

    Permalink

    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.

    Definition Classes
    ModuleLoading
  66. def registerModule(name: String, module: Module): Registration

    Permalink

    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.

    Definition Classes
    ModuleLoading
  67. def registry(): MetricRegistry

    Permalink

    Metric registry from which all metric-building APIs will draw instances.

    Metric registry from which all metric-building APIs will draw instances. For more details on the entire set of exposes APIs please refer to kamon.metric.MetricBuilding.

    Attributes
    protected
    Definition Classes
    MetricsMetricBuilding
  68. def runWithContext[T](context: Context)(f: ⇒ T): T

    Permalink

    Temporarily stores the provided Context on Kamon's Context Storage.

    Temporarily stores the provided Context on Kamon's Context Storage. The provided Context will be stored before executing the provided function and removed right after it finishes executing.

    Definition Classes
    ContextStorage
    Annotations
    @inline()
  69. def runWithContextEntry[T, K](key: Key[K], value: K)(f: ⇒ T): T

    Permalink

    Temporarily stores the provided Context Key on Kamon's Context Storage.

    Temporarily stores the provided Context Key on Kamon's Context Storage. The provided Context key will be added to the current Context and stored before executing the provided function, then removed right after execution finishes.

    Definition Classes
    ContextStorage
  70. def runWithContextTag[T](key: String, value: Long)(f: ⇒ T): T

    Permalink

    Temporarily stores the provided Context tag on Kamon's Context Storage.

    Temporarily stores the provided Context tag on Kamon's Context Storage. The provided Context tag will be added to the current Context and stored before executing the provided function, then removed right after execution finishes.

    Definition Classes
    ContextStorage
  71. def runWithContextTag[T](key: String, value: Boolean)(f: ⇒ T): T

    Permalink

    Temporarily stores the provided Context tag on Kamon's Context Storage.

    Temporarily stores the provided Context tag on Kamon's Context Storage. The provided Context tag will be added to the current Context and stored before executing the provided function, then removed right after execution finishes.

    Definition Classes
    ContextStorage
  72. def runWithContextTag[T](key: String, value: String)(f: ⇒ T): T

    Permalink

    Temporarily stores the provided Context tag on Kamon's Context Storage.

    Temporarily stores the provided Context tag on Kamon's Context Storage. The provided Context tag will be added to the current Context and stored before executing the provided function, then removed right after execution finishes.

    Definition Classes
    ContextStorage
  73. def runWithSpan[T](span: Span, finishSpan: Boolean)(f: ⇒ T): T

    Permalink

    Temporarily stores the provided Span on Kamon's Context Storage.

    Temporarily stores the provided Span on Kamon's Context Storage. The provided Span will be added to the current Context and stored before executing the provided function, then removed right after execution finishes. Optionally, this function can finish the provided Span once the function execution finishes.

    Definition Classes
    ContextStorage
    Annotations
    @inline()
  74. def runWithSpan[T](span: Span)(f: ⇒ T): T

    Permalink

    Temporarily stores the provided Span on Kamon's Context Storage.

    Temporarily stores the provided Span on Kamon's Context Storage. The provided Span will be added to the current Context and stored before executing the provided function, then removed right after execution finishes.

    Definition Classes
    ContextStorage
  75. def scheduler(): ScheduledExecutorService

    Permalink

    Scheduler to be used for Kamon-related tasks like updating range samplers.

    Scheduler to be used for Kamon-related tasks like updating range samplers.

    Definition Classes
    Utilities
  76. def serverSpanBuilder(operationName: String, component: String): SpanBuilder

    Permalink

    Creates a new SpanBuilder for a Server Span and applies the provided component name as a metric tag.

    Creates a new SpanBuilder for a Server Span and applies the provided component name as a metric tag. It is recommended that all Spans include a "component" metric tag that indicates what library or library section is generating the Span.

    Definition Classes
    Tracing
  77. def spanBuilder(operationName: String): SpanBuilder

    Permalink

    Creates a new raw SpanBuilder instance using the provided operation name.

    Creates a new raw SpanBuilder instance using the provided operation name.

    Definition Classes
    Tracing
  78. def status(): Status

    Permalink

    Returns an accessor to Kamon's current status.

    Returns an accessor to Kamon's current status. The current status information is split into four main sections:

    • Settings: which include the Kamon version, environment and configuration being used.
    • Module Registry: Lists all modules that have been detected on the classpath and their current state.
    • Metric Registry: Lists all metrics currently registered in Kamon and all instruments belonging to them.
    • Instrumentation: Lists all instrumentation modules that have been detected and their current state.

    All information exposed by the Status API represents an immutable snapshot of the state at the moment the status was requested.

    Definition Classes
    CurrentStatus
  79. def stopModules(): Future[Unit]

    Permalink

    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.

    Definition Classes
    ModuleLoading
  80. def storeContext(context: Context): Scope

    Permalink

    Stores the provided Context on Kamon's Context Storage and returns a Scope that removes that Context from the it upon closing.

    Stores the provided Context on Kamon's Context Storage and returns a Scope that removes that Context from the it upon closing. When a Scope is closed, it will always set the current Context to the Context that was available right before it was created.

    NOTE: The default implementation of Scope is not thread safe and, unless there is a good reason not to, users should always close scopes before leaving a thread, otherwise there is a risk of leaving "dirty" threads that could cause unexpected correlation between Contexts from different operations. It is strongly recommended to use any of the .storeContext(...) variants which ensure closing Scopes after finishing execution.

    Definition Classes
    ContextStorage
  81. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  82. def timer(name: String, description: String, dynamicRange: DynamicRange): Timer

    Permalink

    Creates or retrieves a Timer-backed metric with the provided unit and dynamic range

    Creates or retrieves a Timer-backed metric with the provided unit and dynamic range

    Definition Classes
    MetricBuilding
  83. def timer(name: String, dynamicRange: DynamicRange): Timer

    Permalink

    Creates or retrieves a Timer-backed metric with the provided unit and dynamic range

    Creates or retrieves a Timer-backed metric with the provided unit and dynamic range

    Definition Classes
    MetricBuilding
  84. def timer(name: String, description: String): Timer

    Permalink

    Creates or retrieves a Timer-backed metric

    Creates or retrieves a Timer-backed metric

    Definition Classes
    MetricBuilding
  85. def timer(name: String): Timer

    Permalink

    Creates or retrieves a Timer-backed metric

    Creates or retrieves a Timer-backed metric

    Definition Classes
    MetricBuilding
  86. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  87. def tracer(): Tracer

    Permalink

    The Tracer instance is only exposed to other Kamon components that need it like the Module Registry and Status

    The Tracer instance is only exposed to other Kamon components that need it like the Module Registry and Status

    Attributes
    protected
    Definition Classes
    Tracing
  88. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Init

Inherited from CurrentStatus

Inherited from ContextStorage

Inherited from ContextPropagation

Inherited from ModuleLoading

Inherited from Tracing

Inherited from Metrics

Inherited from MetricBuilding

Inherited from Utilities

Inherited from Configuration

Inherited from AnyRef

Inherited from Any

Ungrouped