*: clean up the usage of slog #288
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit brings 2 big changes to the API: 1. No more default logger. Users are required to give a logger to use the most of structs in this library. This makes the interface simple. 2. No more tag scope value. Some APIs insert tag into KVs, some don't. It's confusing and easily lead to duplicate KV definitions. Users are required to insert tag into KVs before passing the logger to the library, and there is no more explicit configuration of tag.
Hoverbear
reviewed
Sep 12, 2019
Hoverbear
approved these changes
Sep 17, 2019
nrc
approved these changes
Sep 18, 2019
| @@ -47,19 +47,26 @@ use slog::{Drain, Logger}; | |||
| /// Currently, this is a terminal log. It ensures it is only initialized once to prevent clobbering. | |||
| // This is `pub` so that testing and benching functions can use it. | |||
| // `#[cfg(test)]` doesn't work for benching. | |||
| #[doc(hidden)] | |||
There was a problem hiding this comment.
Why remove doc(hidden)? Seems like we don't want to make this public API
There was a problem hiding this comment.
Because harness is not a public library, will never be published to crates.io, doc hidden is unnecessary.
This was referenced Oct 5, 2019
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit brings 2 big changes to the API:
No more default logger.
Users are required to give a logger to use the most of structs in this library. This makes the interface simple and reduces unnecessary dependencies.
No more tag scope value.
Some APIs insert tag into KVs, some don't. It's confusing and easily lead to duplicate KV definitions. Users are required to insert tag into KVs before passing the logger to the library, and there is no more explicit configuration of tag.