Skip to content

Commit 4926dfb

Browse files
authored
Simplify the name "Logs Instrumentation API" to just "Logs API" (#4258)
1 parent d0b2693 commit 4926dfb

File tree

5 files changed

+15
-12
lines changed

5 files changed

+15
-12
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ release.
1515

1616
### Logs
1717

18+
- Simplify the name "Logs Instrumentation API" to just "Logs API".
19+
([#4258](https://github.com/open-telemetry/opentelemetry-specification/pull/4258))
20+
1821
### Events
1922

2023
### Baggage

specification/logs/bridge-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* [Logger operations](#logger-operations)
1717
+ [Emit a LogRecord](#emit-a-logrecord)
1818
+ [Enabled](#enabled)
19-
- [Logs Instrumentation API](#logs-instrumentation-api)
19+
- [Logs API](#logs-api)
2020
- [Optional and required parameters](#optional-and-required-parameters)
2121
- [Concurrency requirements](#concurrency-requirements)
2222
- [Artifact Naming](#artifact-naming)
@@ -146,7 +146,7 @@ SHOULD be documented that instrumentation authors needs to call this API each
146146
time they [emit a LogRecord](#emit-a-logrecord) to ensure they have the most
147147
up-to-date response.
148148

149-
## Logs Instrumentation API
149+
## Logs API
150150

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

specification/logs/event-api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<!-- toc -->
1111

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

34-
## Logs Instrumentation API Development
34+
## Logs API Development
3535

3636
> [!NOTE]
37-
> We are currently in the process of defining a new [Logs Instrumentation API](./bridge-api.md#logs-instrumentation-api).
37+
> We are currently in the process of defining a new [Logs API](./bridge-api.md#logs-api).
3838
39-
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.
39+
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.
4040

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

specification/logs/event-sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<!-- toc -->
1111

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

3131
All implementations of the OpenTelemetry API MUST provide an SDK.
3232

33-
## Logs Instrumentation API Development
33+
## Logs API Development
3434

3535
> [!NOTE]
36-
> We are currently in the process of defining a new [Logs Instrumentation API](./bridge-api.md#logs-instrumentation-api).
36+
> We are currently in the process of defining a new [Logs API](./bridge-api.md#logs-api).
3737
3838
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.
3939

specification/logs/sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
+ [Export](#export)
3535
+ [ForceFlush](#forceflush-2)
3636
+ [Shutdown](#shutdown-1)
37-
- [Logs Instrumentation API](#logs-instrumentation-api)
37+
- [Logs API](#logs-api)
3838

3939
<!-- tocstop -->
4040

@@ -539,9 +539,9 @@ return a Failure result.
539539
and the destination is unavailable). [OpenTelemetry SDK](../overview.md#sdk)
540540
authors MAY decide if they want to make the shutdown timeout configurable.
541541

542-
## Logs Instrumentation API
542+
## Logs API
543543

544544
> [!NOTE]
545-
> We are currently in the process of defining a new [Logs Instrumentation API](./bridge-api.md#logs-instrumentation-api).
545+
> We are currently in the process of defining a new [Logs API](./bridge-api.md#logs-api).
546546
547547
- [OTEP0150 Logging Library SDK Prototype Specification](https://github.com/open-telemetry/oteps/blob/main/text/logs/0150-logging-library-sdk.md)

0 commit comments

Comments
 (0)