Skip to content
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

Support structured logging (KV) #77

Open
wants to merge 18 commits into
base: main-dev
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Optimize KV display performance by reducing branch prediction misses
SpriteOvO committed Mar 11, 2025
commit 40e60f4b21e02d890551da974874e9a66c0b4a96
16 changes: 1 addition & 15 deletions spdlog/src/formatter/full_formatter.rs
Original file line number Diff line number Diff line change
@@ -98,21 +98,7 @@ impl FullFormatter {
dest.write_str("] ")?;
dest.write_str(record.payload())?;

let kvs = record.key_values();
if !kvs.is_empty() {
dest.write_str(" { ")?;

let mut iter = kvs.peekable();
while let Some((key, value)) = iter.next() {
dest.write_str(key.as_str())?;
dest.write_str("=")?;
write!(dest, "{}", value)?;
if iter.peek().is_some() {
dest.write_str(", ")?;
}
}
dest.write_str(" }")?;
}
record.key_values().write_to(dest, true)?;

if self.with_eol {
dest.write_str(__EOL)?;
16 changes: 1 addition & 15 deletions spdlog/src/formatter/journald_formatter.rs
Original file line number Diff line number Diff line change
@@ -49,21 +49,7 @@ impl JournaldFormatter {
dest.write_str("] ")?;
dest.write_str(record.payload())?;

let kvs = record.key_values();
if !kvs.is_empty() {
dest.write_str(" { ")?;

let mut iter = kvs.peekable();
while let Some((key, value)) = iter.next() {
dest.write_str(key.as_str())?;
dest.write_str("=")?;
write!(dest, "{}", value)?;
if iter.peek().is_some() {
dest.write_str(", ")?;
}
}
dest.write_str(" }")?;
}
record.key_values().write_to(dest, true)?;

dest.write_str(__EOL)?;

24 changes: 4 additions & 20 deletions spdlog/src/formatter/pattern_formatter/pattern/kv.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
use std::fmt::{self, Write};

use crate::{
formatter::pattern_formatter::{Pattern, PatternContext},
Error, Record, StringBuf,
@@ -15,23 +13,9 @@ impl Pattern for KV {
dest: &mut StringBuf,
_ctx: &mut PatternContext,
) -> crate::Result<()> {
(|| -> Result<(), fmt::Error> {
let kvs = record.key_values();
if !kvs.is_empty() {
dest.write_str("{ ")?;
let mut iter = kvs.peekable();
while let Some((key, value)) = iter.next() {
dest.write_str(key.as_str())?;
dest.write_str("=")?;
write!(dest, "{}", value)?;
if iter.peek().is_some() {
dest.write_str(", ")?;
}
}
dest.write_str(" }")?;
}
Ok(())
})()
.map_err(Error::FormatRecord)
record
.key_values()
.write_to(dest, false)
.map_err(Error::FormatRecord)
}
}
33 changes: 32 additions & 1 deletion spdlog/src/kv.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use std::{borrow::Cow, marker::PhantomData};
use std::{borrow::Cow, fmt, marker::PhantomData};

use value_bag::{OwnedValueBag, ValueBag};

@@ -95,6 +95,37 @@ where
phantom: PhantomData,
}
}

pub(crate) fn write_to(
mut self,
dest: &mut impl fmt::Write,
leading_space: bool,
) -> fmt::Result {
let first = self.next();
if let Some((key, value)) = first {
if leading_space {
dest.write_str(" { ")?;
} else {
dest.write_str("{ ")?;
}

// Reduce branch prediction misses for performance
// So we manually process the first KV pair
dest.write_str(key.as_str())?;
dest.write_str("=")?;
write!(dest, "{}", value)?;

for (key, value) in self {
dest.write_str(", ")?;
dest.write_str(key.as_str())?;
dest.write_str("=")?;
write!(dest, "{}", value)?;
}

dest.write_str(" }")?;
}
Ok(())
}
}

impl<'a, I> Iterator for KeyValuesIter<'a, I>