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

Clarify attributes parameter type of Get a Logger operation #3841

Closed
pellared opened this issue Jan 24, 2024 · 0 comments · Fixed by #3855
Closed

Clarify attributes parameter type of Get a Logger operation #3841

pellared opened this issue Jan 24, 2024 · 0 comments · Fixed by #3855
Assignees
Labels
[label deprecated] triaged-accepted [label deprecated] Issue triaged and accepted by OTel community, can proceed with creating a PR spec:logs Related to the specification/logs directory

Comments

@pellared
Copy link
Member

pellared commented Jan 24, 2024

From https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/bridge-api.md#get-a-logger:

  • attributes (optional): Specifies the instrumentation scope attributes to associate with emitted telemetry. This API MUST be structured to accept a variable number of attributes, including none.
  1. Attributes of what type are these? Log attributes or common attributes? My guess is that these are "common attributes" but should be clearly defined by the specification.

  2. What the implementation should with the provided attributes? Shouldn't the data model for instrumentation scope be updated to also contain the attributes? See OTLP defintion and glossary definition. I think it is a bug in the specification.

Related PR: open-telemetry/opentelemetry-go#4809

@pellared pellared added the spec:logs Related to the specification/logs directory label Jan 24, 2024
@pellared pellared changed the title Clarify attributes type of Get a Logger operation Clarify attributes parameter type of Get a Logger operation Jan 24, 2024
@reyang reyang added the [label deprecated] triaged-accepted [label deprecated] Issue triaged and accepted by OTel community, can proceed with creating a PR label Jan 24, 2024
jack-berg pushed a commit that referenced this issue Mar 15, 2024
Fixes
#3841

## Changes

- Update "Instrumentation Scope" term in glossary.
- Update "Attribute Collections" (in common definitions) to include
instrumentation scope attributes.
- Change the instrumentation scope type definition from `(Name,Version)
tuple of strings` to Instrumentation Scope definition (as the current
definition misses Scheme URL and Attributes).
- Refer to `InstrumentationScope` Data Model field in Bridge API to make
the spec easier to follow.
- Move the part relevant to Bridge API usage from the Data Model.
- Remove "Version is optional. Name SHOULD be specified if version is
specified, otherwise Name is optional." which should act as
recommendation in the API. But the API already contains information how
the parameters should be used.

---------

Co-authored-by: Reiley Yang <[email protected]>
Co-authored-by: Tigran Najaryan <[email protected]>
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 31, 2024
…3855)

Fixes
open-telemetry#3841

## Changes

- Update "Instrumentation Scope" term in glossary.
- Update "Attribute Collections" (in common definitions) to include
instrumentation scope attributes.
- Change the instrumentation scope type definition from `(Name,Version)
tuple of strings` to Instrumentation Scope definition (as the current
definition misses Scheme URL and Attributes).
- Refer to `InstrumentationScope` Data Model field in Bridge API to make
the spec easier to follow.
- Move the part relevant to Bridge API usage from the Data Model.
- Remove "Version is optional. Name SHOULD be specified if version is
specified, otherwise Name is optional." which should act as
recommendation in the API. But the API already contains information how
the parameters should be used.

---------

Co-authored-by: Reiley Yang <[email protected]>
Co-authored-by: Tigran Najaryan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[label deprecated] triaged-accepted [label deprecated] Issue triaged and accepted by OTel community, can proceed with creating a PR spec:logs Related to the specification/logs directory
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants