Align log sdk naming with api #2768
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jack-berg
commented
Sep 1, 2022
jack-berg
commented
Sep 1, 2022
reyang
reviewed
Sep 2, 2022
reyang
reviewed
Sep 2, 2022
reyang
approved these changes
Sep 2, 2022
reyang
added
spec:logs
kumoroku
approved these changes
Sep 5, 2022
djaglowski
approved these changes
Sep 7, 2022
scheler
reviewed
Sep 8, 2022
scheler
reviewed
Sep 8, 2022
jack-berg
force-pushed
the
rename-log-emitter
branch
from
887d74e to
9b7fb20
Compare
tigrannajaryan
approved these changes
Sep 12, 2022
|
I will keep this open for a bit to allow time to review the last changes. |
CodeBlanch
reviewed
Sep 15, 2022
Comment on lines
+151
to
+152
| Events require the `event.domain` attribute. The API MUST not allow creating an | ||
| Event if the Logger instance doesn't have `event.domain` scope attribute. |
There was a problem hiding this comment.
Events require the
event.domainattribute. The API MUST not allow creating an
Event if the Logger instance doesn't haveevent.domainscope attribute.
Can you clarify for me what to do in the case of missing event.domain to the EmitEvent call? Is it a no-op or a throw? Do I generate a log to alert the user?
Also, is it valid if name is passed as null or empty?
There was a problem hiding this comment.
@CodeBlanch both domain and name are required for an Event and also cannot be empty or null. So EmitEvent call should throw an error if event.domain attribute is missing or is null/empty. Same with name - if it is null or empty, EmitEvent should return failure or throw an error.
carlosalberto
pushed a commit
to carlosalberto/opentelemetry-specification
that referenced
this pull request
Oct 31, 2024
Resolves open-telemetry#2752. This aligns log SDK and API concepts which have diverged after the merged of open-telemetry#2676. This PR brings alignment to the log API and SDK, and in brings the log signal into alignment with tracing and metrics where there is conceptual overlap. There shouldn't be any new concepts introduced here. - Rename `../logs/logging-library-sdk.md` to `../logs/sdk.md` - Remove wording from SDK that implies that an API doesn't exist, like [this](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L60-L62). - Move [How to Create Log4j Style Appender](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L219) to `api.md` since it describes an API use case. - Move [Implicit / Explicit Context Injection](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L270-L288) sections to `api.md` since they describe API level considerations. - Rename Logger [create](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/api.md#L133) method to be emit, to align with SDK concept of `LogRecordProcessor#onEmit(..)`. - Rename `LogProcessor`, `LogExporter` to `LogRecordProcessor`, `LogRecordExporter`. - Fill in various SDK level TODOs related to shutdown and flushing. The language from these was taken directly from the metrics / tracing SDK - no new concepts were introduced.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #2752.
This aligns log SDK and API concepts which have diverged after the merged of #2676. This PR brings alignment to the log API and SDK, and in brings the log signal into alignment with tracing and metrics where there is conceptual overlap. There shouldn't be any new concepts introduced here.
../logs/logging-library-sdk.mdto../logs/sdk.mdapi.mdsince it describes an API use case.api.mdsince they describe API level considerations.LogRecordProcessor#onEmit(..).LogProcessor,LogExportertoLogRecordProcessor,LogRecordExporter.