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.

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

Document all our environment variables in one place #3869

Open
emilk opened this issue Oct 16, 2023 · 0 comments
Open

Document all our environment variables in one place #3869

emilk opened this issue Oct 16, 2023 · 0 comments
Labels
🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers 🏎️ Quick Issue Can be fixed in a few hours or less
Milestone
Spring Cleaning

Comments

@emilk
Copy link
Member

emilk commented Oct 16, 2023

We have many environment variables to configure:

  • The running of the SDKs (RERUN, RERUN_FLUSH_TICK_SECS, …)
  • Controlling the viewer (RERUN_TRACK_ALLOCATIONS, …)
  • Controlling the build process (RERUN_IS_PUBLISHING, …)

Then there are environment variables that are important, but not defined by us:

  • WGPU_BACKEND, WGPU_POWER_PREF,
  • RUST_LOG
  • …

We should find and document all these in one place.
@emilk emilk added 📖 documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers 🧑‍💻 dev experience developer experience (excluding CI) labels Oct 16, 2023
@emilk emilk mentioned this issue Oct 16, 2023
Merged
4 tasks
Wumpf pushed a commit that referenced this issue Oct 16, 2023
@emilk
Replace --strict flag with RERUN_PANIC_ON_WARN env-var (#3872)
9a4d833 
`--strict` was an ill-chosen name, as it clashes with the SDK-side
strict-modes for user errors.

By making it an environment variable it is now also works anywhere
`setup_native_logging` is called.

### Related
* #3869

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3872) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/3872)
- [Docs
preview](https://rerun.io/preview/1693cf8fd0482fa823f1a5f0351d2dbb3c1dd9c2/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/1693cf8fd0482fa823f1a5f0351d2dbb3c1dd9c2/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
@emilk emilk added the 🏎️ Quick Issue Can be fixed in a few hours or less label Jan 9, 2024
@emilk emilk added this to the Spring Cleaning milestone Apr 24, 2024
@abey79 abey79 mentioned this issue Nov 14, 2024
Merged
6 tasks
abey79 added a commit that referenced this issue Nov 14, 2024
@abey79
Update env var documentation in rerun --help (#8133)
1bce6b0 
### What

- Part of #3869

```
$ rerun --help
[...]
Environment variables:
    RERUN_CHUNK_MAX_BYTES     Maximum chunk size thershold for the compactor.            
    RERUN_CHUNK_MAX_ROWS      Maximum chunk row count threshold for the compactor (sorted chunks). 
    RERUN_CHUNK_MAX_ROWS_IF_UNSORTED
                              Maximum chunk row count threshold for the compactor (unsorted chunks).
    RERUN_SHADER_PATH         The search path for shader/shader-imports. Only available in developer builds.
    RERUN_TRACK_ALLOCATIONS   Track memory allocations to diagnose memory leaks in the viewer.
                              WARNING: slows down the viewer by a lot!
    RERUN_MAPBOX_ACCESS_TOKEN The Mapbox access token to use the Mapbox-provided backgrounds in the map view.                               
    RUST_LOG                  Change the log level of the viewer, e.g. `RUST_LOG=debug`.
    WGPU_BACKEND              Overwrites the graphics backend used, must be one of `vulkan`, `metal` or `gl`.
                              Default is `vulkan` everywhere except on Mac where we use `metal`. What is
                              supported depends on your OS.
    WGPU_POWER_PREF           Overwrites the power setting used for choosing a graphics adapter, must be `high`
                              or `low`. (Default is `high`)
[...]
```

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8133?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8133?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8133)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

To deploy documentation changes immediately after merging this PR, add
the `deploy docs` label.
abey79 added a commit that referenced this issue Nov 14, 2024
@abey79
Update env var documentation in rerun --help (#8133)
9353007 
### What

- Part of #3869

```
$ rerun --help
[...]
Environment variables:
    RERUN_CHUNK_MAX_BYTES     Maximum chunk size thershold for the compactor.            
    RERUN_CHUNK_MAX_ROWS      Maximum chunk row count threshold for the compactor (sorted chunks). 
    RERUN_CHUNK_MAX_ROWS_IF_UNSORTED
                              Maximum chunk row count threshold for the compactor (unsorted chunks).
    RERUN_SHADER_PATH         The search path for shader/shader-imports. Only available in developer builds.
    RERUN_TRACK_ALLOCATIONS   Track memory allocations to diagnose memory leaks in the viewer.
                              WARNING: slows down the viewer by a lot!
    RERUN_MAPBOX_ACCESS_TOKEN The Mapbox access token to use the Mapbox-provided backgrounds in the map view.                               
    RUST_LOG                  Change the log level of the viewer, e.g. `RUST_LOG=debug`.
    WGPU_BACKEND              Overwrites the graphics backend used, must be one of `vulkan`, `metal` or `gl`.
                              Default is `vulkan` everywhere except on Mac where we use `metal`. What is
                              supported depends on your OS.
    WGPU_POWER_PREF           Overwrites the power setting used for choosing a graphics adapter, must be `high`
                              or `low`. (Default is `high`)
[...]
```

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8133?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8133?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8133)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

To deploy documentation changes immediately after merging this PR, add
the `deploy docs` label.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers 🏎️ Quick Issue Can be fixed in a few hours or less
Projects
None yet
Milestone
Spring Cleaning
Development

No branches or pull requests
1 participant
@emilk