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

Documentation on Memory Usage / out-of-memory behavior #1138

Closed
jleibs opened this issue Feb 7, 2023 · 3 comments · Fixed by rerun-io/rerun-docs#58
Closed

Documentation on Memory Usage / out-of-memory behavior #1138

jleibs opened this issue Feb 7, 2023 · 3 comments · Fixed by rerun-io/rerun-docs#58
Assignees
Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jleibs
Copy link
Member

jleibs commented Feb 7, 2023

There's enough nuance here to potentially make for a good how-to guide?

  • Identifying that rerun is using too much memory
  • The UIs involved in inspecting/debugging
  • The flags involved in configuring the behavior
  • Some best practices for reducing overhead
@jleibs jleibs added the 📖 documentation Improvements or additions to documentation label Feb 7, 2023
@emilk
Copy link
Member

emilk commented Feb 7, 2023

I agree we should improve the documentation here. Currently we have this in rerun_py/USAGE.md:

You can set --memory-limit=16GB to tell the Rerun Viewer to purge older log data when memory use goes above that limit. This is useful for using Rerun in continuous mode, i.e. where you keep logging new data to Rerun forever.

It is still possible to log data faster than the Rerun Viewer can process it, and in those cases you may still run out of memory unless you also set --drop-at-latency=200ms or similar.

@emilk
Copy link
Member

emilk commented Feb 13, 2023

We should also make sure that both --memory-limit and --drop-at-latency can be set from the Python SDK and with environment variables:

@emilk
Copy link
Member

emilk commented Apr 4, 2023

This is now documented in https://www.rerun.io/docs/howto/limit-ram

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 good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants