Packages

object OpenTelemetry

The entrypoint to telemetry functionality for tracing, metrics, logging and baggage.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpenTelemetry
  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 baggage(logAnnotated: Boolean = false): URLayer[ContextStorage, Baggage]

    Use when you need to pass contextual information between spans.

    Use when you need to pass contextual information between spans.

    logAnnotated

    propagate ZIO log annotations as Baggage key/values if it is set to true

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  7. def contextJVM: ULayer[ContextStorage]

    Use when you use automatic instrumentation.

  8. def contextZIO: ULayer[ContextStorage]

    Use when you do not use automatic instrumentation.

  9. def custom(zio: ⇒ ZIO[Scope, Throwable, OpenTelemetry]): TaskLayer[OpenTelemetry]

    Use when you need to configure an instance of OpenTelemetry programmatically.

    Use when you need to configure an instance of OpenTelemetry programmatically.

    Example: https://github.com/zio/zio-telemetry/blob/series/2.x/opentelemetry-example/src/main/scala/zio/telemetry/opentelemetry/example/otel/OtelSdk.scala

    zio

    scoped ZIO value that returns a configured instance of io.opentelemetry.api.OpenTelemetry, thus ensuring that the returned instance will be closed.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. val global: TaskLayer[OpenTelemetry]

    A global singleton for the entrypoint to telemetry functionality for tracing, metrics, logging and baggage.

    A global singleton for the entrypoint to telemetry functionality for tracing, metrics, logging and baggage. Should be used with SDK Autoconfiguration module and/or Automatic instrumentation Java agent.

    See also

    Usage with OpenTelemetry automatic instrumentation

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def logging(instrumentationScopeName: String, logLevel: LogLevel = LogLevel.Info): URLayer[OpenTelemetry with ContextStorage, Unit]

    Use when you need to propagate calls to ZIO.log* as OTEL Log signals.

    Use when you need to propagate calls to ZIO.log* as OTEL Log signals.

    instrumentationScopeName

    name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name

    logLevel

    configures the logger to propagate the log records only when the log level is more than specified

  17. def metrics(instrumentationScopeName: String, instrumentationVersion: Option[String] = None, schemaUrl: Option[String] = None, logAnnotated: Boolean = false): URLayer[OpenTelemetry with ContextStorage, Meter with Builder]

    Use when you need to instrument metrics manually.

    Use when you need to instrument metrics manually.

    instrumentationScopeName

    name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name

    instrumentationVersion

    version of the instrumentation scope (e.g., "1.0.0")

    schemaUrl

    schema URL

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val noop: ULayer[OpenTelemetry]
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def tracing(instrumentationScopeName: String, instrumentationVersion: Option[String] = None, schemaUrl: Option[String] = None, logAnnotated: Boolean = false): URLayer[OpenTelemetry with ContextStorage, Tracing]

    Use when you need to instrument spans manually.

    Use when you need to instrument spans manually.

    instrumentationScopeName

    name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name

    instrumentationVersion

    version of the instrumentation scope (e.g., "1.0.0")

    schemaUrl

    schema URL

  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def zioMetrics: URLayer[Builder, Unit]

    Use when you want to allow a seamless integration with ZIO runtime and JVM metrics.

    Use when you want to allow a seamless integration with ZIO runtime and JVM metrics.

    By default this layer enables the propagation of ZIO runtime metrics only. For JVM metrics you need to provide DefaultJvmMetrics.live.unit.

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