From 702cf2cdf321e8e5aea68af0cc4157f03c5578db Mon Sep 17 00:00:00 2001 From: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com> Date: Thu, 16 Feb 2023 14:55:56 -0500 Subject: [PATCH] Rename Logs API to Logs Bridge API to prevent confusion (#3197) We keep seeing confusion about what Logs API is. There was a proposal [1] to use the term Bridge API to help prevent the confusion. Please take a look and comment on whether you think this renaming helps and is reasonable. [1] https://github.com/open-telemetry/opentelemetry-specification/pull/3187#issuecomment-1424431424 --- specification/logs/semantic_conventions/exceptions.md | 8 ++++---- specification/logs/semantic_conventions/feature-flags.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/logs/semantic_conventions/exceptions.md b/specification/logs/semantic_conventions/exceptions.md index 1fe49af38..638909710 100644 --- a/specification/logs/semantic_conventions/exceptions.md +++ b/specification/logs/semantic_conventions/exceptions.md @@ -3,8 +3,8 @@ **Status**: [Experimental](../../document-status.md) This document defines semantic conventions for recording exceptions on -[logs](../api.md#emit-logrecord) and [events](../event-api.md#emit-event) -emitted through the [Logger API](../api.md#logger). +[logs](../bridge-api.md#emit-logrecord) and [events](../event-api.md#emit-event) +emitted through the [Logger API](../bridge-api.md#logger). @@ -17,7 +17,7 @@ emitted through the [Logger API](../api.md#logger). ## Recording an Exception Exceptions SHOULD be recorded as attributes on the -[LogRecord](../api.md#logrecord) passed to the [Logger](../api.md#logger) emit +[LogRecord](../bridge-api.md#logrecord) passed to the [Logger](../bridge-api.md#logger) emit operations. Exceptions MAY be recorded on "logs" or "events" depending on the context. @@ -29,7 +29,7 @@ the language runtime. ## Attributes The table below indicates which attributes should be added to the -[LogRecord](../api.md#logrecord) and their types. +[LogRecord](../bridge-api.md#logrecord) and their types. | Attribute | Type | Description | Examples | Requirement Level | diff --git a/specification/logs/semantic_conventions/feature-flags.md b/specification/logs/semantic_conventions/feature-flags.md index c248555a5..763821ada 100644 --- a/specification/logs/semantic_conventions/feature-flags.md +++ b/specification/logs/semantic_conventions/feature-flags.md @@ -3,8 +3,8 @@ **Status**: [Experimental](../../document-status.md) This document defines semantic conventions for recording feature flag evaluations as -a [log record](../api.md#logrecord) emitted through the -[Logger API](../api.md#emit-logrecord). +a [log record](../bridge-api.md#logrecord) emitted through the +[Logger API](../bridge-api.md#emit-logrecord). This is useful when a flag is evaluated outside of a transaction context such as when the application loads or on a timer. To record a flag evaluation as a part of a transaction context, @@ -24,14 +24,14 @@ section of the trace semantic convention for feature flag evaluations. ## Recording an Evaluation Feature flag evaluations SHOULD be recorded as attributes on the -[LogRecord](../api.md#logrecord) passed to the [Logger](../api.md#logger) emit +[LogRecord](../bridge-api.md#logrecord) passed to the [Logger](../bridge-api.md#logger) emit operations. Evaluations MAY be recorded on "logs" or "events" depending on the context. ## Attributes The table below indicates which attributes should be added to the -[LogRecord](../api.md#logrecord) and their types. +[LogRecord](../bridge-api.md#logrecord) and their types. The event name MUST be `feature_flag`.