-
Notifications
You must be signed in to change notification settings - Fork 10
Documentation for Rust SDK #34
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did a first pass, haven't finished yet.
General comment I have is to use more aggressively links, and link to the trait functions directly when it makes sense.
Thanks for tackling this BTW!
src/lib.rs
Outdated
//! You can set the logging level of the Rust SDK via the `RESTATE_LOGGING` environment variable and the level values can be `TRACE`, `DEBUG`, `INFO`, `WARN` or `ERROR`. | ||
//! The default log level is `INFO`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not the full story, we don't embed tracing ourselves.
You need to tell people that the rust SDK uses the tracing
crate, so you need to configure tracing_subscriber
to get logs. And then give an example with tracing_subscriber::fmt::init()
as in one of the examples above, and send them to the tracing subscriber doc: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/index.html#filtering-events-with-environment-variables
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you check if it's okay now?
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
Co-authored-by: Francesco Guardiani <francescoguard@gmail.com>
No description provided.