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

feat: Update documentation with detailed logging configuration #19

Merged
merged 2 commits into from
Oct 25, 2024
Merged

feat: Update documentation with detailed logging configuration #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf6e824
feat: Update documentation with detailed logging configuration
huitseeker Oct 25, 2024
c6ccbc1
Update README.md
huitseeker Oct 25, 2024
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
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,22 @@ Download the installer from https://go.dev/dl/ and follow the installation instr
```

### 2. Install Rust
Make sure you have Rust installed by following the instructions [here](https://rustup.rs/)..
Make sure you have Rust installed by following the instructions [here](https://rustup.rs/).

## Logging Configuration

The verifier uses two logging systems:

- Rust logging via `tokio-tracing`, configured through the `RUST_LOG` environment variable. See the [tracing documentation](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html) for detailed configuration options.
- Go logging for FFI calls, configured through the `SP1_GO_LOG` environment variable.

To set a global log level (e.g. warn), configure both variables:

```bash
RUST_LOG=warn SP1_GO_LOG=warn ./plonk-verify ...
```

Valid log levels are: error, warn, info, debug, trace, off

### 3. Install Haskell (Cabal)
Ensure that you have Haskell and Cabal installed by following the instructions [here](https://www.haskell.org/cabal/).
Expand Down
Loading