Skip to content
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

Doc: add a "How to record from multiple places" #4055

Closed
teh-cmc opened this issue Oct 28, 2023 · 0 comments · Fixed by #4383, #4385 or #4384
Closed

Doc: add a "How to record from multiple places" #4055

teh-cmc opened this issue Oct 28, 2023 · 0 comments · Fixed by #4383, #4385 or #4384
Labels
📖 documentation Improvements or additions to documentation user-request This is a pressing issue for one of our users

Comments

@teh-cmc
Copy link
Member

teh-cmc commented Oct 28, 2023

I keep answering questions of the form "I have multiple machines recording different PoV of the same thing, how can I visualize everything in on place?".
We need a how-to guide for this.

Here's my most recent answer on the matter:

Rerun has the notion of a Recording ID: https://www.rerun.io/docs/concepts/apps-and-recordings#recording-id.
Any recorded datasets that share the same Recording ID will be visualized together.

By default, we generate a random ID everytime you start a new logging session, but you can override that behavior, e.g.:

# Process 1 logs some spheres
./app1.py  # rr.init(recording_id='my_shared_recording', rr.save('/tmp/recording1.rrd')

# Process 2 logs some cubes
./app2.py  # rr.init(recording_id='my_shared_recording', rr.save('/tmp/recording2.rrd')

# Visualize a 3D scene with both spheres and cubes
rerun /tmp/recording*.rrd  # load both recording files

It's up to you to decide where each recording ends up:

  • all processes could stream their share in real-time to a Rerun Viewer,
  • or maybe they all write to their own file on disk that are later loaded in a viewer,
  • or some other combination of the above.

We do not yet provide a way to merge multiple recording files into a single one directly from the CLI, although you can load all of them in the Viewer and then use the save feature.
(caveat: the save feature in the viewer is currently sub-optimal, see #3091)

Related note: we do support logging to a file in a streaming fashion, but we do not yet support visualizing a file in a stream fashion. I'll open an issue.

@teh-cmc teh-cmc added 📖 documentation Improvements or additions to documentation user-request This is a pressing issue for one of our users labels Oct 28, 2023
teh-cmc added a commit that referenced this issue Nov 30, 2023
We already exposed a way of configuring the `StoreId`, but this is an
internal concept that we have never communicated anywhere and is very
likely to be unstable as the way we do blueprint recordings evolve (also
it's been known to confuse users).

This adds a simple, straightforward way of configuring the
`recording_id`, akin to what we have in the Python SDK.

---

Part of a PR series to fix #4055 once and for all:
- #4383
- #4384
- #4385
teh-cmc added a commit that referenced this issue Nov 30, 2023
What the title says.

---

Part of a PR series to fix #4055 once and for all:
- #4383
- #4384
- #4385
teh-cmc added a commit that referenced this issue Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation user-request This is a pressing issue for one of our users
Projects
None yet
1 participant