object OpenTelemetry
The entrypoint to telemetry functionality for tracing, metrics, logging and baggage.
- Alphabetic
- By Inheritance
- OpenTelemetry
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def contextJVM: ULayer[ContextStorage]
Use when you use automatic instrumentation.
- def contextZIO: ULayer[ContextStorage]
Use when you do not use automatic instrumentation.
- 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.
- zio
scoped ZIO value that returns a configured instance of io.opentelemetry.api.OpenTelemetry, thus ensuring that the returned instance will be closed.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val noop: ULayer[OpenTelemetry]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tracing(instrumentationScopeName: String, instrumentationVersion: Option[String] = None, schemaUrl: Option[String] = None): 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
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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.