@opentelemetry/id-generator-aws-xray
v1.2.2
Published
AWS X-Ray ID generator for OpenTelemetry
Downloads
796,547
Readme
AWS OpenTelemetry X-Ray IdGenerator
[![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image]
The OpenTelemetry IdGenerator for AWS X-Ray generates trace IDs with its first four bytes set to the start time of the trace followed by a unique identifier consisting of 12 bytes of randomly generated numbers. OpenTelemetry offers an extension point which allows the usage of this custom IdGenerator as opposed to the out-of-the-box random IdGenerator, enabling compatibility with AWS X-Ray.
Status
| Maturity | Component Owner | Compatibility | | -------------------------------------- | ----------------------------------------------------- | --------------------- | | Stable | @carolabadeer | API 1.0+SDK 1.0+ |
Installation
npm install --save @opentelemetry/id-generator-aws-xray
Usage
In the global tracer configuration file, configure the following:
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { AWSXRayIdGenerator } = require('@opentelemetry/id-generator-aws-xray');
const tracerConfig = {
idGenerator: new AWSXRayIdGenerator(),
resources: resources
};
const tracerProvider = new NodeTracerProvider(tracerConfig);
Trace ID Details
Example trace ID format: 58406520a006649127e371903a2de979
A trace ID consists of two parts:
- Timestamp: The first 8 hexadecimal digits represent the time of the original request in Unix epoch time. For example, 10:00 AM December 1st, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal digits.
- Unique Identifier: The last 24 hexadecimal digits is an random identifier for the trace.
Useful links
- For more information on OpenTelemetry, visit: https://opentelemetry.io/
- For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
License
Apache 2.0 - See [LICENSE][license-url] for more information. [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions [license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat [npm-url]: https://www.npmjs.com/package/@opentelemetry/id-generator-aws-xray [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fid-generator-aws-xray.svg