open-telemetry
/
opentelemetry-js
mirror of https://github.com/open-telemetry/opentelemetry-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(api-logs): add disclaimers (#3979)

This commit is contained in:
Marc Pichler 2023-07-11 08:51:11 +02:00 committed by GitHub
parent 552abc8221
commit 013695d45d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
experimental/packages/api-logs/README.md
View File

@ -1,13 +1,19 @@
# OpenTelemetry API for JavaScript # OpenTelemetry Logs Bridge API for JavaScript
[![NPM Published Version][npm-img]][npm-url] [![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image] [![Apache License][license-image]][license-image]
This package provides everything needed to interact with the unstable OpenTelemetry Logs API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser. **Note: This is an experimental package under active development. New releases may include breaking changes.**
## Beta Software - Use at your own risk This package provides everything needed to interact with the unstable OpenTelemetry Logs Bridge API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser.
The logs API is considered alpha software and there is no guarantee of stability or long-term support. When the API is stabilized, it will be made available and supported long-term in the `@opentelemetry/api` package and this package will be deprecated. **Note: This module defines a log backend API. The API is not intended to be called by application developers directly.
It is provided for logging library authors to build log appenders, which use this API to bridge between existing
logging libraries and the OpenTelemetry log data model.**
## Alpha Software - Use at your own risk
The Logs Bridge API is considered alpha software and there is no guarantee of stability or long-term support. When the API is stabilized, it will be made available and supported long-term in the `@opentelemetry/api` package and this package will be deprecated.
## Quick Start ## Quick Start