aws-otel-js v0.1.1

AWS OpenTelemetry for JavaScript

Introduction

This project contains components of the OpenTelemetry JavaScript configured for use with AWS X-Ray. Please check out the upstream project to get a better understanding of the underlying features, APIs, and SDKs. This repository only contains a small portion of components which will allow OpenTelemetry to work with AWS X-Ray and the OpenTelemetry repository contains the rest.

We provided an IdGenerator and Propagator which can be called in a custom configuration from the OpenTelemetry upstream API. The telemetry data can be exported in a variety of formats and can be configured via command lines or environment variables. The aim of this project is to able to gather telemetry data from a JavaScript application and export trace data to an AWS-XRay backend.

Getting Started

Check out the getting started docs.

Supported Runtimes

For the complete list of supported runtimes, please refer to the upstream documentation here

How it works

The OpenTelemetry JavaScript SDK provides entry points with methods used for configuring aspects through its API. This custom configuration allows us to reconfigure the IdsGenerator which is needed in order to support X-Ray compatible trace Ids format. In addition, we are also able to use a custom propagator which is passed into the tracer provider to conform to AWS X-Ray headers.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/

License

This project is licensed under the Apache-2.0 License.