@adobe/aio-lib-telemetry
A utility module for easy instrumentation of Adobe App Builder runtime actions via OpenTelemetry.
Installation
npm install @adobe/aio-lib-telemetry
Versioning Policy
This library follows semantic versioning with one important exception: breaking changes to the otel entrypoint do not trigger major version releases.
The otel entrypoint re-exports OpenTelemetry APIs, which remain experimental and receive frequent updates that may include breaking changes. Strictly adhering to semantic versioning would require releasing a new major version with each OpenTelemetry update, which would be disruptive given their rapid release cadence.
Our versioning approach:
- Major versions are reserved for breaking changes to our library's own API
- Minor/patch versions may include breaking changes to the
otelentrypoint - Node.js version changes (drops or additions) do not trigger major versions, they are released as isolated bumps with no other changes, to make the impact easy to assess
- All breaking changes, including those in
otel, are documented in release notes with a[BREAKING]label
Recommendation: Always review release notes before upgrading, especially if you use the otel entrypoint directly.
Usage
See the Usage Guide for more information.
Using AI
This repository has some skills to help you work with AI when instrumenting your App Builder code. It provides skills to help you setup the library, instrument your code, and troubleshoot any issues. Install using the following command:
npx skills add adobe/aio-lib-telemetry
Changelog
See CHANGELOG.md for a list of changes in each release.
Contributing
See the Contributing Guide.
License
This project is licensed under the Apache V2 License. See LICENSE for more information.
Governance
This project adheres to the Adobe Code of Conduct. By participating, you are expected to uphold this code.
Security
Security issues shouldn't be reported on the issue tracker. Instead, file an issue to our security experts.