Packages

o

kamon.util

EnvironmentTags

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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EnvironmentTags
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. 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.

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

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

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. object TagKeys

Inherited from AnyRef

Inherited from Any

Ungrouped