Skip to content

Commit

Permalink
Rename Public API to Instrumentation API and move into the bridge api
Browse files Browse the repository at this point in the history
  • Loading branch information
MSNev committed Oct 1, 2024
1 parent 137911d commit 7c78eff
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 65 deletions.
1 change: 0 additions & 1 deletion specification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ path_base_for_github_subdir:
- [Tracing](trace/api.md)
- [Metrics](metrics/api.md)
- [Logs](logs/README.md)
- [Public API](logs/public-api.md)
- [Bridge API](logs/bridge-api.md)
- [Event API](logs/event-api.md)
- SDK Specification
Expand Down
20 changes: 11 additions & 9 deletions specification/logs/bridge-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@

<!-- toc -->

- [Public API Development](#public-api-development)
- [LoggerProvider](#loggerprovider)
* [LoggerProvider operations](#loggerprovider-operations)
+ [Get a Logger](#get-a-logger)
- [Logger](#logger)
* [Logger operations](#logger-operations)
+ [Emit a LogRecord](#emit-a-logrecord)
+ [Enabled](#enabled)
- [Instrumentation API](#instrumentation-api)
- [Optional and required parameters](#optional-and-required-parameters)
- [Concurrency requirements](#concurrency-requirements)
- [Artifact Naming](#artifact-naming)
Expand Down Expand Up @@ -45,14 +45,6 @@ graph TD
B -->|Emit| C(LogRecord)
```

## Public API Development

We are currently in the process of defining a new [user-facing Logs API](./public-api.md). Unlike this Logs Bridge API, the new API is intended to be called by both application developers and logging library authors to build log appenders, which use this API to bridge between existing logging libraries and the OpenTelemetry log data model.

The intent is that this new API will incorporate the current functionality of this existing API and once it is defined and implemented, the Logs Bridge API usage will be migrated, deprecated, renamed and eventually removed.

No further work is scheduled for the current Log Bridge API at this time.

## LoggerProvider

`Logger`s can be accessed with a `LoggerProvider`.
Expand Down Expand Up @@ -154,6 +146,16 @@ SHOULD be documented that instrumentation authors needs to call this API each
time they [emit a LogRecord](#emit-a-logrecord) to ensure they have the most
up-to-date response.

## Instrumentation API

**Status**: [Development](../document-status.md)

This set of API functions will provide the capabalities needed to emit a
`LogRecord` as is currently provided by

* [Logs Bridge API](./bridge-api.md)
* [Events API](./event-api.md)

## Optional and required parameters

The operations defined include various parameters, some of which are marked
Expand Down
8 changes: 5 additions & 3 deletions specification/logs/event-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<!-- toc -->

- [Public API Development](#public-api-development)
- [Instrumentation API Development](#instrumentation-api-development)
- [Event Data model](#event-data-model)
- [Event API use cases](#event-api-use-cases)
- [EventLoggerProvider](#eventloggerprovider)
Expand All @@ -31,9 +31,11 @@ The Event API consists of these main components:
provides access to `EventLogger`s.
* [EventLogger](#eventlogger) is the component responsible for emitting events.

## Public API Development
## Instrumentation API Development

Note!: We are currently in the process of defining a new [user-facing Logs API](./public-api.md).
**Status**: [Development](../document-status.md)

Note!: We are currently in the process of defining a new [Instrumentation API](./bridge-api.md#instrumentation-api).

The intent is that this new API will incorporate the current functionality of this existing API and once it is defined and implemented, the Event API usage will be migrated, deprecated, renamed and eventually removed.

Expand Down
6 changes: 3 additions & 3 deletions specification/logs/event-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<!-- toc -->

- [Public API/SDK Development](#public-apisdk-development)
- [Instrumentation API Development](#instrumentation-api-development)
- [Overview](#overview)
- [EventLoggerProvider](#eventloggerprovider)
* [EventLoggerProvider Creation](#eventloggerprovider-creation)
Expand All @@ -30,9 +30,9 @@ API that provides users with this functionally.

All implementations of the OpenTelemetry API MUST provide an SDK.

## Public API/SDK Development
## Instrumentation API Development

Note!: We are currently in the process of defining a new [user-facing Logs API](./public-api.md).
Note!: We are currently in the process of defining a new [Instrumentation API](./bridge-api.md#instrumentation-api).

The intent is that this new API will incorporate the current functionality of this existing API and once it is defined and implemented, the Event API usage will be migrated, deprecated, renamed and eventually removed.

Expand Down
40 changes: 0 additions & 40 deletions specification/logs/public-api.md

This file was deleted.

14 changes: 5 additions & 9 deletions specification/logs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

<!-- toc -->

- [Public API/SDK Development](#public-apisdk-development)
- [LoggerProvider](#loggerprovider)
* [LoggerProvider Creation](#loggerprovider-creation)
* [Logger Creation](#logger-creation)
Expand Down Expand Up @@ -35,6 +34,7 @@
+ [Export](#export)
+ [ForceFlush](#forceflush-2)
+ [Shutdown](#shutdown-1)
- [Instrumentation API](#instrumentation-api)

<!-- tocstop -->

Expand All @@ -47,14 +47,6 @@ API that provides users with this functionally.

All language implementations of OpenTelemetry MUST provide an SDK.

## Public API/SDK Development

Note!: We are currently in the process of defining a new [user-facing Logs API](./public-api.md).

The intent is that this new API/SDK will incorporate the current functionality of this existing API/SDK and once it is defined and implemented, this SDK usage will be migrated, deprecated, renamed and eventually removed.

No further work is scheduled for the current Logging SDK definition at this time.

## LoggerProvider

A `LoggerProvider` MUST provide a way to allow a [Resource](../resource/sdk.md)
Expand Down Expand Up @@ -547,4 +539,8 @@ return a Failure result.
and the destination is unavailable). [OpenTelemetry SDK](../overview.md#sdk)
authors MAY decide if they want to make the shutdown timeout configurable.

## Instrumentation API

Note!: We are currently in the process of defining a new [Instrumentation API](./bridge-api.md#instrumentation-api).

- [OTEP0150 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md)

0 comments on commit 7c78eff

Please sign in to comment.