log: add ignored target prefixes to LogTracer
#215
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
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added
kind/feature
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
tobz
reviewed
Jul 23, 2019
| /// [`init_with_filter`]: ../fn.init_with_filter.html | ||
| #[derive(Debug)] | ||
| pub struct LogTracer { | ||
| ignore_crates: Box<[String]>, |
There was a problem hiding this comment.
Once we actually construct a LogTracer, the vector would never grow again, so I thought changing it to a Box<[String]> indicated that more clearly. Theoretically, it is also slightly smaller since it lacks a capacity field, but since this is essentially a singleton that isn't really important.
There was a problem hiding this comment.
Interesting, hadn't considered that. 👍
tobz
approved these changes
Jul 23, 2019
amousset
reviewed
Jul 23, 2019
| /// initializing it. | ||
| /// | ||
| /// [`builder`]: #method.builder | ||
| pub fn init_with_filter(level: log::LevelFilter) -> Result<(), log::SetLoggerError> { |
There was a problem hiding this comment.
Do you think it makes sense to keep this method on LogTracer now it can be done with the builder? (and maybe for the init method too).
There was a problem hiding this comment.
I left it because I thought it was better not to break any code currently using this method.
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.
Motivation
People writing libraries using tracing may wish to expose regular
logsupport via the
tracing/logfeature. At the same time, to get tracingsupport for crates using
log, users may turn totracing_log::LogTracer. Enabling both means logging events twice.Solution
This branch adds a
Builderto thetracing_log::LogTracertype, whichallows configuring the
LogTracerto ignore log records with targetsbeginning with a certain string. This can be used to ignore any crates
which are emitting log records via the
tracing/logfeature.Ideally, we would provide a way to do this automatically, without
requiring configuration, but that'll take some thinking. The ability to
ignore certain sets of log records may be valuable even if we have an
automatic method for crates to signal that they are using the
tracing/logfeature in the future.I've also moved the
LogTracerandTraceLoggertypes intracing-logout of
lib.rsinto their own modules, since the main lib file wasgetting a bit lengthy.
Refs: #204
Signed-off-by: Eliza Weisman eliza@buoyant.io