open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Tigran Najaryan 2023-02-16 14:55:56 -05:00 committed by GitHub
parent 6086a26696
commit 702cf2cdf3
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
specification/logs/semantic_conventions/exceptions.md
View File

@ -3,8 +3,8 @@
**Status**: [Experimental](../../document-status.md) **Status**: [Experimental](../../document-status.md)
This document defines semantic conventions for recording exceptions on This document defines semantic conventions for recording exceptions on
[logs](../api.md#emit-logrecord) and [events](../event-api.md#emit-event) [logs](../bridge-api.md#emit-logrecord) and [events](../event-api.md#emit-event)
emitted through the [Logger API](../api.md#logger). emitted through the [Logger API](../bridge-api.md#logger).
<!-- toc --> <!-- toc -->
@ -17,7 +17,7 @@ emitted through the [Logger API](../api.md#logger).
## Recording an Exception ## Recording an Exception
Exceptions SHOULD be recorded as attributes on the 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 operations. Exceptions MAY be recorded on "logs" or "events" depending on the
context. context.
@ -29,7 +29,7 @@ the language runtime.
## Attributes ## Attributes
The table below indicates which attributes should be added to the 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.
<!-- semconv log-exception --> <!-- semconv log-exception -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |

8
specification/logs/semantic_conventions/feature-flags.md
View File

@ -3,8 +3,8 @@
**Status**: [Experimental](../../document-status.md) **Status**: [Experimental](../../document-status.md)
This document defines semantic conventions for recording feature flag evaluations as This document defines semantic conventions for recording feature flag evaluations as
a [log record](../api.md#logrecord) emitted through the a [log record](../bridge-api.md#logrecord) emitted through the
[Logger API](../api.md#emit-logrecord). [Logger API](../bridge-api.md#emit-logrecord).
This is useful when a flag is evaluated outside of a transaction context This is useful when a flag is evaluated outside of a transaction context
such as when the application loads or on a timer. such as when the application loads or on a timer.
To record a flag evaluation as a part of a transaction context, 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 ## Recording an Evaluation
Feature flag evaluations SHOULD be recorded as attributes on the 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 operations. Evaluations MAY be recorded on "logs" or "events" depending on the
context. context.
## Attributes ## Attributes
The table below indicates which attributes should be added to the 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.
<!-- semconv log-feature_flag --> <!-- semconv log-feature_flag -->
The event name MUST be `feature_flag`. The event name MUST be `feature_flag`.