Rerun data model
The hard part of ingesting a dataset is the
modeling decision, not the API call.
Get the model right and any mechanism works; get it wrong and queries, views, and training all break.
This skill is just the decisions.
For mechanism details see
(pipeline mechanics) and the importer skills it routes to:
,
,
,
,
.
For exact signatures, the docs at
rerun.io/docs/concepts/logging-and-ingestion
.
Before writing conversion code, fill in the mapping table below. It is the design, and a human can review it in seconds.
Pick the mechanism before you model the bytes
Modeling decides what each datum becomes; this decides how it gets there — and the default is a reader + lenses, not hand-built chunks:
- Does a reader exist for this source? MCAP→, URDF→, parquet→, RRD→, LeRobot dir→. Yes → + lenses; the reader produces the chunks, you do not.
- No, and it is genuine external metadata (JSON calibration, offsets) or a specific custom use case that can't be covered by a generic reader**→** .
- Otherwise: consider if you are about to hand-build something a reader or lens should produce and ask for clarification.
For MCAP specifically: a Foxglove- or ROS-decodable file emits archetypes like
,
, and
for certain supported message schemas ready-made — pass those through, never re-derive them; only custom protobuf signal topics need lenses. The full decision tree and the anti-pattern list are in
.
The model
Dataset → Segment → Layer → Recording → Entity → Component → Chunk
- Entity = a thing, named by a path ().
Component = one typed field on it (positions, image, a scalar).
Archetype = a standard bundle of components that log and render together (, , ).
- Every value you log sits on two axes: where (entity path + component) and when (which timeline, or static = all time).
- Segment = one episode; on registration its becomes the . Layer = an extra on top of a segment. It attaches by matching the segment's and nothing else: that shared id is the whole layering mechanism.
The decisions
Entity vs component on an existing entity
New entity if it has its own spatial frame (
/
), its own annotation context, or should be shown/cleared/shared independently (each robot link, each camera, each sensor). Same entity + extra component for auxiliary data at the same instances (per-point confidence).
Use
for non-standard fields.
Property vs component vs layer (the most common confusion)
- Component: per-timestamp signal on the timeline (joint angle, image).
- Segment property: one-per-episode metadata for catalog filter/search (operator, robot, site, task, date). Not per timestamp.
- Layer: a whole derived over a base segment (FK transforms, point clouds, gripper state, labels, quality scores). Queryable as if part of base.
Static vs temporal
Static belongs to all timelines and shadows any temporal value of the same component on the same entity. Use it for invariants (calibration, coordinate frames, robot meshes, annotation context, a video asset). Never make per-frame data static.
Which timeline
A
timeline (ns since epoch) for cross-sensor clock alignment, a
timeline for frame/ordinal alignment; stamp on both when useful.
Do not resample to a common rate. Latest-at reconciles multi-rate streams at query time by holding each component's last sample (no interpolation).
Base vs layer
Base = faithful conversion of the raw streams, nothing computed.
Layer = anything derived (FK from URDF + joint states, clouds from depth + intrinsics).
Keep them separate
s.
The mapping table (produce before coding)
| Source (topic/column/key) | Entity path | Archetype | Component(s) | Timeline | Static/temporal | Base/layer | Property? |
|---|
| mcap | | | | | temporal | base | no |
| | | codec+sample | | codec static, samples temporal | base | no |
| | (+ extrinsics) | | — | static | base | no |
| URDF + joints (computed) | | | translation/rotation | | temporal | layer | no |
| operator | segment | — | — | — | — | — | yes |
Patterns worth knowing
- Transforms / FK trees: log a per link entity; it relates to the parent path and composes down the tree. (Named + / only when topology must be a flexible graph.)
- Cameras: extrinsics () + intrinsics () on the camera entity, image/depth as children so they inherit the projection.
- Video: for compressed samples — the default for an mp4 () and what the Foxglove decoder already hands you. + is the fallback for a codec cannot represent.
- Columnar ingest: for an existing file, use the matching reader (///), which produces chunks directly — do not hand-assemble from a custom parser. When you do log columns directly (live logging), adds no automatic timelines, so pass every timeline you want.
Gotchas that cause real failures
- Component columns come back as in queries: index / (0-based DataFrame, 1-based SQL). See .
- A layer must share the segment's , or it won't attach. is discarded on registration.
- / add no /; only the timelines you pass exist.
- Static shadows all temporal data of that component for all time; static is overwritten in the viewer but every write stays on disk until .
- One / relation per frame pair; logging the same relation on a second entity is rejected.
- Entity paths are not file paths ( is meaningless, is reserved).
- A catalog layer written with a default injects a () chunk that can collide with the base segment's properties when the catalog merges layers by ; the dataset's default blueprint then stops applying on open. Construct the layer's stream with .