Kamon

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.

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

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.

Kamon's Clock implementation.

Retrieve Kamon's current configuration.

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.

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

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

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

Creates or retrieves a Counter-backed metric

Creates or retrieves a Counter-backed metric

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.

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.

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

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

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

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.

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

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

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

Creates or retrieves a Gauge-backed metric

Creates or retrieves a Gauge-backed metric

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

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

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

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

Creates or retrieves a Histogram-backed metric

Creates or retrieves a Histogram-backed metric

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

Returns the Identifier Scheme currently used by the tracer.

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

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

Initializes Kamon without trying to attach the instrumentation agent from the Kamon Bundle.

Initializes Kamon without trying to attach the instrumentation agent from the Kamon Bundle.

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.

Loads modules from Kamon's configuration.

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

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

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.

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

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

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

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

Creates or retrieves a RangeSampler-backed metric

Creates or retrieves a RangeSampler-backed metric

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

Creates an Internal Span that finishes automatically when the provided function finishes execution. If the provided function returns a scala.concurrent.Future or java.util.concurrent.CompletionStage implementation then the Span will be finished with the Future/CompletionState completes.

You can get access to the created Span within the provided function using Kamon.currentSpan. For example, if you wanted to add a tag to a Span created with this function you could do it as follows:

span("fetchUserDetails") { Kamon.currentSpan.tag("user.id", userId)

// Your business logic... }

If you need more customization options for the Span or complete control over Context propagation and Span lifecycle then create a SpanBuilder instead.

Creates an Internal Span that finishes automatically when the provided function finishes execution. If the provided function returns a scala.concurrent.Future or java.util.concurrent.CompletionStage implementation then the Span will be finished with the Future/CompletionState completes.

You can get access to the created Span within the provided function using Kamon.currentSpan. For example, if you wanted to add a tag to a Span created with this function you could do it as follows:

span("fetchUserDetails") { Kamon.currentSpan.tag("user.id", userId)

// Your business logic... }

If you need more customization options for the Span or complete control over Context propagation and Span lifecycle then create a SpanBuilder instead.

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

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.

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.

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.

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

Creates or retrieves a Timer-backed metric

Creates or retrieves a Timer-backed metric

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

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.