AWS | X-Ray propagator
The X-Ray propagator implements AWS X-Ray Trace Header propagation protocol.
The propagator utilizes X-Amzn-Trace-Id
header to extract and inject tracing details.
An example of the AWS X-Ray Tracing Header:
X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1
Getting Started
Add settings to the build.sbt
:
libraryDependencies ++= Seq(
"org.typelevel" %%% "otel4s-sdk" % "0.11.0", // <1>
"org.typelevel" %%% "otel4s-sdk-exporter" % "0.11.0", // <2>
"org.typelevel" %%% "otel4s-sdk-contrib-aws-xray-propagator" % "0.11.0" // <3>
)
Add directives to the *.scala
file:
//> using lib "org.typelevel::otel4s-sdk::0.11.0" // <1>
//> using lib "org.typelevel::otel4s-sdk-exporter::0.11.0" // <2>
//> using lib "org.typelevel::otel4s-sdk-contrib-aws-xray-propagator::0.11.0" // <3>
- Add the
otel4s-sdk
library - Add the
otel4s-sdk-exporter
library. Without the exporter, the application will crash - Add the
otel4s-sdk-contrib-aws-xray-propagator
library
Then autoconfigure the SDK:
OpenTelemetrySdk.autoConfigured
configures both MeterProvider
and TracerProvider
:
import cats.effect.{IO, IOApp}
import org.typelevel.otel4s.metrics.MeterProvider
import org.typelevel.otel4s.sdk.OpenTelemetrySdk
import org.typelevel.otel4s.sdk.contrib.aws.context.propagation._
import org.typelevel.otel4s.sdk.exporter.otlp.autoconfigure.OtlpExportersAutoConfigure
import org.typelevel.otel4s.trace.TracerProvider
object TelemetryApp extends IOApp.Simple {
def run: IO[Unit] =
OpenTelemetrySdk
.autoConfigured[IO](
// register OTLP exporters configurer
_.addExportersConfigurer(OtlpExportersAutoConfigure[IO])
// add AWS X-Ray Propagator
.addTracerProviderCustomizer((b, _) =>
b.addTextMapPropagators(AwsXRayPropagator())
)
)
.use { autoConfigured =>
val sdk = autoConfigured.sdk
program(sdk.meterProvider, sdk.tracerProvider)
}
def program(
meterProvider: MeterProvider[IO],
tracerProvider: TracerProvider[IO]
): IO[Unit] =
???
}
SdkTraces
configures only TracerProvider
:
import cats.effect.{IO, IOApp}
import org.typelevel.otel4s.sdk.contrib.aws.context.propagation._
import org.typelevel.otel4s.sdk.exporter.otlp.trace.autoconfigure.OtlpSpanExporterAutoConfigure
import org.typelevel.otel4s.sdk.trace.SdkTraces
import org.typelevel.otel4s.trace.TracerProvider
object TelemetryApp extends IOApp.Simple {
def run: IO[Unit] =
SdkTraces
.autoConfigured[IO](
// register OTLP exporters configurer
_.addExporterConfigurer(OtlpSpanExporterAutoConfigure[IO])
// add AWS X-Ray Propagator
.addTracerProviderCustomizer((b, _) =>
b.addTextMapPropagators(AwsXRayPropagator())
)
)
.use { autoConfigured =>
program(autoConfigured.tracerProvider)
}
def program(
tracerProvider: TracerProvider[IO]
): IO[Unit] =
???
}
AWS Lambda
AWS Lambda can utilize _X_AMZN_TRACE_ID
environment variable or
com.amazonaws.xray.traceHeader
system property to set the X-Ray tracing header.
Use AwsXRayLambdaPropagator
in such a case.
OpenTelemetrySdk.autoConfigured
configures both MeterProvider
and TracerProvider
:
import cats.effect.{IO, IOApp}
import org.typelevel.otel4s.metrics.MeterProvider
import org.typelevel.otel4s.sdk.OpenTelemetrySdk
import org.typelevel.otel4s.sdk.contrib.aws.context.propagation._
import org.typelevel.otel4s.sdk.exporter.otlp.autoconfigure.OtlpExportersAutoConfigure
import org.typelevel.otel4s.trace.TracerProvider
object TelemetryApp extends IOApp.Simple {
def run: IO[Unit] =
OpenTelemetrySdk
.autoConfigured[IO](
// register OTLP exporters configurer
_.addExportersConfigurer(OtlpExportersAutoConfigure[IO])
// add AWS X-Ray Lambda Propagator
.addTracerProviderCustomizer((b, _) =>
b.addTextMapPropagators(AwsXRayLambdaPropagator())
)
)
.use { autoConfigured =>
val sdk = autoConfigured.sdk
program(sdk.meterProvider, sdk.tracerProvider)
}
def program(
meterProvider: MeterProvider[IO],
tracerProvider: TracerProvider[IO]
): IO[Unit] =
???
}
SdkTraces
configures only TracerProvider
:
import cats.effect.{IO, IOApp}
import org.typelevel.otel4s.sdk.contrib.aws.context.propagation._
import org.typelevel.otel4s.sdk.exporter.otlp.trace.autoconfigure.OtlpSpanExporterAutoConfigure
import org.typelevel.otel4s.sdk.trace.SdkTraces
import org.typelevel.otel4s.trace.TracerProvider
object TelemetryApp extends IOApp.Simple {
def run: IO[Unit] =
SdkTraces
.autoConfigured[IO](
// register OTLP exporters configurer
_.addExporterConfigurer(OtlpSpanExporterAutoConfigure[IO])
// add AWS X-Ray Lambda Propagator
.addTracerProviderCustomizer((b, _) =>
b.addTextMapPropagators(AwsXRayLambdaPropagator())
)
)
.use { autoConfigured =>
program(autoConfigured.tracerProvider)
}
def program(
tracerProvider: TracerProvider[IO]
): IO[Unit] =
???
}