diff options
| author | Lars Wirzenius <liw@liw.fi> | 2022-03-24 11:38:08 +0200 |
|---|---|---|
| committer | Lars Wirzenius <liw@liw.fi> | 2022-03-24 11:46:52 +0200 |
| commit | 84a07a5b77575a981c86b7e9a3e697428d4a94d2 (patch) | |
| tree | f3c9d3a89e605fa140748c34544473e9a7556d92 /CONTRIBUTING.md | |
| parent | bcc64e41ca47b1578b3d697d02cdff0ca1e0daa3 (diff) | |
| download | subplot-84a07a5b77575a981c86b7e9a3e697428d4a94d2.tar.gz | |
feat! change logging to use log/env_logger instead of tracing
We don't use async in Subplot, and the mental overhead of learning
tracing and the code overhead to add support for logging custom
values (implementing the Value trait for Subplot internal types) does
not seem worthwhile.
Sponsored-by: author
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 9 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 113ffd3..95d7ac1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,20 +94,12 @@ further work or attention. Ideally as a **user** of subplot you shouldn't need this, all error messages should give you sufficient context to chase down your problems. However if you -are debugging a change to subplot itself then you may need to know how to do the -following: - -1. You can change the logging level of subplot by means of the `SUBPLOT_LOG` - environment variable. If you set it to `trace` then it will show you absolutely - everything traced inside the program. You can learn about the syntax for - this variable on the [EnvFilter][] docs on `docs.rs`. -2. You can redirect the logging to a file by means of the `SUBPLOT_LOG_FILE` - environment variable. Simply set it to the path you want to store logging to. - Subplot will _append_ to that file, so it's safe to have it in your environment - for multiple runs. -3. To change the logging format, you can set `SUBPLOT_LOG_FORMAT` to one of: - `pretty` to have a multiline pretty format, `default` or `oneline` for a - basic one-line-per-event log format and `json` for a one-line-per-event JSON - log format. - -[envfilter]: https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/filter/struct.EnvFilter.html +are debugging a change to subplot itself then you may need to know how +to configure logging. + +You can change the logging level of subplot by means of the `SUBPLOT_LOG` +environment variable. If you set it to `trace` then it will show you absolutely +everything traced inside the program. You can learn about the syntax for +this variable on the [env_logger][] docs on `docs.rs`. + +[env_logger]: https://docs.rs/env_logger/latest/env_logger/ |