Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 2.67 KB

File metadata and controls

39 lines (26 loc) · 2.67 KB

Recommended Configurations for OpenTelemetry AWS Lambda Instrumentation with AWS X-Ray

Go Reference Apache License

This module provides recommended configuration options for AWS Lambda Instrumentation when using AWS X-Ray. By using this configuration, trace context will automatically be extracted from incoming requests with the X-Amzn-Trace-Id header if present. Trace context will also always be injected using the X-Amzn-Trace-Id format into downstream requests from the Lambda function.

Installation

go get -u go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig

Recommended AWS Lambda Instrumentation Options

Instrumentation Option Recommended Value Exported As
WithTracerProvider An sdktrace.TracerProvider configured to export in batches to an OTel Collector running locally in Lambda Not individually exported. Can only be used via AllRecommendedOptions()
WithFlusher An otellambda.Flusher which yields before calling ForceFlush on the configured sdktrace.TracerProvider. Yielding mitigates data delays caused by asynchronous nature of batching TracerProvider when in Lambda Not individually exported. Can only be used via AllRecommendedOptions()
WithEventToCarrier Function which reads X-Ray TraceID from Lambda environment and inserts it into a propagtation.TextMapCarrier Individually exported as EventToCarrier(), also included in AllRecommendedOptions()
WithPropagator An xray.propagator Individually exported as Propagator(), also included in AllRecommendedOptions()

Useful links

License

Apache 2.0 - See LICENSE for more information.