From b38a517ab68478b23e8eaae976f00f77fa564fde Mon Sep 17 00:00:00 2001 From: Robert Pajak Date: Mon, 3 Mar 2025 12:27:36 +0100 Subject: [PATCH 1/2] Clarify that it is allowed to directly use Logs API --- CHANGELOG.md | 2 ++ specification/logs/README.md | 15 ++++++++------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d5aa8bbab53..3d0daeb1500 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,8 @@ release. - Clarify STDOUT exporter format is unspecified. ([#4418](https://github.com/open-telemetry/opentelemetry-specification/pull/4418)) +- Clarify that it is allowed to directly use Logs API. + ([#TODO](https://github.com/open-telemetry/opentelemetry-specification/pull/TODO)) ### Baggage diff --git a/specification/logs/README.md b/specification/logs/README.md index 0f2cf8d8df3..5ea4bd94a92 100644 --- a/specification/logs/README.md +++ b/specification/logs/README.md @@ -144,13 +144,14 @@ Given the above state of the logging space we took the following approach: translate them to OpenTelemetry log data model. - OpenTelemetry defines a Logs API - for [emitting LogRecords](./api.md#emit-a-logrecord). Application developers are - NOT encouraged to call this API directly. It is provided for library authors - to build [log appender](../glossary.md#log-appender--bridge), which use - the API to bridge between existing logging libraries and the OpenTelemetry log - data model. Existing logging libraries generally provide a much richer set of - features than what is defined in OpenTelemetry. It is NOT a goal of - OpenTelemetry to ship a feature-rich logging library. + for [emitting LogRecords](./api.md#emit-a-logrecord). It is provided for + library authors to build [log appender](../glossary.md#log-appender--bridge), + which use the API to bridge between existing logging libraries and the + OpenTelemetry log data model. Existing logging libraries generally provide + a much richer set of features than what is defined in OpenTelemetry. + It is NOT a goal of OpenTelemetry to ship a feature-rich logging library. + Yet, the Logs API can also be used directly if one prefers to couple the code + to it instead of using a bridged logging library. - OpenTelemetry defines an [SDK](./sdk.md) implementation of the [API](./api.md), which enables configuration of [processing](./sdk.md#logrecordprocessor) From 5a4fe4b54dd44c8ced82d4c6e1a9b6f917abc892 Mon Sep 17 00:00:00 2001 From: Robert Pajak Date: Mon, 3 Mar 2025 12:29:51 +0100 Subject: [PATCH 2/2] Update PR number --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d0daeb1500..880e7067547 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,7 +24,7 @@ release. - Clarify STDOUT exporter format is unspecified. ([#4418](https://github.com/open-telemetry/opentelemetry-specification/pull/4418)) - Clarify that it is allowed to directly use Logs API. - ([#TODO](https://github.com/open-telemetry/opentelemetry-specification/pull/TODO)) + ([#4438](https://github.com/open-telemetry/opentelemetry-specification/pull/4438)) ### Baggage