如何让Rust tracing_subscriber为Option::None输出带null的JSON日志

默认情况下，tracing_subscriber的JSON格式化会自动省略值为Option::None的字段。要实现保留字段并输出null，可以通过以下两种方法实现：

方法一：全局自定义JSON格式化器（批量生效） #

这种方法会全局配置所有Option字段，在值为None时自动输出null，无需修改原有日志调用代码。

1. 添加依赖 #

确保Cargo.toml包含所需依赖：

[dependencies]
tracing = "0.1"
tracing-subscriber = { version = "0.3", features = ["json", "serde", "chrono"] }
serde = "1.0"
serde_json = "1.0"
chrono = { version = "0.4", features = ["serde"] }

2. 实现自定义格式化器 #

use chrono::Utc;
use serde_json::{Map, Value};
use tracing_subscriber::{
    fmt::{format::Writer, FormatEvent, FmtContext},
    prelude::*,
};

/// 自定义JSON格式化器，保留None字段并序列化为null
struct JsonWithNull;

impl FormatEvent for JsonWithNull {
    fn format_event(
        &self,
        ctx: &FmtContext<'_>,
        mut writer: Writer<'_>,
        event: &tracing::Event<'_>,
    ) -> std::fmt::Result {
        // 初始化JSON对象，填充基础日志字段
        let mut json_map = Map::new();
        json_map.insert(
            "timestamp".into(),
            Value::String(Utc::now().to_rfc3339()),
        );
        json_map.insert(
            "level".into(),
            Value::String(ctx.metadata().level().as_str().to_string()),
        );
        json_map.insert(
            "target".into(),
            Value::String(ctx.metadata().target().to_string()),
        );

        // 记录所有事件字段（包括None，自动序列化为null）
        event.record(&mut tracing_subscriber::fmt::format::JsonFields::new(&mut json_map));

        // 序列化为JSON并输出
        serde_json::to_writer(&mut writer, &Value::Object(json_map))?;
        writeln!(writer)?;

        Ok(())
    }
}

3. 初始化订阅者 #

fn main() {
    tracing_subscriber::fmt()
        .event_format(JsonWithNull)
        .finish()
        .init();

    // 测试场景
    let v: Option<i32> = Some(5);
    info!(v); // 输出包含"v":5的JSON

    let v: Option<i32> = None;
    info!(v); // 输出包含"v":null的JSON
}

方法二：手动包装字段（局部生效） #

如果仅需针对特定字段处理，或不想全局修改配置，可以手动将Option字段转换为serde_json::Value，让None被序列化为null：

use serde_json::Value;
use tracing_subscriber::prelude::*;

fn main() {
    // 保持原有订阅者配置不变
    tracing_subscriber::fmt()
        .json()
        .flatten_event(true)
        .finish()
        .init();

    let v: Option<i32> = Some(5);
    info!(v = Value::from(v)); // {"timestamp":"...","level":"INFO","v":5,"target":"..."}

    let v: Option<i32> = None;
    info!(v = Value::from(v)); // {"timestamp":"...","level":"INFO","v":null,"target":"..."}
}

这种方法无需修改全局配置，但需要在每个目标日志调用中手动转换字段。

内容的提问来源于stack exchange，提问作者extremeandy