object EnvironmentTags
Utility class for creating TagSet instances out of Environment instances. When an Environment is turned into tags it will generate the following pairs:
- "service", with the service name from the Environment
- "host", with the host name from the Environment
- "instance", with the instance name from the Environment
- One additional pair for each Environment tag, unless exclusions are provided when transforming.
Most uses of this class are expected to happen in reporter modules, where the Environment information should usually be exposed along with the metrics and spans.
- Alphabetic
- By Inheritance
- EnvironmentTags
- AnyRef
- Any
- Hide All
- Show All
- 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(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def from(environment: Environment, includeService: Boolean, includeHost: Boolean, includeInstance: Boolean, exclude: Set[String]): TagSet
Turns the information enclosed in the provided Environment instance into a TagSet.
- def from(environment: Environment, config: Config): TagSet
Returns a TagSet instance with information from the provided Environment, using the provided Config to read the configuration settings for the transformation.
Returns a TagSet instance with information from the provided Environment, using the provided Config to read the configuration settings for the transformation. The configuration is expected to have the following structure:
config { include-host = yes include-service = yes include-instance = yes exclude = [ ] }
If any of the settings are missing this function will default to include all Environment information.
- def from(environment: Environment, path: String): TagSet
Returns a TagSet instance with information from the provided Environment, using the provided config path to retrieve the settings for the transformation from Kamon's Config.
Returns a TagSet instance with information from the provided Environment, using the provided config path to retrieve the settings for the transformation from Kamon's Config. The configuration on the provided path is expected to have the following structure:
config { include-host = yes include-service = yes include-instance = yes exclude = [ ] }
If any of the settings are missing this function will default to include all Environment information.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- object TagKeys