Skip to content

Move Data Model Appendices to a new non-spec document #3206

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.

Sign up for GitHub

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

Jump to bottom
Closed
braydonk opened this issue Feb 13, 2023 · 0 comments · Fixed by #3207
Closed

Move Data Model Appendices to a new non-spec document #3206

braydonk opened this issue Feb 13, 2023 · 0 comments · Fixed by #3207
Assignees
@jmacd
Labels
spec:logs Related to the specification/logs directory

Comments

@braydonk
Copy link
Contributor

What are you trying to achieve?
The appendix sections of the Data Model document are currently tied up with the stability of the Data Model document itself. This isn't ideal, because these appendices are meant to be informational and not canonical representations of these format mappings. If the owner of that log format, for example a vendor maintaining an exporter, needed to change something about the format mapping they shouldn't be concerned with how it affects the overall stability of the data model document.

I'd like to propose that these examples be moved into a separate document, where it's clarified that the document is not a spec and makes no stability guarantees. The main Data Model document should likely link out to this document, as the examples are still valuable and should be easy to find.

Additional context.

This was brought up in the Dec 3 and Feb 8 Logging SIGs, and seemed to be well agreed upon. I offered to make the PR that made the change.
@braydonk braydonk added the spec:logs Related to the specification/logs directory label Feb 13, 2023
@braydonk braydonk mentioned this issue Feb 13, 2023
Merged
tigrannajaryan added a commit that referenced this issue Mar 6, 2023
@braydonk @tigrannajaryan
logs: move appendices Data Model Appendix document (#3207)
d10ce84 
Fixes #3206 

## Changes

This PR moves Data Model Appendix A and Appendix B to a separate
document, disentangling these appendices from the stability of the Data
Model document itself.

---------

Co-authored-by: Tigran Najaryan <[email protected]>
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 31, 2024
@braydonk @tigrannajaryan
logs: move appendices Data Model Appendix document (open-telemetry#3207)
cea9c41 
Fixes open-telemetry#3206 

## Changes

This PR moves Data Model Appendix A and Appendix B to a separate
document, disentangling these appendices from the stability of the Data
Model document itself.

---------

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
Assignees

@jmacd jmacd

Labels
spec:logs Related to the specification/logs directory
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

logs: move appendices Data Model Appendix document braydonk/opentelemetry-specification
2 participants
@jmacd @braydonk