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

Add Log Bridge API artifact naming guidance #3346

Merged
merged 6 commits into from
Apr 6, 2023
Merged

Add Log Bridge API artifact naming guidance #3346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bb4098e
Log bridge artifact naming guidance
jack-berg Mar 27, 2023
33d43a7
changelog
jack-berg Mar 27, 2023
a832018
Update changelog
jack-berg Mar 27, 2023
5a3917d
markdownlint
jack-berg Mar 27, 2023
f6e62a2
Merge branch 'main' into log-api-naming
arminru Apr 5, 2023
98e0dfa
Merge branch 'main' into log-api-naming
arminru Apr 5, 2023
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ release.
([#3331](https://github.com/open-telemetry/opentelemetry-specification/pull/3331))
- Ensure Logs Bridge API doesn't contain SDK implementation details
([#3275](https://github.com/open-telemetry/opentelemetry-specification/pull/3275))
- Add Log Bridge API artifact naming guidance
([#3346](https://github.com/open-telemetry/opentelemetry-specification/pull/3346))
- Add log appender / bridge to glossary.
([#3335](https://github.com/open-telemetry/opentelemetry-specification/pull/3335))

Expand Down
10 changes: 10 additions & 0 deletions specification/logs/bridge-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- [LogRecord](#logrecord)
- [Optional and required parameters](#optional-and-required-parameters)
- [Concurrency requirements](#concurrency-requirements)
- [Artifact Naming](#artifact-naming)
- [Usage](#usage)
* [How to Create a Log4J Log Appender](#how-to-create-a-log4j-log-appender)
* [Implicit Context Injection](#implicit-context-injection)
Expand Down Expand Up @@ -158,6 +159,15 @@ specific guarantees and safeties.

**Logger** - all methods are safe to be called concurrently.

## Artifact Naming

The Logs Bridge API is not intended to be called by application developers
directly, and SHOULD include documentation that discourages direct use. However,
in the event OpenTelemetry were to add a user facing API, the Logs Bridge API would
be a natural starting point. Therefore, Log Bridge API artifact, package, and class
names MUST NOT include the terms "bridge", "appender", or any other qualifier
that would prevent evolution into a user facing API.
jack-berg marked this conversation as resolved.
Show resolved Hide resolved

## Usage

### How to Create a Log4J Log Appender
Expand Down