Skip to content

Initial multi channel trace file format specification #841

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

Merged
merged 11 commits into from
Jul 11, 2025
+199 −5
Merged

Initial multi channel trace file format specification #841

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ab9b6cb
Initial multi channel trace file format specification
pmai Nov 24, 2024
5584296
Minor fixes based on review feedback
pmai Nov 25, 2024
77fd4c6
Further clarifications and corrections from code review
pmai Nov 25, 2024
aa2b48a
Clarify extension bit of naming convention
pmai Nov 25, 2024
45f2578
Apply suggestions from code review
pmai Nov 26, 2024
f69b481
Update trace_file_formats.adoc
jdsika Nov 28, 2024
301790a
Clarify that only a single file global meta-data record is allowed
pmai Nov 29, 2024
15b043f
Provide example for creation_time based on review feedback
pmai May 27, 2025
1d96e47
Enhance discussion of non-top-level message types
pmai Jun 10, 2025
5ab48f9
Clarify rules on MCAP profile field in header
pmai Jul 1, 2025
c0bbdeb
Adjust wording to current normative modal verbs
pmai Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Enhance discussion of non-top-level message types 
Based on review feedback

Signed-off-by: Pierre R. Mai <[email protected]>
  • Loading branch information
@pmai
pmai committed Jun 10, 2025
commit 1d96e477d3e5f16a73b0709ea6e8476ee5efe0ae
3 changes: 2 additions & 1 deletion doc/architecture/trace_file_formats.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,8 @@ The schema record must be stored in the summary section of the trace file, and m
=== OSI channel

An OSI channel is a data stream within the OSI multi channel trace file that contains serialized OSI top-level messages of the same type.
Note that non-top-level messages must not be stored directly in OSI channels.
Note that this specification does not allow the storage of non-top-level OSI messages in OSI channels, as they cannot be reliably associated with other OSI data streams without additional context (e.g. due to the absence of a timestamp field or lack of attribution).
It is still possible to store them like any other related data in non-OSI channels, however this usage is unlikely to be portable.

Each OSI channel must be described by a channel record in the summary section of the trace file with the following fields:

Expand Down