Skip to content

Commit

Permalink
docs(api-logs): add disclaimers (#3979)
Browse files Browse the repository at this point in the history
  • Loading branch information
pichlermarc authored Jul 11, 2023
1 parent 552abc8 commit 013695d
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions experimental/packages/api-logs/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# OpenTelemetry API for JavaScript
# OpenTelemetry Logs Bridge API for JavaScript

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

Expand Down

0 comments on commit 013695d

Please sign in to comment.