-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #137 from tmccombs/structured
Add support for Key-Value data in log records.
- Loading branch information
Showing
6 changed files
with
250 additions
and
67 deletions.
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 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 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 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.