-
Notifications
You must be signed in to change notification settings - Fork 139
Add support for Key-Value data in log records. #137
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
use std::io::{self, Write}; | ||
|
||
#[cfg(feature = "color")] | ||
use super::WriteStyle; | ||
use super::{Formatter, StyledValue}; | ||
#[cfg(feature = "color")] | ||
use anstyle::Style; | ||
use log::kv::{Error, Key, Source, Value, VisitSource}; | ||
|
||
/// Format function for serializing key/value pairs | ||
/// | ||
/// This function determines how key/value pairs for structured logs are serialized within the default | ||
/// format. | ||
pub(crate) type KvFormatFn = dyn Fn(&mut Formatter, &dyn Source) -> io::Result<()> + Sync + Send; | ||
|
||
/// Null Key Value Format | ||
/// | ||
/// This function is intended to be passed to | ||
/// [`Builder::format_key_values`](crate::Builder::format_key_values). | ||
/// | ||
/// This key value format simply ignores any key/value fields and doesn't include them in the | ||
/// output. | ||
pub fn hidden_kv_format(_formatter: &mut Formatter, _fields: &dyn Source) -> io::Result<()> { | ||
Ok(()) | ||
} | ||
|
||
/// Default Key Value Format | ||
/// | ||
/// This function is intended to be passed to | ||
/// [`Builder::format_key_values`](crate::Builder::format_key_values). | ||
/// | ||
/// This is the default key/value format. Which uses an "=" as the separator between the key and | ||
/// value and a " " between each pair. | ||
/// | ||
/// For example: `ip=127.0.0.1 port=123456 path=/example` | ||
pub fn default_kv_format(formatter: &mut Formatter, fields: &dyn Source) -> io::Result<()> { | ||
fields | ||
.visit(&mut DefaultVisitSource(formatter)) | ||
.map_err(|e| io::Error::new(io::ErrorKind::Other, e)) | ||
} | ||
|
||
struct DefaultVisitSource<'a>(&'a mut Formatter); | ||
|
||
impl<'a, 'kvs> VisitSource<'kvs> for DefaultVisitSource<'a> { | ||
fn visit_pair(&mut self, key: Key, value: Value<'kvs>) -> Result<(), Error> { | ||
write!(self.0, " {}={}", self.style_key(key), value)?; | ||
Ok(()) | ||
} | ||
} | ||
|
||
impl DefaultVisitSource<'_> { | ||
fn style_key<'k>(&self, text: Key<'k>) -> StyledValue<Key<'k>> { | ||
#[cfg(feature = "color")] | ||
{ | ||
StyledValue { | ||
style: if self.0.write_style == WriteStyle::Never { | ||
Style::new() | ||
} else { | ||
Style::new().italic() | ||
}, | ||
value: text, | ||
} | ||
} | ||
#[cfg(not(feature = "color"))] | ||
{ | ||
text | ||
} | ||
} | ||
} |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.