Class/Object

Context

Related Docs: object Context | package context

Permalink

class Context extends AnyRef

An immutable set of information that is tied to the processing of single operation in a service. A Context instance can contain tags and entries.

Context tags are built on top of the TagSet abstraction that ships with Kamon and since Kamon knows exactly what types of values can be included in a TagSet it can automatically serialize and deserialize them when going over HTTP and/or Binary transports.

Context entries can contain any arbitrary type specified by the user, but require additional configuration and implementation of entry readers and writers if you need them to go over HTTP and/or Binary transports.

Context instances are meant to be constructed by using the builder functions on the Context companion object.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Context
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def entries(): Iterator[Entry]

Returns a loosely typed iterator of all entries in this Context.
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] )
def get[T](key: Key[T]): T

Gets an entry from this Context.
Gets an entry from this Context. If the entry is present it's current value is returned, otherwise the empty value from the provided key will be returned.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getTag[T](lookup: Lookup[T]): T

Executes a lookup on the context tags.
Executes a lookup on the context tags. The actual return type depends on the provided lookup instance. Take a look at the built-in lookups available on the Lookups companion object.
def hashCode(): Int

Definition Classes
AnyRef → Any
def isEmpty(): Boolean

Returns whether this Context does not have any tags and does not have any entries.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def nonEmpty(): Boolean

Returns whether this Context has any information, either as tags or entries.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tags: TagSet
def toString(): String

Definition Classes
Context → 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( ... )
def withEntry[T](key: Key[T], value: T): Context

Creates a new Context instance that includes the provided key and value.
Creates a new Context instance that includes the provided key and value. If the provided key was already associated with another value then the previous value will be discarded and overwritten with the provided one.
def withTag(key: String, value: Boolean): Context

Creates a new Context instance that includes the provided tag key and value.
Creates a new Context instance that includes the provided tag key and value. If the provided tag key was already associated with another value then the previous tag value will be discarded and overwritten with the provided one.
def withTag(key: String, value: Long): Context

Creates a new Context instance that includes the provided tag key and value.
Creates a new Context instance that includes the provided tag key and value. If the provided tag key was already associated with another value then the previous tag value will be discarded and overwritten with the provided one.
def withTag(key: String, value: String): Context

Creates a new Context instance that includes the provided tag key and value.
Creates a new Context instance that includes the provided tag key and value. If the provided tag key was already associated with another value then the previous tag value will be discarded and overwritten with the provided one.
def withTags(tags: TagSet): Context

Creates a new Context instance that includes the provided tags.
Creates a new Context instance that includes the provided tags. If any of the tags in this instance are associated to a key present on the provided tags then the previous values will be discarded and overwritten with the provided ones.
def withoutEntry[T](key: Key[T]): Context

Creates a new Context without the specified Context entry.

Inherited from AnyRef

Inherited from Any

Ungrouped