Kamon

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 _metricRegistry: MetricRegistry

   

   Attributes

   protected

   Definition Classes

   Metrics

5. val _moduleRegistry: ModuleRegistry

   

   Attributes

   protected

   Definition Classes

   ModuleLoading

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def attachInstrumentation(): Unit

   

   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]]

   

   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 changeClassLoader(classLoader: ClassLoader): Unit

   

   Changes the ClassLoader used by Kamon to load resources and dynamically created instances.

   Changes the ClassLoader used by Kamon to load resources and dynamically created instances.

   Definition Classes

   ClassLoading

10. def classLoader(): ClassLoader

    

    Returns the ClassLoader used by Kamon to load resources and dynamically created instances.

    Returns the ClassLoader used by Kamon to load resources and dynamically created instances.

    Definition Classes

    ClassLoading

11. def clientSpanBuilder(operationName: String, component: String): SpanBuilder

    

    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

12. def clock(): Clock

    

    Kamon's Clock implementation.

    Kamon's Clock implementation.

    Definition Classes

    Utilities

13. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

14. def config(): Config

    

    Retrieve Kamon's current configuration.

    Retrieve Kamon's current configuration.

    Definition Classes

    Configuration

15. def consumerSpanBuilder(operationName: String, component: String): SpanBuilder

    

    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

16. def counter(name: String, description: String, settings: ForValueInstrument): Counter

    

    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

17. def counter(name: String, description: String, unit: MeasurementUnit): Counter

    

    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

18. def counter(name: String, unit: MeasurementUnit): Counter

    

    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

19. def counter(name: String, description: String): Counter

    

    Creates or retrieves a Counter-backed metric

    Creates or retrieves a Counter-backed metric

    Definition Classes

    MetricBuilding

20. def counter(name: String): Counter

    

    Creates or retrieves a Counter-backed metric

    Creates or retrieves a Counter-backed metric

    Definition Classes

    MetricBuilding

21. def createInstance[T](clazz: Class[_], args: Seq[(Class[_], AnyRef)])(implicit arg0: ClassTag[T]): Try[T]

    

    Tries to create an instance of with the provided Class and constructor arguments.

    Tries to create an instance of with the provided Class and constructor arguments.

    Definition Classes

    ClassLoading

22. def createInstance[T](clazz: Class[_])(implicit arg0: ClassTag[T]): Try[T]

    

    Tries to create an instance of the provided Class with its no-arg constructor.

    Tries to create an instance of the provided Class with its no-arg constructor.

    Definition Classes

    ClassLoading

23. def createInstance[T](fqcn: String, args: Seq[(Class[_], AnyRef)])(implicit arg0: ClassTag[T]): Try[T]

    

    Tries to create an instance of a class with the provided fully-qualified class name and the provided constructor arguments.

    Tries to create an instance of a class with the provided fully-qualified class name and the provided constructor arguments.

    Definition Classes

    ClassLoading

24. def createInstance[T](fqcn: String)(implicit arg0: ClassTag[T]): Try[T]

    

    Tries to create an instance of a class with the provided fully-qualified class name and its no-arg constructor.

    Tries to create an instance of a class with the provided fully-qualified class name and its no-arg constructor.

    Definition Classes

    ClassLoading

25. def currentContext(): Context

    

    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

26. def currentSpan(): Span

    

    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

27. def defaultBinaryPropagation(): Propagation[ByteStreamReader, ByteStreamWriter]

    

    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

28. def defaultHttpPropagation(): Propagation[HeaderReader, HeaderWriter]

    

    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

29. def environment: Environment

    

    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

30. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

31. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

32. def filter(configKey: String): Filter

    

    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

33. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

34. def gauge(name: String, description: String, settings: ForValueInstrument): Gauge

    

    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

35. def gauge(name: String, description: String, unit: MeasurementUnit): Gauge

    

    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

36. def gauge(name: String, unit: MeasurementUnit): Gauge

    

    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

37. def gauge(name: String, description: String): Gauge

    

    Creates or retrieves a Gauge-backed metric

    Creates or retrieves a Gauge-backed metric

    Definition Classes

    MetricBuilding

38. def gauge(name: String): Gauge

    

    Creates or retrieves a Gauge-backed metric

    Creates or retrieves a Gauge-backed metric

    Definition Classes

    MetricBuilding

39. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

40. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

41. def histogram(name: String, description: String, settings: ForDistributionInstrument): Histogram

    

    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

42. def histogram(name: String, description: String, unit: MeasurementUnit, dynamicRange: DynamicRange): Histogram

    

    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

43. def histogram(name: String, unit: MeasurementUnit, dynamicRange: DynamicRange): Histogram

    

    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

44. def histogram(name: String, description: String, unit: MeasurementUnit): Histogram

    

    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

45. def histogram(name: String, unit: MeasurementUnit): Histogram

    

    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

46. def histogram(name: String, description: String): Histogram

    

    Creates or retrieves a Histogram-backed metric

    Creates or retrieves a Histogram-backed metric

    Definition Classes

    MetricBuilding

