t

com.daml.telemetry

TelemetryContext

trait TelemetryContext extends AnyRef

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

Abstract Value Members

  1. abstract def encodeMetadata(): Map[String, String]

    Encode the metadata of the context in a key-value map.

    Encode the metadata of the context in a key-value map.

    Typically, metadata is encoded in a map to allow transporting it across process boundaries. Originally, it has been created to carry tracing metadata across boundaries, and to create complete traces.

    See also

    com.daml.telemetry.Telemetry.contextFromMetadata(java.util.Map)

  2. abstract def openTelemetryContext: Context

    Returns a raw Open Telemetry context.

    Returns a raw Open Telemetry context. Should only be used by consumers that are using the Open Telemetry API directly.

    returns

    Open Telemetry context

  3. abstract def runFutureInNewSpan[T](spanName: String, kind: SpanKind, attributes: (SpanAttribute, String)*)(body: (TelemetryContext) => Future[T]): Future[T]

    Creates a new span and runs the computation inside it.

    Creates a new span and runs the computation inside it. The new span has its parent set as the span associated with the current context. A new context containing the new span is passed as parameter to the computation.

    spanName

    the name of the new span

    kind

    the kind of the new span

    attributes

    the key-value pairs to be set as attributes to the new span

    body

    the computation to be run in the new span

    returns

    the result of the computation

  4. abstract def runInNewSpan[T](spanName: String, kind: SpanKind, attributes: (SpanAttribute, String)*)(body: (TelemetryContext) => T): T

    Creates a new span and runs the computation inside it.

    Creates a new span and runs the computation inside it. The new span has its parent set as the span associated with the current context. A new context containing the new span is passed as parameter to the computation.

    spanName

    the name of the new span

    kind

    the kind of the new span

    attributes

    the key-value pairs to be set as attributes to the new span

    body

    the computation to be run in the new span

    returns

    the result of the computation

  5. abstract def runInOpenTelemetryScope[T](body: => T): T

    Runs the computation inside an OpenTelemetry scope.

    Runs the computation inside an OpenTelemetry scope.

    This is used to set the tracing metadata in the gRPC local thread context, so it can be accessed and used by the OpenTelemetry instrumentation to create complete traces.

    It should be used around gRPC calls, to ensure that the tracing metadata is correctly used and transferred.

    body

    the computation to be run in the Telemetry scope

    returns

    the result of the computation

  6. abstract def setAttribute(attribute: SpanAttribute, value: String): TelemetryContext

    Sets or replaces the value of attribute to value.

Concrete 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped