Skip to content

Commit aa4bf33

Browse files
trasktrask
authored
Deprecate Event API and SDK in favor of Emit Event in the Log API (#4319)
1 parent 19d6783 commit aa4bf33

File tree

7 files changed

+10
-39
lines changed

7 files changed

+10
-39
lines changed

‎CHANGELOG.md‎

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

3636
### Events
3737

38+
- Deprecate Events API and SDK in favor of having Events support in the Logs API and SDK.
39+
([#4319](https://github.com/open-telemetry/opentelemetry-specification/pull/4319))
40+
3841
### Baggage
3942

4043
### Resource

‎spec-compliance-matrix.md‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ Disclaimer: this list of features is still a work in progress, please refer to t
193193
| LoggerProvider.Shutdown | | | + | | + | | | + | | + | - | |
194194
| LoggerProvider.ForceFlush | | | + | | + | | | + | | + | - | |
195195
| Logger.Emit(LogRecord) | | | + | | + | | | + | | + | - | |
196+
| Logger.EmitEvent(LogRecord) | | | | | | | | | | | | |
196197
| Logger.Enabled | X | + | | | | | | | + | + | | |
197198
| SimpleLogRecordProcessor | | | + | | + | | | + | | + | | |
198199
| BatchLogRecordProcessor | | | + | | + | | | + | | + | | |
@@ -203,26 +204,6 @@ Disclaimer: this list of features is still a work in progress, please refer to t
203204
| Can plug custom LogRecordExporter | | | + | | + | | | + | | + | | |
204205
| Trace Context Injection | | | + | | + | | | + | | + | + | |
205206

206-
## Events
207-
208-
Features for the [Events API](specification/logs/event-api.md) and the [Events SDK](specification/logs/event-sdk.md).
209-
Disclaimer: Events are currently in Development status - work in progress.
210-
211-
| Feature | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |
212-
|----------------------------------------------------------------------------|----------|----|------|----|--------|------|--------|-----|------|-----|------|-------|
213-
| [EventLoggerProvider](specification/logs/event-api.md#eventloggerprovider) | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |
214-
| Get EventLogger | | | | | | | | | | | | |
215-
| Get EventLogger accepts version | X | | | | | | | | | | | |
216-
| Get EventLogger accepts schema_url | X | | | | | | | | | | | |
217-
| Get EventLogger accepts attributes | X | | | | | | | | | | | |
218-
| [EventLogger](specification/logs/event-api.md#eventlogger) | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |
219-
| Emit event accepts name | | | | | | | | | | | | |
220-
| Emit event accepts AnyValue body | X | | | | | | | | | | | |
221-
| Emit event accepts severity | X | | | | | | | | | | | |
222-
| Emit event accepts timestamp | X | | | | | | | | | | | |
223-
| Emit event accepts attributes | X | | | | | | | | | | | |
224-
| Emit event accepts context | X | | | | | | | | | | | |
225-
226207
## Resource
227208

228209
| Feature | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |

‎specification/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ path_base_for_github_subdir:
3333
- [Metrics](metrics/api.md)
3434
- [Logs](logs/README.md)
3535
- [API](logs/api.md)
36-
- [Event API](logs/event-api.md)
3736
- SDK Specification
3837
- [Tracing](trace/sdk.md)
3938
- [Metrics](metrics/sdk.md)

‎specification/logs/README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,7 @@ processor.
230230
### Infrastructure Logs
231231

232232
These are logs generated by various infrastructure components, such as
233-
Kubernetes events (if you are wondering why events are discussed in the context
234-
of logs see [Event API Data model](./event-api.md#event-data-model)). Like system logs, the
233+
Kubernetes events. Like system logs, the
235234
infrastructure logs lack a trace context and can be enriched by the resource
236235
context - information about the node, pod, container, etc.
237236

@@ -447,7 +446,6 @@ standard output.
447446
* [Logs API](./api.md)
448447
* [Logs SDK](./sdk.md)
449448
* [Logs Data Model](./data-model.md)
450-
* [Event API](./event-api.md)
451449
* [Trace Context in non-OTLP Log Formats](../compatibility/logging_trace_context.md)
452450

453451
## References

‎specification/logs/event-api.md‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Events API
22

3-
**Status**: [Development](../document-status.md)
3+
**Status**: [Deprecated](../document-status.md) (was never stabilized),
4+
see [Emit Event](./api.md#emit-an-event) in the Logs API for replacement.
45

56
<details>
67
<summary>Table of Contents</summary>
@@ -9,7 +10,6 @@
910

1011
<!-- toc -->
1112

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,15 +31,6 @@ 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 API Development
35-
36-
> [!NOTE]
37-
> We are currently in the process of defining a new [Logs API](./api.md).
38-
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.
40-
41-
No further work is scheduled for the current Events API definition at this time.
42-
4334
## Event Data model
4435

4536
Wikipedia’s [definition of log file](https://en.wikipedia.org/wiki/Log_file):

‎specification/logs/event-sdk.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Events SDK
22

3-
**Status**: [Development](../document-status.md)
3+
**Status**: [Deprecated](../document-status.md) (was never stabilized),
4+
see the [Logs SDK](./sdk.md) and [Emit Event](./api.md#emit-an-event) in the Logs API for replacement.
45

56
<details>
67
<summary>Table of Contents</summary>

‎specification/versioning-and-stability.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,9 +247,7 @@ Semantic Conventions defines the set of fields in the OTLP data model:
247247
- The attribute keys provided on the LogRecord
248248
- The attribute values provided on the LogRecord that are defined in a list
249249
of well-known values.
250-
- For log records that are [Log Events](logs/event-api.md)
251-
- The following data provided to [emit event](logs/event-api.md#emit-event):
252-
- The event name (the value of the `event.name` attribute)
250+
- The event name (the value of the `event.name` attribute)
253251

254252
Things not listed in the above are not expected to remain stable via semantic
255253
convention and are allowed (or expected) to change. A few examples:

0 commit comments

Comments
 (0)