Naively Programmable Module

    @opentelemetry/id-generator-aws-xray
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    AWS OpenTelemetry X-Ray IdGenerator

    [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image]

    component owners: @willarmiros @NathanielRN

    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.

    Compatible with OpenTelemetry JS API and 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:

    1. 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.
    2. Unique Identifier: The last 24 hexadecimal digits is an random identifier for the trace.

    Useful links

    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

    Install

    npm i @opentelemetry/id-generator-aws-xray

    DownloadsWeekly Downloads

    661,166

    Version

    1.1.0

    License

    Apache-2.0

    Unpacked Size

    49.2 kB

    Total Files

    46

    Last publish

    Collaborators

    • bogdandrutu
    • dyladan