-
Notifications
You must be signed in to change notification settings - Fork 941
docs: Rework of logs data model doc #4783
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
base: main
Are you sure you want to change the base?
docs: Rework of logs data model doc #4783
Conversation
jsuereth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I understand this PR.
DataModel != OTLP. We encode things into OTLP where the data model may not exactly match how things are encoded in OTLP, as OTLP is a protocol. We may have different protocols in the future where things are structured differently, but logs will still need a Resource + instrumentation scope.
I do not think this should be removed.
cc @jack-berg / @tigrannajaryan for thoughts.
|
The key thing the page says
The 2 fields removed are not in fact fields in the log record as discussed with @pellared who is the sponsor of changes based on the linked issue. If you look at metrics https://opentelemetry.io/docs/specs/otel/metrics/data-model/#opentelemetry-protocol-data-model there it mentions the metric is identified based on resource/scope with the metric defined using a collection of properties which doesn't include resource/scope. Logs are no different. |
There should be something which describes the record's relationship to instrumentation scope and resource. Also notice the lint errors from https://github.com/open-telemetry/opentelemetry-specification/actions/runs/19997659863/job/57347719833?pr=4783:
The Data Model specification structure is different for Metrics and Logs. Do you want to unify the document structure? |
|
@thompson-tomo, are you planning to work on this? |
bc33141 to
35cfdb0
Compare
|
Sorry missed the previous comment. I have made an attempt to update the structure of the logs data model doc to be more like the metrics equivalent. I have tried to keep text changes to a minimum with alot of the changes coming from re-organising sections. |
35cfdb0 to
d94b356
Compare
d94b356 to
a7bad52
Compare
Fixes #4735
Changes
This removes the resource and instrument scope fields from the log data model as they are not fields on the log record but rather higher level otlp fields.
The other changes are an attempt to align the document structure with that used in the metric data model doc.
For non-trivial changes, follow the change proposal process.
CHANGELOG.mdfile updated for non-trivial changes