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 #303

Merged
merged 7 commits into from
Oct 25, 2024
Merged

feat: Update documentation with detailed logging configuration #303

merged 7 commits into from
Oct 25, 2024

Conversation

huitseeker
Copy link
Contributor

After argumentcomputer/sphinx#193

  • Added sections about Logging Configuration in the configuration docs and README files of kadena, aptos, and ethereum
  • Detailed explanations provided on two different logging systems: Rust tokio-tracing and Go logging for FFI calls
  • Instructions delivered on how to set a global log level using RUST_LOG and SP1_GO_LOG environment variables
  • Added a list of all valid log levels: error, warn, info, debug, trace across all above-mentioned documents.

@huitseeker
feat: Update documentation with detailed logging configuration
addf343 
- Added sections about Logging Configuration in the configuration docs and README files of `kadena`, `aptos`, and `ethereum`
- Detailed explanations provided on two different logging systems: Rust `tokio-tracing` and Go logging for FFI calls
- Instructions delivered on how to set a global log level using `RUST_LOG` and `SP1_GO_LOG` environment variables
- Added a list of all valid log levels: error, warn, info, debug, trace across all above-mentioned documents.
wwared
wwared previously approved these changes Oct 25, 2024
View reviewed changes
Copy link
Contributor

@wwared wwared left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nits below regarding mentioning how to disable logging (since SP1_GO_LOG being unset defaults to info level, we should explicitly document how to turn it off)

aptos/README.md Outdated Show resolved Hide resolved
aptos/docs/src/run/configuration.md Outdated Show resolved Hide resolved
ethereum/README.md Outdated Show resolved Hide resolved
ethereum/docs/src/run/configuration.md Outdated Show resolved Hide resolved
kadena/README.md Outdated Show resolved Hide resolved
kadena/docs/src/run/configuration.md Outdated Show resolved Hide resolved
@huitseeker huitseeker added this pull request to the merge queue Oct 25, 2024
Merged via the queue into dev with commit adba6df Oct 25, 2024
15 checks passed
@huitseeker huitseeker deleted the logging-config branch October 25, 2024 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wwared wwared wwared approved these changes

@tchataigner tchataigner Awaiting requested review from tchataigner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@huitseeker @wwared