@opentelemetry/id-generator-aws-xray

AWS OpenTelemetry X-Ray IdGenerator

[![NPM Published Version][npm-img]][npm-url] [![dependencies][dependencies-image]][dependencies-url] [![devDependencies][devDependencies-image]][devDependencies-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.

Installation

npm install --save @opentelemetry/id-generator-aws-xray

Usage

In the global tracer configuration file, configure the following:

const { NodeTracerProvider } = require('@opentelemetry/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; the timestamp and the unique identifier.

Time Stamp

• the first 8 hexadecimal digits represent the time of the original request in Unix epoch time
• for example, 10:00AM 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 [dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=packages%2Fopentelemetry-id-generator-aws-xray [dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-id-generator-aws-xray [devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=packages%2Fopentelemetry-id-generator-aws-xray&type=dev [devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fopentelemetry-id-generator-aws-xray&type=dev [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

Changelog

0.20.0

:bug: Bug Fix

• #488 fix: dns plugin remove hostname attribute (@svrnm)
• #468 moving dev dependency for types to main dependency (@obecny)

:rocket: Enhancement

• Other
  • #517 feat: use rpcMetadata to update http span name #464 (@vmarchaud)
  • #441 feat(instrumentation-document-load): documentLoad attributes enhancement (@kkruk-sumo)
• opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • #513 chore: update core to 0.20.0 (@dyladan)
• opentelemetry-test-utils
  • #470 chore: removing usage of timed event from api (@obecny)

:house: Internal

• Other
  • #479 chore: generalize the instrumentation file name (@Rauno56)
  • #481 fix: move faas_id and cloud_account_id to semantic conventions (@svrnm)
  • #471 Fix repository for pg (@pauldraper)
• opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • #455 Update gts, eslint, typescript and hapi dependencies (@Flarna)

:memo: Documentation

• #472 docs: Explicitly state that express instrumentation does not export spans without http instrumentation (@svrnm)
• #450 chore: prefer use of global TracerProvider/MeterProvider (@Flarna)

Committers: 16

• Amir Blum (@blumamir)
• Anuraag Agrawal (@anuraaga)
• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Krystian Kruk (@kkruk-sumo)
• Min Xia (@mxiamxia)
• Nir Hadassi (@nirsky)
• Paul Draper (@pauldraper)
• Ran Nozik (@nozik)
• Rauno Viskus (@Rauno56)
• Severin Neumann (@svrnm)
• Siim Kallas (@seemk)
• Valentin Marchaud (@vmarchaud)
• William Armiros (@willarmiros)
• t2t2 (@t2t2)