47. def histogram(name: String): Histogram

    

    Creates or retrieves a Histogram-backed metric

    Creates or retrieves a Histogram-backed metric

    Definition Classes

    MetricBuilding

48. def httpPropagation(channelName: String): Option[Propagation[HeaderReader, HeaderWriter]]

    

    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

49. def identifierScheme: Scheme

    

    Returns the Identifier Scheme currently used by the tracer.

    Returns the Identifier Scheme currently used by the tracer.

    Definition Classes

    Tracing

50. def init(config: Config): Unit

    

    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

51. def init(): Unit

    

    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

52. def internalSpanBuilder(operationName: String, component: String): SpanBuilder

    

    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

53. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

54. def loadModules(): Unit

    

    Loads modules from Kamon's configuration.

    Loads modules from Kamon's configuration.

    Definition Classes

    ModuleLoading

55. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

56. final def notify(): Unit

    

    Definition Classes

    AnyRef

57. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

58. def onReconfigure(hook: (Config) ⇒ Unit): Unit

    

    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

59. def onReconfigure(hook: OnReconfigureHook): Unit

    

    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

60. def producerSpanBuilder(operationName: String, component: String): SpanBuilder

    

    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

61. def rangeSampler(name: String, description: String, settings: ForDistributionInstrument): RangeSampler

    

    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

62. def rangeSampler(name: String, description: String, unit: MeasurementUnit, dynamicRange: DynamicRange): RangeSampler

    

    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

63. def rangeSampler(name: String, unit: MeasurementUnit, dynamicRange: DynamicRange): RangeSampler

    

    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

64. def rangeSampler(name: String, description: String, unit: MeasurementUnit, autoUpdateInterval: Duration): RangeSampler

    

    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

65. def rangeSampler(name: String, description: String, unit: MeasurementUnit): RangeSampler

    

    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

66. def rangeSampler(name: String, unit: MeasurementUnit, autoUpdateInterval: Duration): RangeSampler

    

    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

67. def rangeSampler(name: String, unit: MeasurementUnit): RangeSampler

    

    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

68. def rangeSampler(name: String, description: String): RangeSampler

    

    Creates or retrieves a RangeSampler-backed metric

    Creates or retrieves a RangeSampler-backed metric

    Definition Classes

    MetricBuilding

69. def rangeSampler(name: String): RangeSampler

    

    Creates or retrieves a RangeSampler-backed metric

    Creates or retrieves a RangeSampler-backed metric

    Definition Classes

    MetricBuilding

70. def reconfigure(newConfig: Config): Unit

    

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

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

    Definition Classes

    Configuration

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

    

    Register a module instantiated by the user.

    Register a module instantiated by the user.

    name

    Module name. Registration will fail if a module with the given name already exists.

    module

    The module instance.

    returns

    A Registration that can be used to de-register the module at any time.

    Definition Classes

    ModuleLoading

72. def registry(): MetricRegistry

    

    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

    Metrics → MetricBuilding

73. def resolveClass[T](fqcn: String)(implicit arg0: ClassTag[T]): Try[Class[_ <: T]]

    

    Tries load a class with the provided fully-qualified class name.

    Tries load a class with the provided fully-qualified class name.

    Definition Classes

    ClassLoading

74. def scheduler(): ScheduledExecutorService

    

    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

75. def serverSpanBuilder(operationName: String, component: String): SpanBuilder

    

    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

76. def spanBuilder(operationName: String): SpanBuilder

    

    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

77. def status(): Status

    

    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

78. def stopModules(): Future[Unit]

    

    Stops all registered modules.

    Stops all registered modules. This includes automatically and programmatically registered modules.

    returns

    A future that completes when the stop callback on all available modules have been completed.

    Definition Classes

    ModuleLoading

79. def store(context: Context): Scope

    

    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

80. def storeContext[T](context: Context)(f: ⇒ T): T

    

    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()

81. def storeContextKey[T, K](key: Key[K], value: K)(f: ⇒ T): T

    

    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

82. def storeContextTag[T](key: String, value: Long)(f: ⇒ T): T

    

    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

83. def storeContextTag[T](key: String, value: Boolean)(f: ⇒ T): T

    

    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

84. def storeContextTag[T](key: String, value: String)(f: ⇒ T): T

    

    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

85. def storeSpan[T](span: Span, finishSpan: Boolean)(f: ⇒ T): T

    

    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()

86. def storeSpan[T](span: Span)(f: ⇒ T): T

    

    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

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

    

    Definition Classes

    AnyRef

88. def timer(name: String, description: String, dynamicRange: DynamicRange): Timer

    

    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

89. def timer(name: String, dynamicRange: DynamicRange): Timer

    

    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

90. def timer(name: String, description: String): Timer

    

    Creates or retrieves a Timer-backed metric

    Creates or retrieves a Timer-backed metric

    Definition Classes

    MetricBuilding

91. def timer(name: String): Timer

    

    Creates or retrieves a Timer-backed metric

    Creates or retrieves a Timer-backed metric

    Definition Classes

    MetricBuilding

92. def toString(): String

    

    Definition Classes

    AnyRef → Any

93. def tracer(): Tracer

    

    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

94. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

95. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

96. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )