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.
| Maturity | Component Owner | Compatibility |
|---|---|---|
| Stable | @jj22ee | API 1.0+ SDK 1.0+ |
npm install --save @opentelemetry/id-generator-aws-xrayIn the global tracer configuration file, configure the following:
const { NodeSDK } = require('@opentelemetry/sdk-node');
const { AWSXRayIdGenerator } = require('@opentelemetry/id-generator-aws-xray');
const sdk = new NodeSDK({
idGenerator: new AWSXRayIdGenerator(),
// ...
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });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.
- 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
Apache 2.0 - See LICENSE for more information.