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.

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

Introduce the new user-facing Logs API as a placeholder #4236

Merged
merged 34 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
137911d
Introduce the new user-facing Logs API as a placeholder
MSNev Oct 1, 2024
7c78eff
Rename Public API to Instrumentation API and move into the bridge api
MSNev Oct 1, 2024
8b1ce31
Address naming issues
MSNev Oct 1, 2024
af1ea8c
Update specification/logs/event-api.md
MSNev Oct 1, 2024
f8d6d6c
Update specification/logs/bridge-api.md
MSNev Oct 1, 2024
90b4b8f
Update specification/logs/event-api.md
MSNev Oct 1, 2024
e72b841
Update specification/logs/bridge-api.md
MSNev Oct 1, 2024
c6ead01
Update specification/logs/bridge-api.md
MSNev Oct 1, 2024
971bc4b
Update specification/logs/event-api.md
MSNev Oct 1, 2024
476e57e
Update specification/logs/event-api.md
MSNev Oct 1, 2024
8254662
Update specification/logs/event-sdk.md
MSNev Oct 1, 2024
b26f162
Update specification/logs/sdk.md
MSNev Oct 1, 2024
6c8a343
Update specification/logs/event-sdk.md
MSNev Oct 1, 2024
a33b332
Merge branch 'main' into MSNev/PublicLogsApi
MSNev Oct 2, 2024
92b54e0
Update specification/logs/event-api.md
MSNev Oct 3, 2024
4148f84
Update specification/logs/sdk.md
MSNev Oct 3, 2024
fde365b
Update specification/logs/event-sdk.md
MSNev Oct 3, 2024
09c5377
Introduce the new user-facing Logs API as a placeholder
MSNev Oct 1, 2024
5ba0a22
Rename Public API to Instrumentation API and move into the bridge api
MSNev Oct 1, 2024
49952f7
Address naming issues
MSNev Oct 1, 2024
34e28a8
Update specification/logs/event-api.md
MSNev Oct 1, 2024
b6197b2
Update specification/logs/bridge-api.md
MSNev Oct 1, 2024
7118cd6
Update specification/logs/event-api.md
MSNev Oct 1, 2024
93a4954
Update specification/logs/bridge-api.md
MSNev Oct 1, 2024
318dc2b
Update specification/logs/bridge-api.md
MSNev Oct 1, 2024
19e6bf1
Update specification/logs/event-api.md
MSNev Oct 1, 2024
54aaf5f
Update specification/logs/event-api.md
MSNev Oct 1, 2024
d5844b5
Update specification/logs/event-sdk.md
MSNev Oct 1, 2024
c21d36f
Update specification/logs/sdk.md
MSNev Oct 1, 2024
64a1292
Update specification/logs/event-sdk.md
MSNev Oct 1, 2024
5b8714e
Merge remote-tracking branch 'origin/MSNev/PublicLogsApi' into MSNev/…
MSNev Oct 7, 2024
551bae9
Update all references to "Logs Instrumentation API"
MSNev Oct 7, 2024
f4d985a
Merge branch 'main' into MSNev/PublicLogsApi
MSNev Oct 7, 2024
8b05af4
Merge branch 'main' into MSNev/PublicLogsApi
MSNev Oct 8, 2024
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
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,7 @@ node_modules/
package-lock.json

# Visual Studio Code
.vscode
.vscode

# Visual Studio
.vs
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ release.
([#4221](https://github.com/open-telemetry/opentelemetry-specification/pull/4221))
- Make all fields as identifying for Logger. Previously attributes were omitted from being identifying.
([#4161](https://github.com/open-telemetry/opentelemetry-specification/pull/4161))
- Introduce initial placeholder for the new user-facing Logs API, adding references
to existing API's informing of the coming changes while the definition is defined.
([#4236](https://github.com/open-telemetry/opentelemetry-specification/pull/4236))

### Events

Expand Down
11 changes: 11 additions & 0 deletions specification/logs/bridge-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* [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 @@ -145,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
MSNev marked this conversation as resolved.
Show resolved Hide resolved
`LogRecord` as is currently provided by

* [Logs Bridge API](./bridge-api.md)
MSNev marked this conversation as resolved.
Show resolved Hide resolved
* [Events API](./event-api.md)

## Optional and required parameters

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

<!-- toc -->

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

## Instrumentation API Development

Note!: We are currently in the process of defining a new [Instrumentation API](./bridge-api.md#instrumentation-api).
MSNev marked this conversation as resolved.
Show resolved Hide resolved

The intent is that this Instrumentation 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.
MSNev marked this conversation as resolved.
Show resolved Hide resolved

No further work is scheduled for the current Event API definition at this time.
MSNev marked this conversation as resolved.
Show resolved Hide resolved

## Event Data model

Wikipedia’s [definition of log file](https://en.wikipedia.org/wiki/Log_file):
Expand Down
9 changes: 9 additions & 0 deletions specification/logs/event-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

<!-- toc -->

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

All implementations of the OpenTelemetry API MUST provide an SDK.

## Instrumentation API Development

Note!: We are currently in the process of defining a new [Instrumentation API](./bridge-api.md#instrumentation-api).
MSNev marked this conversation as resolved.
Show resolved Hide resolved

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

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

## Overview

From OpenTelemetry's perspective LogRecords and Events are both represented
Expand Down
5 changes: 5 additions & 0 deletions specification/logs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
+ [Export](#export)
+ [ForceFlush](#forceflush-2)
+ [Shutdown](#shutdown-1)
- [Instrumentation API](#instrumentation-api)

<!-- tocstop -->

Expand Down Expand Up @@ -538,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).
MSNev marked this conversation as resolved.
Show resolved Hide resolved

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