Documentation for Rust SDK #34
Conversation
slinkydeveloper
left a comment
slinkydeveloper
left a comment
There was a problem hiding this comment.
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.
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.
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.