Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Simplify the name "Logs Instrumentation API" to just "Logs API" #4258

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −12
Open

Simplify the name "Logs Instrumentation API" to just "Logs API" #4258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ release.

### Logs

- Simplify the name "Logs Instrumentation API" to just "Logs API".
([#4258](https://github.com/open-telemetry/opentelemetry-specification/pull/4258))

### Events

### Baggage
Expand Down
4 changes: 2 additions & 2 deletions specification/logs/bridge-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* [Logger operations](#logger-operations)
+ [Emit a LogRecord](#emit-a-logrecord)
+ [Enabled](#enabled)
- [Logs Instrumentation API](#logs-instrumentation-api)
- [Logs API](#logs-api)
- [Optional and required parameters](#optional-and-required-parameters)
- [Concurrency requirements](#concurrency-requirements)
- [Artifact Naming](#artifact-naming)
Expand Down Expand Up @@ -146,7 +146,7 @@ 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.

## Logs Instrumentation API
## Logs API

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

Expand Down
8 changes: 4 additions & 4 deletions specification/logs/event-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<!-- toc -->

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

## Logs Instrumentation API Development
## Logs API Development

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

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

No further work is scheduled for the current Events API definition at this time.

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

<!-- toc -->

- [Logs Instrumentation API Development](#logs-instrumentation-api-development)
- [Logs API Development](#logs-api-development)
- [Overview](#overview)
- [EventLoggerProvider](#eventloggerprovider)
* [EventLoggerProvider Creation](#eventloggerprovider-creation)
Expand All @@ -30,10 +30,10 @@ API that provides users with this functionally.

All implementations of the OpenTelemetry API MUST provide an SDK.

## Logs Instrumentation API Development
## Logs API Development

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

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

Expand Down
6 changes: 3 additions & 3 deletions specification/logs/sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
+ [Export](#export)
+ [ForceFlush](#forceflush-2)
+ [Shutdown](#shutdown-1)
- [Logs Instrumentation API](#logs-instrumentation-api)
- [Logs API](#logs-api)

<!-- tocstop -->

Expand Down Expand Up @@ -539,9 +539,9 @@ 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.

## Logs Instrumentation API
## Logs API

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

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