diff --git a/README.md b/README.md index 160ec8d3e07..c4561df9c09 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ Getting Started   •   - API Reference -   •   - SDK Reference + API and SDK Reference

@@ -142,6 +140,7 @@ The below table describes which versions of each set of packages are expected to | API | Stable Packages | Experimental Packages | | ----- | --------------- | --------------------- | +| 1.3.x | 1.8.x | 0.34.x | | 1.2.x | 1.7.x | 0.33.x | | 1.2.x | 1.6.x | 0.32.x | | 1.1.x | 1.5.x | 0.31.x | @@ -158,11 +157,11 @@ The current version for each package can be found in the respective `package.jso ## Feature Status -| Signal | API Status | SDK Status | -| ------- | ----------- | ----------------- | -| Tracing | Stable | Release Candidate | -| Metrics | Development | Development | -| Logs | Roadmap | Roadmap | +| Signal | API Status | SDK Status | +| ------- | ----------- | ----------- | +| Tracing | Stable | Stable | +| Metrics | Stable | Stable | +| Logs | Development | Development | For a more detailed breakdown of feature support see the [specification compliance matrix][compliance-matrix]. @@ -550,7 +549,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [otel-shim-opentracing]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-shim-opentracing [otel-tracing]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-base [otel-web]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-web -[otel-api]: https://github.com/open-telemetry/opentelemetry-js-api +[otel-api]: https://github.com/open-telemetry/opentelemetry-js/tree/main/api [otel-core]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-core [otel-propagator-b3]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-propagator-b3 diff --git a/api/README.md b/api/README.md index dc44969675e..56dd23d177d 100644 --- a/api/README.md +++ b/api/README.md @@ -1,38 +1,17 @@ - ---- -

- - API Documentation -   •   - Getting In Touch (GitHub Discussions) - -

+# OpenTelemetry API for JavaScript

- - GitHub release (latest by date including pre-releases) - - - Codecov Status - - - license - -
- - Build Status - - - Build Status + +API Reference +  •   +Documentation +
+ + NPM Release +

---- - -# OpenTelemetry API for JavaScript - -[![NPM Published Version][npm-img]][npm-url] - This package provides everything needed to interact with the OpenTelemetry API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser. The methods in this package perform no operations by default. This means they can be safely called by a library or end-user application whether there is an SDK registered or not. In order to generate and export telemetry data, you will also need an SDK such as the [OpenTelemetry JS SDK][opentelemetry-js]. @@ -134,7 +113,5 @@ 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/blob/main/api/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat -[npm-url]: https://www.npmjs.com/package/@opentelemetry/api -[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg [docs-tracing]: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/tracing.md [docs-sdk-registration]: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/sdk-registration.md diff --git a/doc/context.md b/doc/context.md index 4f3d8bd2bbb..d49f8e44ecb 100644 --- a/doc/context.md +++ b/doc/context.md @@ -7,7 +7,7 @@ This document describes the OpenTelemetry context API for JavaScript and how it _Context Specification: _ -_Context API Reference: _ +_Context API Reference: _ - [Context Manager](#context-manager) - [Root Context](#root-context) diff --git a/doc/sdk-registration.md b/doc/sdk-registration.md index 2d6490c9bbd..a7a3bc72b73 100644 --- a/doc/sdk-registration.md +++ b/doc/sdk-registration.md @@ -23,6 +23,6 @@ api.propagation.setGlobalPropagator(httpTraceContextPropagator); api.context.setGlobalContextManager(asyncHooksContextManager); ``` -[trace-api-docs]: https://open-telemetry.github.io/opentelemetry-js-api/classes/traceapi.html -[propagation-api-docs]: https://open-telemetry.github.io/opentelemetry-js-api/classes/propagationapi.html -[context-api-docs]: https://open-telemetry.github.io/opentelemetry-js-api/classes/contextapi.html +[trace-api-docs]: https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_api.TraceAPI.html +[propagation-api-docs]: https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_api.PropagationAPI.html +[context-api-docs]: https://open-telemetry.github.io/opentelemetry-js/classes/_opentelemetry_api.ContextAPI.html diff --git a/doc/tracing.md b/doc/tracing.md index ba13dc22a16..ea3e38284bf 100644 --- a/doc/tracing.md +++ b/doc/tracing.md @@ -6,7 +6,7 @@ For a high-level overview of OpenTelemetry tracing in general and definitions of _Trace API Specification: _ -_Trace API Reference: _ +_Trace API Reference: _ - [Acquiring a Tracer](#acquiring-a-tracer) - [Starting and Ending a Span](#starting-and-ending-a-span) @@ -23,7 +23,7 @@ _Trace API Reference: