@aws/aws-distro-opentelemetry-node-autoinstrumentation

AWS Distro for OpenTelemetry (ADOT) NodeJS Auto-Instrumentation

Install this package into your NodeJS project with:

npm install --save @aws/aws-distro-opentelemetry-node-autoinstrumentation

Run your application with ADOT NodeJS with:

node --require '@aws/aws-distro-opentelemetry-node-autoinstrumentation/register' your-application.js

Sample Environment Variables for Application Signals

export OTEL_RESOURCE_ATTRIBUTES=service.name=example-application-service-name
export OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true
export OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/metrics
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces
export OTEL_TRACES_EXPORTER=console,otlp
export OTEL_TRACES_SAMPLER=xray
export OTEL_TRACES_SAMPLER_ARG=endpoint=http://localhost:2000,polling_interval=300

General Recommendations

Environment Variable	Description	Example
OTEL_EXPORTER_OTLP_PROTOCOL	Leave unset so that ADOT JS will use a recommended OTLP protocol	http/protobuf
OTEL_PROPAGATORS	Leave unset so that ADOT JS will use a recommended list of propagators	baggage,xray,tracecontext
OTEL_NODE_DISABLED_INSTRUMENTATIONS	Leave unset so that ADOT JS will disable a recommended list of instrumentations	fs,dns
OTEL_NODE_RESOURCE_DETECTORS	Leave unset so that ADOT JS will use a recommended list of Resource Detectors. If set, env should be at the end of the list	aws,env