summaryrefslogtreecommitdiffstats
path: root/vendor/tracing-subscriber/src/fmt/format
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /vendor/tracing-subscriber/src/fmt/format
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/tracing-subscriber/src/fmt/format')
-rw-r--r--vendor/tracing-subscriber/src/fmt/format/json.rs885
-rw-r--r--vendor/tracing-subscriber/src/fmt/format/mod.rs2161
-rw-r--r--vendor/tracing-subscriber/src/fmt/format/pretty.rs511
3 files changed, 3557 insertions, 0 deletions
diff --git a/vendor/tracing-subscriber/src/fmt/format/json.rs b/vendor/tracing-subscriber/src/fmt/format/json.rs
new file mode 100644
index 000000000..c2f4d3755
--- /dev/null
+++ b/vendor/tracing-subscriber/src/fmt/format/json.rs
@@ -0,0 +1,885 @@
+use super::{Format, FormatEvent, FormatFields, FormatTime, Writer};
+use crate::{
+ field::{RecordFields, VisitOutput},
+ fmt::{
+ fmt_layer::{FmtContext, FormattedFields},
+ writer::WriteAdaptor,
+ },
+ registry::LookupSpan,
+};
+use serde::ser::{SerializeMap, Serializer as _};
+use serde_json::Serializer;
+use std::{
+ collections::BTreeMap,
+ fmt::{self, Write},
+};
+use tracing_core::{
+ field::{self, Field},
+ span::Record,
+ Event, Subscriber,
+};
+use tracing_serde::AsSerde;
+
+#[cfg(feature = "tracing-log")]
+use tracing_log::NormalizeEvent;
+
+/// Marker for [`Format`] that indicates that the newline-delimited JSON log
+/// format should be used.
+///
+/// This formatter is intended for production use with systems where structured
+/// logs are consumed as JSON by analysis and viewing tools. The JSON output is
+/// not optimized for human readability; instead, it should be pretty-printed
+/// using external JSON tools such as `jq`, or using a JSON log viewer.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt-json
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt-json`
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821315Z&quot;,&quot;level&quot;:&quot;INFO&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;preparing to shave yaks&quot;,&quot;number_of_yaks&quot;:3},&quot;target&quot;:&quot;fmt_json&quot;}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821422Z&quot;,&quot;level&quot;:&quot;INFO&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;shaving yaks&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821495Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;hello! I&apos;m gonna shave a yak&quot;,&quot;excitement&quot;:&quot;yay!&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;},{&quot;yak&quot;:1,&quot;name&quot;:&quot;shave&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821546Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;yak shaved successfully&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;},{&quot;yak&quot;:1,&quot;name&quot;:&quot;shave&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821598Z&quot;,&quot;level&quot;:&quot;DEBUG&quot;,&quot;fields&quot;:{&quot;yak&quot;:1,&quot;shaved&quot;:true},&quot;target&quot;:&quot;yak_events&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821637Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;yaks_shaved&quot;:1},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821684Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;hello! I&apos;m gonna shave a yak&quot;,&quot;excitement&quot;:&quot;yay!&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;},{&quot;yak&quot;:2,&quot;name&quot;:&quot;shave&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821727Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;yak shaved successfully&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;},{&quot;yak&quot;:2,&quot;name&quot;:&quot;shave&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821773Z&quot;,&quot;level&quot;:&quot;DEBUG&quot;,&quot;fields&quot;:{&quot;yak&quot;:2,&quot;shaved&quot;:true},&quot;target&quot;:&quot;yak_events&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821806Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;yaks_shaved&quot;:2},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821909Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;hello! I&apos;m gonna shave a yak&quot;,&quot;excitement&quot;:&quot;yay!&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;},{&quot;yak&quot;:3,&quot;name&quot;:&quot;shave&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.821956Z&quot;,&quot;level&quot;:&quot;WARN&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;could not locate yak&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;},{&quot;yak&quot;:3,&quot;name&quot;:&quot;shave&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.822006Z&quot;,&quot;level&quot;:&quot;DEBUG&quot;,&quot;fields&quot;:{&quot;yak&quot;:3,&quot;shaved&quot;:false},&quot;target&quot;:&quot;yak_events&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.822041Z&quot;,&quot;level&quot;:&quot;ERROR&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;failed to shave yak&quot;,&quot;yak&quot;:3,&quot;error&quot;:&quot;missing yak&quot;},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.822079Z&quot;,&quot;level&quot;:&quot;TRACE&quot;,&quot;fields&quot;:{&quot;yaks_shaved&quot;:2},&quot;target&quot;:&quot;fmt_json::yak_shave&quot;,&quot;spans&quot;:[{&quot;yaks&quot;:3,&quot;name&quot;:&quot;shaving_yaks&quot;}]}
+/// {&quot;timestamp&quot;:&quot;2022-02-15T18:47:10.822117Z&quot;,&quot;level&quot;:&quot;INFO&quot;,&quot;fields&quot;:{&quot;message&quot;:&quot;yak shaving completed&quot;,&quot;all_yaks_shaved&quot;:false},&quot;target&quot;:&quot;fmt_json&quot;}
+/// </pre>
+///
+/// # Options
+///
+/// This formatter exposes additional options to configure the structure of the
+/// output JSON objects:
+///
+/// - [`Json::flatten_event`] can be used to enable flattening event fields into
+/// the root
+/// - [`Json::with_current_span`] can be used to control logging of the current
+/// span
+/// - [`Json::with_span_list`] can be used to control logging of the span list
+/// object.
+///
+/// By default, event fields are not flattened, and both current span and span
+/// list are logged.
+///
+/// # Valuable Support
+///
+/// Experimental support is available for using the [`valuable`] crate to record
+/// user-defined values as structured JSON. When the ["valuable" unstable
+/// feature][unstable] is enabled, types implementing [`valuable::Valuable`] will
+/// be recorded as structured JSON, rather than
+/// using their [`std::fmt::Debug`] implementations.
+///
+/// **Note**: This is an experimental feature. [Unstable features][unstable]
+/// must be enabled in order to use `valuable` support.
+///
+/// [`Json::flatten_event`]: Json::flatten_event()
+/// [`Json::with_current_span`]: Json::with_current_span()
+/// [`Json::with_span_list`]: Json::with_span_list()
+/// [`valuable`]: https://crates.io/crates/valuable
+/// [unstable]: crate#unstable-features
+/// [`valuable::Valuable`]: https://docs.rs/valuable/latest/valuable/trait.Valuable.html
+#[derive(Debug, Copy, Clone, Eq, PartialEq)]
+pub struct Json {
+ pub(crate) flatten_event: bool,
+ pub(crate) display_current_span: bool,
+ pub(crate) display_span_list: bool,
+}
+
+impl Json {
+ /// If set to `true` event metadata will be flattened into the root object.
+ pub fn flatten_event(&mut self, flatten_event: bool) {
+ self.flatten_event = flatten_event;
+ }
+
+ /// If set to `false`, formatted events won't contain a field for the current span.
+ pub fn with_current_span(&mut self, display_current_span: bool) {
+ self.display_current_span = display_current_span;
+ }
+
+ /// If set to `false`, formatted events won't contain a list of all currently
+ /// entered spans. Spans are logged in a list from root to leaf.
+ pub fn with_span_list(&mut self, display_span_list: bool) {
+ self.display_span_list = display_span_list;
+ }
+}
+
+struct SerializableContext<'a, 'b, Span, N>(
+ &'b crate::layer::Context<'a, Span>,
+ std::marker::PhantomData<N>,
+)
+where
+ Span: Subscriber + for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static;
+
+impl<'a, 'b, Span, N> serde::ser::Serialize for SerializableContext<'a, 'b, Span, N>
+where
+ Span: Subscriber + for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ fn serialize<Ser>(&self, serializer_o: Ser) -> Result<Ser::Ok, Ser::Error>
+ where
+ Ser: serde::ser::Serializer,
+ {
+ use serde::ser::SerializeSeq;
+ let mut serializer = serializer_o.serialize_seq(None)?;
+
+ if let Some(leaf_span) = self.0.lookup_current() {
+ for span in leaf_span.scope().from_root() {
+ serializer.serialize_element(&SerializableSpan(&span, self.1))?;
+ }
+ }
+
+ serializer.end()
+ }
+}
+
+struct SerializableSpan<'a, 'b, Span, N>(
+ &'b crate::registry::SpanRef<'a, Span>,
+ std::marker::PhantomData<N>,
+)
+where
+ Span: for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static;
+
+impl<'a, 'b, Span, N> serde::ser::Serialize for SerializableSpan<'a, 'b, Span, N>
+where
+ Span: for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
+ where
+ Ser: serde::ser::Serializer,
+ {
+ let mut serializer = serializer.serialize_map(None)?;
+
+ let ext = self.0.extensions();
+ let data = ext
+ .get::<FormattedFields<N>>()
+ .expect("Unable to find FormattedFields in extensions; this is a bug");
+
+ // TODO: let's _not_ do this, but this resolves
+ // https://github.com/tokio-rs/tracing/issues/391.
+ // We should probably rework this to use a `serde_json::Value` or something
+ // similar in a JSON-specific layer, but I'd (david)
+ // rather have a uglier fix now rather than shipping broken JSON.
+ match serde_json::from_str::<serde_json::Value>(data) {
+ Ok(serde_json::Value::Object(fields)) => {
+ for field in fields {
+ serializer.serialize_entry(&field.0, &field.1)?;
+ }
+ }
+ // We have fields for this span which are valid JSON but not an object.
+ // This is probably a bug, so panic if we're in debug mode
+ Ok(_) if cfg!(debug_assertions) => panic!(
+ "span '{}' had malformed fields! this is a bug.\n error: invalid JSON object\n fields: {:?}",
+ self.0.metadata().name(),
+ data
+ ),
+ // If we *aren't* in debug mode, it's probably best not to
+ // crash the program, let's log the field found but also an
+ // message saying it's type is invalid
+ Ok(value) => {
+ serializer.serialize_entry("field", &value)?;
+ serializer.serialize_entry("field_error", "field was no a valid object")?
+ }
+ // We have previously recorded fields for this span
+ // should be valid JSON. However, they appear to *not*
+ // be valid JSON. This is almost certainly a bug, so
+ // panic if we're in debug mode
+ Err(e) if cfg!(debug_assertions) => panic!(
+ "span '{}' had malformed fields! this is a bug.\n error: {}\n fields: {:?}",
+ self.0.metadata().name(),
+ e,
+ data
+ ),
+ // If we *aren't* in debug mode, it's probably best not
+ // crash the program, but let's at least make sure it's clear
+ // that the fields are not supposed to be missing.
+ Err(e) => serializer.serialize_entry("field_error", &format!("{}", e))?,
+ };
+ serializer.serialize_entry("name", self.0.metadata().name())?;
+ serializer.end()
+ }
+}
+
+impl<S, N, T> FormatEvent<S, N> for Format<Json, T>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result
+ where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ {
+ let mut timestamp = String::new();
+ self.timer.format_time(&mut Writer::new(&mut timestamp))?;
+
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+
+ let mut visit = || {
+ let mut serializer = Serializer::new(WriteAdaptor::new(&mut writer));
+
+ let mut serializer = serializer.serialize_map(None)?;
+
+ if self.display_timestamp {
+ serializer.serialize_entry("timestamp", &timestamp)?;
+ }
+
+ if self.display_level {
+ serializer.serialize_entry("level", &meta.level().as_serde())?;
+ }
+
+ let format_field_marker: std::marker::PhantomData<N> = std::marker::PhantomData;
+
+ let current_span = if self.format.display_current_span || self.format.display_span_list
+ {
+ event
+ .parent()
+ .and_then(|id| ctx.span(id))
+ .or_else(|| ctx.lookup_current())
+ } else {
+ None
+ };
+
+ if self.format.flatten_event {
+ let mut visitor = tracing_serde::SerdeMapVisitor::new(serializer);
+ event.record(&mut visitor);
+
+ serializer = visitor.take_serializer()?;
+ } else {
+ use tracing_serde::fields::AsMap;
+ serializer.serialize_entry("fields", &event.field_map())?;
+ };
+
+ if self.display_target {
+ serializer.serialize_entry("target", meta.target())?;
+ }
+
+ if self.display_filename {
+ if let Some(filename) = meta.file() {
+ serializer.serialize_entry("filename", filename)?;
+ }
+ }
+
+ if self.display_line_number {
+ if let Some(line_number) = meta.line() {
+ serializer.serialize_entry("line_number", &line_number)?;
+ }
+ }
+
+ if self.format.display_current_span {
+ if let Some(ref span) = current_span {
+ serializer
+ .serialize_entry("span", &SerializableSpan(span, format_field_marker))
+ .unwrap_or(());
+ }
+ }
+
+ if self.format.display_span_list && current_span.is_some() {
+ serializer.serialize_entry(
+ "spans",
+ &SerializableContext(&ctx.ctx, format_field_marker),
+ )?;
+ }
+
+ if self.display_thread_name {
+ let current_thread = std::thread::current();
+ match current_thread.name() {
+ Some(name) => {
+ serializer.serialize_entry("threadName", name)?;
+ }
+ // fall-back to thread id when name is absent and ids are not enabled
+ None if !self.display_thread_id => {
+ serializer
+ .serialize_entry("threadName", &format!("{:?}", current_thread.id()))?;
+ }
+ _ => {}
+ }
+ }
+
+ if self.display_thread_id {
+ serializer
+ .serialize_entry("threadId", &format!("{:?}", std::thread::current().id()))?;
+ }
+
+ serializer.end()
+ };
+
+ visit().map_err(|_| fmt::Error)?;
+ writeln!(writer)
+ }
+}
+
+impl Default for Json {
+ fn default() -> Json {
+ Json {
+ flatten_event: false,
+ display_current_span: true,
+ display_span_list: true,
+ }
+ }
+}
+
+/// The JSON [`FormatFields`] implementation.
+///
+#[derive(Debug)]
+pub struct JsonFields {
+ // reserve the ability to add fields to this without causing a breaking
+ // change in the future.
+ _private: (),
+}
+
+impl JsonFields {
+ /// Returns a new JSON [`FormatFields`] implementation.
+ ///
+ pub fn new() -> Self {
+ Self { _private: () }
+ }
+}
+
+impl Default for JsonFields {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl<'a> FormatFields<'a> for JsonFields {
+ /// Format the provided `fields` to the provided `writer`, returning a result.
+ fn format_fields<R: RecordFields>(&self, mut writer: Writer<'_>, fields: R) -> fmt::Result {
+ let mut v = JsonVisitor::new(&mut writer);
+ fields.record(&mut v);
+ v.finish()
+ }
+
+ /// Record additional field(s) on an existing span.
+ ///
+ /// By default, this appends a space to the current set of fields if it is
+ /// non-empty, and then calls `self.format_fields`. If different behavior is
+ /// required, the default implementation of this method can be overridden.
+ fn add_fields(
+ &self,
+ current: &'a mut FormattedFields<Self>,
+ fields: &Record<'_>,
+ ) -> fmt::Result {
+ if current.is_empty() {
+ // If there are no previously recorded fields, we can just reuse the
+ // existing string.
+ let mut writer = current.as_writer();
+ let mut v = JsonVisitor::new(&mut writer);
+ fields.record(&mut v);
+ v.finish()?;
+ return Ok(());
+ }
+
+ // If fields were previously recorded on this span, we need to parse
+ // the current set of fields as JSON, add the new fields, and
+ // re-serialize them. Otherwise, if we just appended the new fields
+ // to a previously serialized JSON object, we would end up with
+ // malformed JSON.
+ //
+ // XXX(eliza): this is far from efficient, but unfortunately, it is
+ // necessary as long as the JSON formatter is implemented on top of
+ // an interface that stores all formatted fields as strings.
+ //
+ // We should consider reimplementing the JSON formatter as a
+ // separate layer, rather than a formatter for the `fmt` layer —
+ // then, we could store fields as JSON values, and add to them
+ // without having to parse and re-serialize.
+ let mut new = String::new();
+ let map: BTreeMap<&'_ str, serde_json::Value> =
+ serde_json::from_str(current).map_err(|_| fmt::Error)?;
+ let mut v = JsonVisitor::new(&mut new);
+ v.values = map;
+ fields.record(&mut v);
+ v.finish()?;
+ current.fields = new;
+
+ Ok(())
+ }
+}
+
+/// The [visitor] produced by [`JsonFields`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: crate::field::Visit
+/// [`MakeVisitor`]: crate::field::MakeVisitor
+pub struct JsonVisitor<'a> {
+ values: BTreeMap<&'a str, serde_json::Value>,
+ writer: &'a mut dyn Write,
+}
+
+impl<'a> fmt::Debug for JsonVisitor<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_fmt(format_args!("JsonVisitor {{ values: {:?} }}", self.values))
+ }
+}
+
+impl<'a> JsonVisitor<'a> {
+ /// Returns a new default visitor that formats to the provided `writer`.
+ ///
+ /// # Arguments
+ /// - `writer`: the writer to format to.
+ /// - `is_empty`: whether or not any fields have been previously written to
+ /// that writer.
+ pub fn new(writer: &'a mut dyn Write) -> Self {
+ Self {
+ values: BTreeMap::new(),
+ writer,
+ }
+ }
+}
+
+impl<'a> crate::field::VisitFmt for JsonVisitor<'a> {
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ self.writer
+ }
+}
+
+impl<'a> crate::field::VisitOutput<fmt::Result> for JsonVisitor<'a> {
+ fn finish(self) -> fmt::Result {
+ let inner = || {
+ let mut serializer = Serializer::new(WriteAdaptor::new(self.writer));
+ let mut ser_map = serializer.serialize_map(None)?;
+
+ for (k, v) in self.values {
+ ser_map.serialize_entry(k, &v)?;
+ }
+
+ ser_map.end()
+ };
+
+ if inner().is_err() {
+ Err(fmt::Error)
+ } else {
+ Ok(())
+ }
+ }
+}
+
+impl<'a> field::Visit for JsonVisitor<'a> {
+ #[cfg(all(tracing_unstable, feature = "valuable"))]
+ fn record_value(&mut self, field: &Field, value: valuable_crate::Value<'_>) {
+ let value = match serde_json::to_value(valuable_serde::Serializable::new(value)) {
+ Ok(value) => value,
+ Err(_e) => {
+ #[cfg(debug_assertions)]
+ unreachable!(
+ "`valuable::Valuable` implementations should always serialize \
+ successfully, but an error occurred: {}",
+ _e,
+ );
+
+ #[cfg(not(debug_assertions))]
+ return;
+ }
+ };
+
+ self.values.insert(field.name(), value);
+ }
+
+ /// Visit a double precision floating point value.
+ fn record_f64(&mut self, field: &Field, value: f64) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit a signed 64-bit integer value.
+ fn record_i64(&mut self, field: &Field, value: i64) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit an unsigned 64-bit integer value.
+ fn record_u64(&mut self, field: &Field, value: u64) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit a boolean value.
+ fn record_bool(&mut self, field: &Field, value: bool) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit a string value.
+ fn record_str(&mut self, field: &Field, value: &str) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ match field.name() {
+ // Skip fields that are actually log metadata that have already been handled
+ #[cfg(feature = "tracing-log")]
+ name if name.starts_with("log.") => (),
+ name if name.starts_with("r#") => {
+ self.values
+ .insert(&name[2..], serde_json::Value::from(format!("{:?}", value)));
+ }
+ name => {
+ self.values
+ .insert(name, serde_json::Value::from(format!("{:?}", value)));
+ }
+ };
+ }
+}
+#[cfg(test)]
+mod test {
+ use super::*;
+ use crate::fmt::{format::FmtSpan, test::MockMakeWriter, time::FormatTime, SubscriberBuilder};
+ use tracing::{self, subscriber::with_default};
+
+ use std::fmt;
+ use std::path::Path;
+
+ struct MockTime;
+ impl FormatTime for MockTime {
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ write!(w, "fake time")
+ }
+ }
+
+ fn subscriber() -> SubscriberBuilder<JsonFields, Format<Json>> {
+ SubscriberBuilder::default().json()
+ }
+
+ #[test]
+ fn json() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_filename() {
+ let current_path = Path::new("tracing-subscriber")
+ .join("src")
+ .join("fmt")
+ .join("format")
+ .join("json.rs")
+ .to_str()
+ .expect("path must be valid unicode")
+ // escape windows backslashes
+ .replace('\\', "\\\\");
+ let expected =
+ &format!("{}{}{}",
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"filename\":\"",
+ current_path,
+ "\",\"fields\":{\"message\":\"some json test\"}}\n");
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_file(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_line_number() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"line_number\":42,\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_line_number(true)
+ .with_span_list(true);
+ test_json_with_line_number(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_flattened_event() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"message\":\"some json test\"}\n";
+
+ let subscriber = subscriber()
+ .flatten_event(true)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_disabled_current_span_event() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(false)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_disabled_span_list_event() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(false);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_nested_span() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":43,\"name\":\"nested_json_span\",\"number\":4},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3},{\"answer\":43,\"name\":\"nested_json_span\",\"number\":4}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ let span = tracing::span!(
+ tracing::Level::INFO,
+ "nested_json_span",
+ answer = 43,
+ number = 4
+ );
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_no_span() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn record_works() {
+ // This test reproduces issue #707, where using `Span::record` causes
+ // any events inside the span to be ignored.
+
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt()
+ .json()
+ .with_writer(make_writer.clone())
+ .finish();
+
+ with_default(subscriber, || {
+ tracing::info!("an event outside the root span");
+ assert_eq!(
+ parse_as_json(&make_writer)["fields"]["message"],
+ "an event outside the root span"
+ );
+
+ let span = tracing::info_span!("the span", na = tracing::field::Empty);
+ span.record("na", &"value");
+ let _enter = span.enter();
+
+ tracing::info!("an event inside the root span");
+ assert_eq!(
+ parse_as_json(&make_writer)["fields"]["message"],
+ "an event inside the root span"
+ );
+ });
+ }
+
+ #[test]
+ fn json_span_event_show_correct_context() {
+ let buffer = MockMakeWriter::default();
+ let subscriber = subscriber()
+ .with_writer(buffer.clone())
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(false)
+ .with_span_events(FmtSpan::FULL)
+ .finish();
+
+ with_default(subscriber, || {
+ let context = "parent";
+ let parent_span = tracing::info_span!("parent_span", context);
+
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "new");
+ assert_eq!(event["span"]["context"], "parent");
+
+ let _parent_enter = parent_span.enter();
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "enter");
+ assert_eq!(event["span"]["context"], "parent");
+
+ let context = "child";
+ let child_span = tracing::info_span!("child_span", context);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "new");
+ assert_eq!(event["span"]["context"], "child");
+
+ let _child_enter = child_span.enter();
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "enter");
+ assert_eq!(event["span"]["context"], "child");
+
+ drop(_child_enter);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "exit");
+ assert_eq!(event["span"]["context"], "child");
+
+ drop(child_span);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "close");
+ assert_eq!(event["span"]["context"], "child");
+
+ drop(_parent_enter);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "exit");
+ assert_eq!(event["span"]["context"], "parent");
+
+ drop(parent_span);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "close");
+ assert_eq!(event["span"]["context"], "parent");
+ });
+ }
+
+ #[test]
+ fn json_span_event_with_no_fields() {
+ // Check span events serialize correctly.
+ // Discussion: https://github.com/tokio-rs/tracing/issues/829#issuecomment-661984255
+ let buffer = MockMakeWriter::default();
+ let subscriber = subscriber()
+ .with_writer(buffer.clone())
+ .flatten_event(false)
+ .with_current_span(false)
+ .with_span_list(false)
+ .with_span_events(FmtSpan::FULL)
+ .finish();
+
+ with_default(subscriber, || {
+ let span = tracing::info_span!("valid_json");
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "new");
+
+ let _enter = span.enter();
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "enter");
+
+ drop(_enter);
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "exit");
+
+ drop(span);
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "close");
+ });
+ }
+
+ fn parse_as_json(buffer: &MockMakeWriter) -> serde_json::Value {
+ let buf = String::from_utf8(buffer.buf().to_vec()).unwrap();
+ let json = buf
+ .lines()
+ .last()
+ .expect("expected at least one line to be written!");
+ match serde_json::from_str(json) {
+ Ok(v) => v,
+ Err(e) => panic!(
+ "assertion failed: JSON shouldn't be malformed\n error: {}\n json: {}",
+ e, json
+ ),
+ }
+ }
+
+ fn test_json<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<JsonFields, Format<Json>>,
+ producer: impl FnOnce() -> T,
+ ) {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, producer);
+
+ let buf = make_writer.buf();
+ let actual = std::str::from_utf8(&buf[..]).unwrap();
+ assert_eq!(
+ serde_json::from_str::<std::collections::HashMap<&str, serde_json::Value>>(expected)
+ .unwrap(),
+ serde_json::from_str(actual).unwrap()
+ );
+ }
+
+ fn test_json_with_line_number<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<JsonFields, Format<Json>>,
+ producer: impl FnOnce() -> T,
+ ) {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, producer);
+
+ let buf = make_writer.buf();
+ let actual = std::str::from_utf8(&buf[..]).unwrap();
+ let mut expected =
+ serde_json::from_str::<std::collections::HashMap<&str, serde_json::Value>>(expected)
+ .unwrap();
+ let expect_line_number = expected.remove("line_number").is_some();
+ let mut actual: std::collections::HashMap<&str, serde_json::Value> =
+ serde_json::from_str(actual).unwrap();
+ let line_number = actual.remove("line_number");
+ if expect_line_number {
+ assert_eq!(line_number.map(|x| x.is_number()), Some(true));
+ } else {
+ assert!(line_number.is_none());
+ }
+ assert_eq!(actual, expected);
+ }
+}
diff --git a/vendor/tracing-subscriber/src/fmt/format/mod.rs b/vendor/tracing-subscriber/src/fmt/format/mod.rs
new file mode 100644
index 000000000..ec79ac140
--- /dev/null
+++ b/vendor/tracing-subscriber/src/fmt/format/mod.rs
@@ -0,0 +1,2161 @@
+//! Formatters for logging `tracing` events.
+//!
+//! This module provides several formatter implementations, as well as utilities
+//! for implementing custom formatters.
+//!
+//! # Formatters
+//! This module provides a number of formatter implementations:
+//!
+//! * [`Full`]: The default formatter. This emits human-readable,
+//! single-line logs for each event that occurs, with the current span context
+//! displayed before the formatted representation of the event. See
+//! [here](Full#example-output) for sample output.
+//!
+//! * [`Compact`]: A variant of the default formatter, optimized for
+//! short line lengths. Fields from the current span context are appended to
+//! the fields of the formatted event, and span names are not shown; the
+//! verbosity level is abbreviated to a single character. See
+//! [here](Compact#example-output) for sample output.
+//!
+//! * [`Pretty`]: Emits excessively pretty, multi-line logs, optimized
+//! for human readability. This is primarily intended to be used in local
+//! development and debugging, or for command-line applications, where
+//! automated analysis and compact storage of logs is less of a priority than
+//! readability and visual appeal. See [here](Pretty#example-output)
+//! for sample output.
+//!
+//! * [`Json`]: Outputs newline-delimited JSON logs. This is intended
+//! for production use with systems where structured logs are consumed as JSON
+//! by analysis and viewing tools. The JSON output is not optimized for human
+//! readability. See [here](Json#example-output) for sample output.
+use super::time::{FormatTime, SystemTime};
+use crate::{
+ field::{MakeOutput, MakeVisitor, RecordFields, VisitFmt, VisitOutput},
+ fmt::fmt_layer::FmtContext,
+ fmt::fmt_layer::FormattedFields,
+ registry::LookupSpan,
+};
+
+use std::fmt::{self, Debug, Display, Write};
+use tracing_core::{
+ field::{self, Field, Visit},
+ span, Event, Level, Subscriber,
+};
+
+#[cfg(feature = "tracing-log")]
+use tracing_log::NormalizeEvent;
+
+#[cfg(feature = "ansi")]
+use ansi_term::{Colour, Style};
+
+#[cfg(feature = "json")]
+mod json;
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+pub use json::*;
+
+#[cfg(feature = "ansi")]
+mod pretty;
+#[cfg(feature = "ansi")]
+#[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+pub use pretty::*;
+
+/// A type that can format a tracing [`Event`] to a [`Writer`].
+///
+/// `FormatEvent` is primarily used in the context of [`fmt::Subscriber`] or
+/// [`fmt::Layer`]. Each time an event is dispatched to [`fmt::Subscriber`] or
+/// [`fmt::Layer`], the subscriber or layer
+/// forwards it to its associated `FormatEvent` to emit a log message.
+///
+/// This trait is already implemented for function pointers with the same
+/// signature as `format_event`.
+///
+/// # Arguments
+///
+/// The following arguments are passed to `FormatEvent::format_event`:
+///
+/// * A [`FmtContext`]. This is an extension of the [`layer::Context`] type,
+/// which can be used for accessing stored information such as the current
+/// span context an event occurred in.
+///
+/// In addition, [`FmtContext`] exposes access to the [`FormatFields`]
+/// implementation that the subscriber was configured to use via the
+/// [`FmtContext::field_format`] method. This can be used when the
+/// [`FormatEvent`] implementation needs to format the event's fields.
+///
+/// For convenience, [`FmtContext`] also [implements `FormatFields`],
+/// forwarding to the configured [`FormatFields`] type.
+///
+/// * A [`Writer`] to which the formatted representation of the event is
+/// written. This type implements the [`std::fmt::Write`] trait, and therefore
+/// can be used with the [`std::write!`] and [`std::writeln!`] macros, as well
+/// as calling [`std::fmt::Write`] methods directly.
+///
+/// The [`Writer`] type also implements additional methods that provide
+/// information about how the event should be formatted. The
+/// [`Writer::has_ansi_escapes`] method indicates whether [ANSI terminal
+/// escape codes] are supported by the underlying I/O writer that the event
+/// will be written to. If this returns `true`, the formatter is permitted to
+/// use ANSI escape codes to add colors and other text formatting to its
+/// output. If it returns `false`, the event will be written to an output that
+/// does not support ANSI escape codes (such as a log file), and they should
+/// not be emitted.
+///
+/// Crates like [`ansi_term`] and [`owo-colors`] can be used to add ANSI
+/// escape codes to formatted output.
+///
+/// * The actual [`Event`] to be formatted.
+///
+/// # Examples
+///
+/// This example re-implements a simiplified version of this crate's [default
+/// formatter]:
+///
+/// ```rust
+/// use std::fmt;
+/// use tracing_core::{Subscriber, Event};
+/// use tracing_subscriber::fmt::{
+/// format::{self, FormatEvent, FormatFields},
+/// FmtContext,
+/// FormattedFields,
+/// };
+/// use tracing_subscriber::registry::LookupSpan;
+///
+/// struct MyFormatter;
+///
+/// impl<S, N> FormatEvent<S, N> for MyFormatter
+/// where
+/// S: Subscriber + for<'a> LookupSpan<'a>,
+/// N: for<'a> FormatFields<'a> + 'static,
+/// {
+/// fn format_event(
+/// &self,
+/// ctx: &FmtContext<'_, S, N>,
+/// mut writer: format::Writer<'_>,
+/// event: &Event<'_>,
+/// ) -> fmt::Result {
+/// // Format values from the event's's metadata:
+/// let metadata = event.metadata();
+/// write!(&mut writer, "{} {}: ", metadata.level(), metadata.target())?;
+///
+/// // Format all the spans in the event's span context.
+/// if let Some(scope) = ctx.event_scope() {
+/// for span in scope.from_root() {
+/// write!(writer, "{}", span.name())?;
+///
+/// // `FormattedFields` is a formatted representation of the span's
+/// // fields, which is stored in its extensions by the `fmt` layer's
+/// // `new_span` method. The fields will have been formatted
+/// // by the same field formatter that's provided to the event
+/// // formatter in the `FmtContext`.
+/// let ext = span.extensions();
+/// let fields = &ext
+/// .get::<FormattedFields<N>>()
+/// .expect("will never be `None`");
+///
+/// // Skip formatting the fields if the span had no fields.
+/// if !fields.is_empty() {
+/// write!(writer, "{{{}}}", fields)?;
+/// }
+/// write!(writer, ": ")?;
+/// }
+/// }
+///
+/// // Write fields on the event
+/// ctx.field_format().format_fields(writer.by_ref(), event)?;
+///
+/// writeln!(writer)
+/// }
+/// }
+///
+/// let _subscriber = tracing_subscriber::fmt()
+/// .event_format(MyFormatter)
+/// .init();
+///
+/// let _span = tracing::info_span!("my_span", answer = 42).entered();
+/// tracing::info!(question = "life, the universe, and everything", "hello world");
+/// ```
+///
+/// This formatter will print events like this:
+///
+/// ```text
+/// DEBUG yak_shaving::shaver: some-span{field-on-span=foo}: started shaving yak
+/// ```
+///
+/// [`layer::Context`]: crate::layer::Context
+/// [`fmt::Layer`]: super::Layer
+/// [`fmt::Subscriber`]: super::Subscriber
+/// [`Event`]: tracing::Event
+/// [implements `FormatFields`]: super::FmtContext#impl-FormatFields<'writer>
+/// [ANSI terminal escape codes]: https://en.wikipedia.org/wiki/ANSI_escape_code
+/// [`Writer::has_ansi_escapes`]: Writer::has_ansi_escapes
+/// [`ansi_term`]: https://crates.io/crates/ansi_term
+/// [`owo-colors`]: https://crates.io/crates/owo-colors
+/// [default formatter]: Full
+pub trait FormatEvent<S, N>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+{
+ /// Write a log message for `Event` in `Context` to the given [`Writer`].
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result;
+}
+
+impl<S, N> FormatEvent<S, N>
+ for fn(ctx: &FmtContext<'_, S, N>, Writer<'_>, &Event<'_>) -> fmt::Result
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ (*self)(ctx, writer, event)
+ }
+}
+/// A type that can format a [set of fields] to a [`Writer`].
+///
+/// `FormatFields` is primarily used in the context of [`FmtSubscriber`]. Each
+/// time a span or event with fields is recorded, the subscriber will format
+/// those fields with its associated `FormatFields` implementation.
+///
+/// [set of fields]: crate::field::RecordFields
+/// [`FmtSubscriber`]: super::Subscriber
+pub trait FormatFields<'writer> {
+ /// Format the provided `fields` to the provided [`Writer`], returning a result.
+ fn format_fields<R: RecordFields>(&self, writer: Writer<'writer>, fields: R) -> fmt::Result;
+
+ /// Record additional field(s) on an existing span.
+ ///
+ /// By default, this appends a space to the current set of fields if it is
+ /// non-empty, and then calls `self.format_fields`. If different behavior is
+ /// required, the default implementation of this method can be overridden.
+ fn add_fields(
+ &self,
+ current: &'writer mut FormattedFields<Self>,
+ fields: &span::Record<'_>,
+ ) -> fmt::Result {
+ if !current.fields.is_empty() {
+ current.fields.push(' ');
+ }
+ self.format_fields(current.as_writer(), fields)
+ }
+}
+
+/// Returns the default configuration for an [event formatter].
+///
+/// Methods on the returned event formatter can be used for further
+/// configuration. For example:
+///
+/// ```rust
+/// let format = tracing_subscriber::fmt::format()
+/// .without_time() // Don't include timestamps
+/// .with_target(false) // Don't include event targets.
+/// .with_level(false) // Don't include event levels.
+/// .compact(); // Use a more compact, abbreviated format.
+///
+/// // Use the configured formatter when building a new subscriber.
+/// tracing_subscriber::fmt()
+/// .event_format(format)
+/// .init();
+/// ```
+pub fn format() -> Format {
+ Format::default()
+}
+
+/// Returns the default configuration for a JSON [event formatter].
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+pub fn json() -> Format<Json> {
+ format().json()
+}
+
+/// Returns a [`FormatFields`] implementation that formats fields using the
+/// provided function or closure.
+///
+pub fn debug_fn<F>(f: F) -> FieldFn<F>
+where
+ F: Fn(&mut Writer<'_>, &Field, &dyn fmt::Debug) -> fmt::Result + Clone,
+{
+ FieldFn(f)
+}
+
+/// A writer to which formatted representations of spans and events are written.
+///
+/// This type is provided as input to the [`FormatEvent::format_event`] and
+/// [`FormatFields::format_fields`] methods, which will write formatted
+/// representations of [`Event`]s and [fields] to the `Writer`.
+///
+/// This type implements the [`std::fmt::Write`] trait, allowing it to be used
+/// with any function that takes an instance of [`std::fmt::Write`].
+/// Additionally, it can be used with the standard library's [`std::write!`] and
+/// [`std::writeln!`] macros.
+///
+/// Additionally, a `Writer` may expose additional `tracing`-specific
+/// information to the formatter implementation.
+///
+/// [fields]: tracing_core::field
+pub struct Writer<'writer> {
+ writer: &'writer mut dyn fmt::Write,
+ // TODO(eliza): add ANSI support
+ is_ansi: bool,
+}
+
+/// A [`FormatFields`] implementation that formats fields by calling a function
+/// or closure.
+///
+#[derive(Debug, Clone)]
+pub struct FieldFn<F>(F);
+/// The [visitor] produced by [`FieldFn`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: super::super::field::Visit
+/// [`MakeVisitor`]: super::super::field::MakeVisitor
+pub struct FieldFnVisitor<'a, F> {
+ f: F,
+ writer: Writer<'a>,
+ result: fmt::Result,
+}
+/// Marker for [`Format`] that indicates that the compact log format should be used.
+///
+/// The compact format includes fields from all currently entered spans, after
+/// the event's fields. Span names are listed in order before fields are
+/// displayed.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt-compact
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt-compact`
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809287Z </font><font color="#4E9A06"> INFO</font> <b>fmt_compact</b><font color="#AAAAAA">: preparing to shave yaks </font><i>number_of_yaks</i><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809367Z </font><font color="#4E9A06"> INFO</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: shaving yaks </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809414Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: hello! I&apos;m gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">=&quot;yay!&quot; </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=1</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809443Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: yak shaved successfully </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=1</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809477Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks</b>: <b>yak_events</b><font color="#AAAAAA">: </font><i>yak</i><font color="#AAAAAA">=1 </font><i>shaved</i><font color="#AAAAAA">=true </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809500Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: </font><i>yaks_shaved</i><font color="#AAAAAA">=1 </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809531Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: hello! I&apos;m gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">=&quot;yay!&quot; </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809554Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: yak shaved successfully </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809581Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks</b>: <b>yak_events</b><font color="#AAAAAA">: </font><i>yak</i><font color="#AAAAAA">=2 </font><i>shaved</i><font color="#AAAAAA">=true </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809606Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: </font><i>yaks_shaved</i><font color="#AAAAAA">=2 </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809635Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: hello! I&apos;m gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">=&quot;yay!&quot; </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809664Z </font><font color="#C4A000"> WARN</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: could not locate yak </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809693Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks</b>: <b>yak_events</b><font color="#AAAAAA">: </font><i>yak</i><font color="#AAAAAA">=3 </font><i>shaved</i><font color="#AAAAAA">=false </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809717Z </font><font color="#CC0000">ERROR</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: failed to shave yak </font><i>yak</i><font color="#AAAAAA">=3 </font><i>error</i><font color="#AAAAAA">=missing yak </font><i>error.sources</i><font color="#AAAAAA">=[out of space, out of cash] </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809743Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: </font><i>yaks_shaved</i><font color="#AAAAAA">=2 </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809768Z </font><font color="#4E9A06"> INFO</font> <b>fmt_compact</b><font color="#AAAAAA">: yak shaving completed </font><i>all_yaks_shaved</i><font color="#AAAAAA">=false</font>
+///
+/// </pre>
+#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
+pub struct Compact;
+
+/// Marker for [`Format`] that indicates that the default log format should be used.
+///
+/// This formatter shows the span context before printing event data. Spans are
+/// displayed including their names and fields.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt`
+/// <font color="#AAAAAA">2022-02-15T18:40:14.289898Z </font><font color="#4E9A06"> INFO</font> fmt: preparing to shave yaks <i>number_of_yaks</i><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.289974Z </font><font color="#4E9A06"> INFO</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: shaving yaks</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290011Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=1</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: hello! I&apos;m gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">=&quot;yay!&quot;</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290038Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=1</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: yak shaved successfully</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290070Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: yak_events: </font><i>yak</i><font color="#AAAAAA">=1 </font><i>shaved</i><font color="#AAAAAA">=true</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290089Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: </font><i>yaks_shaved</i><font color="#AAAAAA">=1</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290114Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=2</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: hello! I&apos;m gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">=&quot;yay!&quot;</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290134Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=2</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: yak shaved successfully</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290157Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: yak_events: </font><i>yak</i><font color="#AAAAAA">=2 </font><i>shaved</i><font color="#AAAAAA">=true</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290174Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: </font><i>yaks_shaved</i><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290198Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: hello! I&apos;m gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">=&quot;yay!&quot;</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290222Z </font><font color="#C4A000"> WARN</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: could not locate yak</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290247Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: yak_events: </font><i>yak</i><font color="#AAAAAA">=3 </font><i>shaved</i><font color="#AAAAAA">=false</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290268Z </font><font color="#CC0000">ERROR</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: failed to shave yak </font><i>yak</i><font color="#AAAAAA">=3 </font><i>error</i><font color="#AAAAAA">=missing yak </font><i>error.sources</i><font color="#AAAAAA">=[out of space, out of cash]</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290287Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: </font><i>yaks_shaved</i><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290309Z </font><font color="#4E9A06"> INFO</font> fmt: yak shaving completed. <i>all_yaks_shaved</i><font color="#AAAAAA">=false</font>
+/// </pre>
+#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
+pub struct Full;
+
+/// A pre-configured event formatter.
+///
+/// You will usually want to use this as the `FormatEvent` for a `FmtSubscriber`.
+///
+/// The default logging format, [`Full`] includes all fields in each event and its containing
+/// spans. The [`Compact`] logging format is intended to produce shorter log
+/// lines; it displays each event's fields, along with fields from the current
+/// span context, but other information is abbreviated. The [`Pretty`] logging
+/// format is an extra-verbose, multi-line human-readable logging format
+/// intended for use in development.
+#[derive(Debug, Clone)]
+pub struct Format<F = Full, T = SystemTime> {
+ format: F,
+ pub(crate) timer: T,
+ pub(crate) ansi: Option<bool>,
+ pub(crate) display_timestamp: bool,
+ pub(crate) display_target: bool,
+ pub(crate) display_level: bool,
+ pub(crate) display_thread_id: bool,
+ pub(crate) display_thread_name: bool,
+ pub(crate) display_filename: bool,
+ pub(crate) display_line_number: bool,
+}
+
+// === impl Writer ===
+
+impl<'writer> Writer<'writer> {
+ // TODO(eliza): consider making this a public API?
+ // We may not want to do that if we choose to expose specialized
+ // constructors instead (e.g. `from_string` that stores whether the string
+ // is empty...?)
+ pub(crate) fn new(writer: &'writer mut impl fmt::Write) -> Self {
+ Self {
+ writer: writer as &mut dyn fmt::Write,
+ is_ansi: false,
+ }
+ }
+
+ // TODO(eliza): consider making this a public API?
+ pub(crate) fn with_ansi(self, is_ansi: bool) -> Self {
+ Self { is_ansi, ..self }
+ }
+
+ /// Return a new `Writer` that mutably borrows `self`.
+ ///
+ /// This can be used to temporarily borrow a `Writer` to pass a new `Writer`
+ /// to a function that takes a `Writer` by value, allowing the original writer
+ /// to still be used once that function returns.
+ pub fn by_ref(&mut self) -> Writer<'_> {
+ let is_ansi = self.is_ansi;
+ Writer {
+ writer: self as &mut dyn fmt::Write,
+ is_ansi,
+ }
+ }
+
+ /// Writes a string slice into this `Writer`, returning whether the write succeeded.
+ ///
+ /// This method can only succeed if the entire string slice was successfully
+ /// written, and this method will not return until all data has been written
+ /// or an error occurs.
+ ///
+ /// This is identical to calling the [`write_str` method] from the `Writer`'s
+ /// [`std::fmt::Write`] implementation. However, it is also provided as an
+ /// inherent method, so that `Writer`s can be used without needing to import the
+ /// [`std::fmt::Write`] trait.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an instance of [`std::fmt::Error`] on error.
+ ///
+ /// [`write_str` method]: std::fmt::Write::write_str
+ #[inline]
+ pub fn write_str(&mut self, s: &str) -> fmt::Result {
+ self.writer.write_str(s)
+ }
+
+ /// Writes a [`char`] into this writer, returning whether the write succeeded.
+ ///
+ /// A single [`char`] may be encoded as more than one byte.
+ /// This method can only succeed if the entire byte sequence was successfully
+ /// written, and this method will not return until all data has been
+ /// written or an error occurs.
+ ///
+ /// This is identical to calling the [`write_char` method] from the `Writer`'s
+ /// [`std::fmt::Write`] implementation. However, it is also provided as an
+ /// inherent method, so that `Writer`s can be used without needing to import the
+ /// [`std::fmt::Write`] trait.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an instance of [`std::fmt::Error`] on error.
+ ///
+ /// [`write_char` method]: std::fmt::Write::write_char
+ #[inline]
+ pub fn write_char(&mut self, c: char) -> fmt::Result {
+ self.writer.write_char(c)
+ }
+
+ /// Glue for usage of the [`write!`] macro with `Writer`s.
+ ///
+ /// This method should generally not be invoked manually, but rather through
+ /// the [`write!`] macro itself.
+ ///
+ /// This is identical to calling the [`write_fmt` method] from the `Writer`'s
+ /// [`std::fmt::Write`] implementation. However, it is also provided as an
+ /// inherent method, so that `Writer`s can be used with the [`write!` macro]
+ /// without needing to import the
+ /// [`std::fmt::Write`] trait.
+ ///
+ /// [`write_fmt` method]: std::fmt::Write::write_fmt
+ pub fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> fmt::Result {
+ self.writer.write_fmt(args)
+ }
+
+ /// Returns `true` if [ANSI escape codes] may be used to add colors
+ /// and other formatting when writing to this `Writer`.
+ ///
+ /// If this returns `false`, formatters should not emit ANSI escape codes.
+ ///
+ /// [ANSI escape codes]: https://en.wikipedia.org/wiki/ANSI_escape_code
+ pub fn has_ansi_escapes(&self) -> bool {
+ self.is_ansi
+ }
+
+ pub(in crate::fmt::format) fn bold(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.is_ansi {
+ return Style::new().bold();
+ }
+ }
+
+ Style::new()
+ }
+
+ pub(in crate::fmt::format) fn dimmed(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.is_ansi {
+ return Style::new().dimmed();
+ }
+ }
+
+ Style::new()
+ }
+
+ pub(in crate::fmt::format) fn italic(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.is_ansi {
+ return Style::new().italic();
+ }
+ }
+
+ Style::new()
+ }
+}
+
+impl fmt::Write for Writer<'_> {
+ #[inline]
+ fn write_str(&mut self, s: &str) -> fmt::Result {
+ Writer::write_str(self, s)
+ }
+
+ #[inline]
+ fn write_char(&mut self, c: char) -> fmt::Result {
+ Writer::write_char(self, c)
+ }
+
+ #[inline]
+ fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> fmt::Result {
+ Writer::write_fmt(self, args)
+ }
+}
+
+impl fmt::Debug for Writer<'_> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Writer")
+ .field("writer", &format_args!("<&mut dyn fmt::Write>"))
+ .field("is_ansi", &self.is_ansi)
+ .finish()
+ }
+}
+
+// === impl Format ===
+
+impl Default for Format<Full, SystemTime> {
+ fn default() -> Self {
+ Format {
+ format: Full,
+ timer: SystemTime,
+ ansi: None,
+ display_timestamp: true,
+ display_target: true,
+ display_level: true,
+ display_thread_id: false,
+ display_thread_name: false,
+ display_filename: false,
+ display_line_number: false,
+ }
+ }
+}
+
+impl<F, T> Format<F, T> {
+ /// Use a less verbose output format.
+ ///
+ /// See [`Compact`].
+ pub fn compact(self) -> Format<Compact, T> {
+ Format {
+ format: Compact,
+ timer: self.timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Use an excessively pretty, human-readable output format.
+ ///
+ /// See [`Pretty`].
+ ///
+ /// Note that this requires the "ansi" feature to be enabled.
+ ///
+ /// # Options
+ ///
+ /// [`Format::with_ansi`] can be used to disable ANSI terminal escape codes (which enable
+ /// formatting such as colors, bold, italic, etc) in event formatting. However, a field
+ /// formatter must be manually provided to avoid ANSI in the formatting of parent spans, like
+ /// so:
+ ///
+ /// ```
+ /// # use tracing_subscriber::fmt::format;
+ /// tracing_subscriber::fmt()
+ /// .pretty()
+ /// .with_ansi(false)
+ /// .fmt_fields(format::PrettyFields::new().with_ansi(false))
+ /// // ... other settings ...
+ /// .init();
+ /// ```
+ #[cfg(feature = "ansi")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+ pub fn pretty(self) -> Format<Pretty, T> {
+ Format {
+ format: Pretty::default(),
+ timer: self.timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: true,
+ display_line_number: true,
+ }
+ }
+
+ /// Use the full JSON format.
+ ///
+ /// The full format includes fields from all entered spans.
+ ///
+ /// # Example Output
+ ///
+ /// ```ignore,json
+ /// {"timestamp":"Feb 20 11:28:15.096","level":"INFO","target":"mycrate","fields":{"message":"some message", "key": "value"}}
+ /// ```
+ ///
+ /// # Options
+ ///
+ /// - [`Format::flatten_event`] can be used to enable flattening event fields into the root
+ /// object.
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn json(self) -> Format<Json, T> {
+ Format {
+ format: Json::default(),
+ timer: self.timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Use the given [`timer`] for log message timestamps.
+ ///
+ /// See [`time` module] for the provided timer implementations.
+ ///
+ /// Note that using the `"time"` feature flag enables the
+ /// additional time formatters [`UtcTime`] and [`LocalTime`], which use the
+ /// [`time` crate] to provide more sophisticated timestamp formatting
+ /// options.
+ ///
+ /// [`timer`]: super::time::FormatTime
+ /// [`time` module]: mod@super::time
+ /// [`UtcTime`]: super::time::UtcTime
+ /// [`LocalTime`]: super::time::LocalTime
+ /// [`time` crate]: https://docs.rs/time/0.3
+ pub fn with_timer<T2>(self, timer: T2) -> Format<F, T2> {
+ Format {
+ format: self.format,
+ timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Do not emit timestamps with log messages.
+ pub fn without_time(self) -> Format<F, ()> {
+ Format {
+ format: self.format,
+ timer: (),
+ ansi: self.ansi,
+ display_timestamp: false,
+ display_target: self.display_target,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Enable ANSI terminal colors for formatted output.
+ pub fn with_ansi(self, ansi: bool) -> Format<F, T> {
+ Format {
+ ansi: Some(ansi),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's target is displayed.
+ pub fn with_target(self, display_target: bool) -> Format<F, T> {
+ Format {
+ display_target,
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's level is displayed.
+ pub fn with_level(self, display_level: bool) -> Format<F, T> {
+ Format {
+ display_level,
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [thread ID] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [thread ID]: std::thread::ThreadId
+ pub fn with_thread_ids(self, display_thread_id: bool) -> Format<F, T> {
+ Format {
+ display_thread_id,
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [name] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [name]: std::thread#naming-threads
+ pub fn with_thread_names(self, display_thread_name: bool) -> Format<F, T> {
+ Format {
+ display_thread_name,
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's [source code file path][file] is
+ /// displayed.
+ ///
+ /// [file]: tracing_core::Metadata::file
+ pub fn with_file(self, display_filename: bool) -> Format<F, T> {
+ Format {
+ display_filename,
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's [source code line number][line] is
+ /// displayed.
+ ///
+ /// [line]: tracing_core::Metadata::line
+ pub fn with_line_number(self, display_line_number: bool) -> Format<F, T> {
+ Format {
+ display_line_number,
+ ..self
+ }
+ }
+
+ /// Sets whether or not the source code location from which an event
+ /// originated is displayed.
+ ///
+ /// This is equivalent to calling [`Format::with_file`] and
+ /// [`Format::with_line_number`] with the same value.
+ pub fn with_source_location(self, display_location: bool) -> Self {
+ self.with_line_number(display_location)
+ .with_file(display_location)
+ }
+
+ #[inline]
+ fn format_timestamp(&self, writer: &mut Writer<'_>) -> fmt::Result
+ where
+ T: FormatTime,
+ {
+ // If timestamps are disabled, do nothing.
+ if !self.display_timestamp {
+ return Ok(());
+ }
+
+ // If ANSI color codes are enabled, format the timestamp with ANSI
+ // colors.
+ #[cfg(feature = "ansi")]
+ {
+ if writer.has_ansi_escapes() {
+ let style = Style::new().dimmed();
+ write!(writer, "{}", style.prefix())?;
+
+ // If getting the timestamp failed, don't bail --- only bail on
+ // formatting errors.
+ if self.timer.format_time(writer).is_err() {
+ writer.write_str("<unknown time>")?;
+ }
+
+ write!(writer, "{} ", style.suffix())?;
+ return Ok(());
+ }
+ }
+
+ // Otherwise, just format the timestamp without ANSI formatting.
+ // If getting the timestamp failed, don't bail --- only bail on
+ // formatting errors.
+ if self.timer.format_time(writer).is_err() {
+ writer.write_str("<unknown time>")?;
+ }
+ writer.write_char(' ')
+ }
+}
+
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+impl<T> Format<Json, T> {
+ /// Use the full JSON format with the event's event fields flattened.
+ ///
+ /// # Example Output
+ ///
+ /// ```ignore,json
+ /// {"timestamp":"Feb 20 11:28:15.096","level":"INFO","target":"mycrate", "message":"some message", "key": "value"}
+ /// ```
+ /// See [`Json`][super::format::Json].
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn flatten_event(mut self, flatten_event: bool) -> Format<Json, T> {
+ self.format.flatten_event(flatten_event);
+ self
+ }
+
+ /// Sets whether or not the formatter will include the current span in
+ /// formatted events.
+ ///
+ /// See [`format::Json`][Json]
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn with_current_span(mut self, display_current_span: bool) -> Format<Json, T> {
+ self.format.with_current_span(display_current_span);
+ self
+ }
+
+ /// Sets whether or not the formatter will include a list (from root to
+ /// leaf) of all currently entered spans in formatted events.
+ ///
+ /// See [`format::Json`][Json]
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn with_span_list(mut self, display_span_list: bool) -> Format<Json, T> {
+ self.format.with_span_list(display_span_list);
+ self
+ }
+}
+
+impl<S, N, T> FormatEvent<S, N> for Format<Full, T>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+
+ // if the `Format` struct *also* has an ANSI color configuration,
+ // override the writer...the API for configuring ANSI color codes on the
+ // `Format` struct is deprecated, but we still need to honor those
+ // configurations.
+ if let Some(ansi) = self.ansi {
+ writer = writer.with_ansi(ansi);
+ }
+
+ self.format_timestamp(&mut writer)?;
+
+ if self.display_level {
+ let fmt_level = {
+ #[cfg(feature = "ansi")]
+ {
+ FmtLevel::new(meta.level(), writer.has_ansi_escapes())
+ }
+ #[cfg(not(feature = "ansi"))]
+ {
+ FmtLevel::new(meta.level())
+ }
+ };
+ write!(writer, "{} ", fmt_level)?;
+ }
+
+ if self.display_thread_name {
+ let current_thread = std::thread::current();
+ match current_thread.name() {
+ Some(name) => {
+ write!(writer, "{} ", FmtThreadName::new(name))?;
+ }
+ // fall-back to thread id when name is absent and ids are not enabled
+ None if !self.display_thread_id => {
+ write!(writer, "{:0>2?} ", current_thread.id())?;
+ }
+ _ => {}
+ }
+ }
+
+ if self.display_thread_id {
+ write!(writer, "{:0>2?} ", std::thread::current().id())?;
+ }
+
+ let dimmed = writer.dimmed();
+
+ if let Some(scope) = ctx.event_scope() {
+ let bold = writer.bold();
+
+ let mut seen = false;
+
+ for span in scope.from_root() {
+ write!(writer, "{}", bold.paint(span.metadata().name()))?;
+ seen = true;
+
+ let ext = span.extensions();
+ if let Some(fields) = &ext.get::<FormattedFields<N>>() {
+ if !fields.is_empty() {
+ write!(writer, "{}{}{}", bold.paint("{"), fields, bold.paint("}"))?;
+ }
+ }
+ write!(writer, "{}", dimmed.paint(":"))?;
+ }
+
+ if seen {
+ writer.write_char(' ')?;
+ }
+ };
+
+ if self.display_target {
+ write!(
+ writer,
+ "{}{} ",
+ dimmed.paint(meta.target()),
+ dimmed.paint(":")
+ )?;
+ }
+
+ let line_number = if self.display_line_number {
+ meta.line()
+ } else {
+ None
+ };
+
+ if self.display_filename {
+ if let Some(filename) = meta.file() {
+ write!(
+ writer,
+ "{}{}{}",
+ dimmed.paint(filename),
+ dimmed.paint(":"),
+ if line_number.is_some() { "" } else { " " }
+ )?;
+ }
+ }
+
+ if let Some(line_number) = line_number {
+ write!(
+ writer,
+ "{}{}:{} ",
+ dimmed.prefix(),
+ line_number,
+ dimmed.suffix()
+ )?;
+ }
+
+ ctx.format_fields(writer.by_ref(), event)?;
+ writeln!(writer)
+ }
+}
+
+impl<S, N, T> FormatEvent<S, N> for Format<Compact, T>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+
+ // if the `Format` struct *also* has an ANSI color configuration,
+ // override the writer...the API for configuring ANSI color codes on the
+ // `Format` struct is deprecated, but we still need to honor those
+ // configurations.
+ if let Some(ansi) = self.ansi {
+ writer = writer.with_ansi(ansi);
+ }
+
+ self.format_timestamp(&mut writer)?;
+
+ if self.display_level {
+ let fmt_level = {
+ #[cfg(feature = "ansi")]
+ {
+ FmtLevel::new(meta.level(), writer.has_ansi_escapes())
+ }
+ #[cfg(not(feature = "ansi"))]
+ {
+ FmtLevel::new(meta.level())
+ }
+ };
+ write!(writer, "{} ", fmt_level)?;
+ }
+
+ if self.display_thread_name {
+ let current_thread = std::thread::current();
+ match current_thread.name() {
+ Some(name) => {
+ write!(writer, "{} ", FmtThreadName::new(name))?;
+ }
+ // fall-back to thread id when name is absent and ids are not enabled
+ None if !self.display_thread_id => {
+ write!(writer, "{:0>2?} ", current_thread.id())?;
+ }
+ _ => {}
+ }
+ }
+
+ if self.display_thread_id {
+ write!(writer, "{:0>2?} ", std::thread::current().id())?;
+ }
+
+ let fmt_ctx = {
+ #[cfg(feature = "ansi")]
+ {
+ FmtCtx::new(ctx, event.parent(), writer.has_ansi_escapes())
+ }
+ #[cfg(not(feature = "ansi"))]
+ {
+ FmtCtx::new(&ctx, event.parent())
+ }
+ };
+ write!(writer, "{}", fmt_ctx)?;
+
+ let bold = writer.bold();
+ let dimmed = writer.dimmed();
+
+ let mut needs_space = false;
+ if self.display_target {
+ write!(writer, "{}{}", bold.paint(meta.target()), dimmed.paint(":"))?;
+ needs_space = true;
+ }
+
+ if self.display_filename {
+ if let Some(filename) = meta.file() {
+ if self.display_target {
+ writer.write_char(' ')?;
+ }
+ write!(writer, "{}{}", bold.paint(filename), dimmed.paint(":"))?;
+ needs_space = true;
+ }
+ }
+
+ if self.display_line_number {
+ if let Some(line_number) = meta.line() {
+ write!(
+ writer,
+ "{}{}{}{}",
+ bold.prefix(),
+ line_number,
+ bold.suffix(),
+ dimmed.paint(":")
+ )?;
+ needs_space = true;
+ }
+ }
+
+ if needs_space {
+ writer.write_char(' ')?;
+ }
+
+ ctx.format_fields(writer.by_ref(), event)?;
+
+ for span in ctx
+ .event_scope()
+ .into_iter()
+ .flat_map(crate::registry::Scope::from_root)
+ {
+ let exts = span.extensions();
+ if let Some(fields) = exts.get::<FormattedFields<N>>() {
+ if !fields.is_empty() {
+ write!(writer, " {}", dimmed.paint(&fields.fields))?;
+ }
+ }
+ }
+ writeln!(writer)
+ }
+}
+
+// === impl FormatFields ===
+impl<'writer, M> FormatFields<'writer> for M
+where
+ M: MakeOutput<Writer<'writer>, fmt::Result>,
+ M::Visitor: VisitFmt + VisitOutput<fmt::Result>,
+{
+ fn format_fields<R: RecordFields>(&self, writer: Writer<'writer>, fields: R) -> fmt::Result {
+ let mut v = self.make_visitor(writer);
+ fields.record(&mut v);
+ v.finish()
+ }
+}
+
+/// The default [`FormatFields`] implementation.
+///
+#[derive(Debug)]
+pub struct DefaultFields {
+ // reserve the ability to add fields to this without causing a breaking
+ // change in the future.
+ _private: (),
+}
+
+/// The [visitor] produced by [`DefaultFields`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: super::super::field::Visit
+/// [`MakeVisitor`]: super::super::field::MakeVisitor
+#[derive(Debug)]
+pub struct DefaultVisitor<'a> {
+ writer: Writer<'a>,
+ is_empty: bool,
+ result: fmt::Result,
+}
+
+impl DefaultFields {
+ /// Returns a new default [`FormatFields`] implementation.
+ ///
+ pub fn new() -> Self {
+ Self { _private: () }
+ }
+}
+
+impl Default for DefaultFields {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl<'a> MakeVisitor<Writer<'a>> for DefaultFields {
+ type Visitor = DefaultVisitor<'a>;
+
+ #[inline]
+ fn make_visitor(&self, target: Writer<'a>) -> Self::Visitor {
+ DefaultVisitor::new(target, true)
+ }
+}
+
+// === impl DefaultVisitor ===
+
+impl<'a> DefaultVisitor<'a> {
+ /// Returns a new default visitor that formats to the provided `writer`.
+ ///
+ /// # Arguments
+ /// - `writer`: the writer to format to.
+ /// - `is_empty`: whether or not any fields have been previously written to
+ /// that writer.
+ pub fn new(writer: Writer<'a>, is_empty: bool) -> Self {
+ Self {
+ writer,
+ is_empty,
+ result: Ok(()),
+ }
+ }
+
+ fn maybe_pad(&mut self) {
+ if self.is_empty {
+ self.is_empty = false;
+ } else {
+ self.result = write!(self.writer, " ");
+ }
+ }
+}
+
+impl<'a> field::Visit for DefaultVisitor<'a> {
+ fn record_str(&mut self, field: &Field, value: &str) {
+ if self.result.is_err() {
+ return;
+ }
+
+ if field.name() == "message" {
+ self.record_debug(field, &format_args!("{}", value))
+ } else {
+ self.record_debug(field, &value)
+ }
+ }
+
+ fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
+ if let Some(source) = value.source() {
+ let italic = self.writer.italic();
+ self.record_debug(
+ field,
+ &format_args!(
+ "{} {}{}{}{}",
+ value,
+ italic.paint(field.name()),
+ italic.paint(".sources"),
+ self.writer.dimmed().paint("="),
+ ErrorSourceList(source)
+ ),
+ )
+ } else {
+ self.record_debug(field, &format_args!("{}", value))
+ }
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ if self.result.is_err() {
+ return;
+ }
+
+ self.maybe_pad();
+ self.result = match field.name() {
+ "message" => write!(self.writer, "{:?}", value),
+ // Skip fields that are actually log metadata that have already been handled
+ #[cfg(feature = "tracing-log")]
+ name if name.starts_with("log.") => Ok(()),
+ name if name.starts_with("r#") => write!(
+ self.writer,
+ "{}{}{:?}",
+ self.writer.italic().paint(&name[2..]),
+ self.writer.dimmed().paint("="),
+ value
+ ),
+ name => write!(
+ self.writer,
+ "{}{}{:?}",
+ self.writer.italic().paint(name),
+ self.writer.dimmed().paint("="),
+ value
+ ),
+ };
+ }
+}
+
+impl<'a> crate::field::VisitOutput<fmt::Result> for DefaultVisitor<'a> {
+ fn finish(self) -> fmt::Result {
+ self.result
+ }
+}
+
+impl<'a> crate::field::VisitFmt for DefaultVisitor<'a> {
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ &mut self.writer
+ }
+}
+
+/// Renders an error into a list of sources, *including* the error
+struct ErrorSourceList<'a>(&'a (dyn std::error::Error + 'static));
+
+impl<'a> Display for ErrorSourceList<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut list = f.debug_list();
+ let mut curr = Some(self.0);
+ while let Some(curr_err) = curr {
+ list.entry(&format_args!("{}", curr_err));
+ curr = curr_err.source();
+ }
+ list.finish()
+ }
+}
+
+struct FmtCtx<'a, S, N> {
+ ctx: &'a FmtContext<'a, S, N>,
+ span: Option<&'a span::Id>,
+ #[cfg(feature = "ansi")]
+ ansi: bool,
+}
+
+impl<'a, S, N: 'a> FmtCtx<'a, S, N>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ #[cfg(feature = "ansi")]
+ pub(crate) fn new(
+ ctx: &'a FmtContext<'_, S, N>,
+ span: Option<&'a span::Id>,
+ ansi: bool,
+ ) -> Self {
+ Self { ctx, span, ansi }
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ pub(crate) fn new(ctx: &'a FmtContext<'_, S, N>, span: Option<&'a span::Id>) -> Self {
+ Self { ctx, span }
+ }
+
+ fn bold(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.ansi {
+ return Style::new().bold();
+ }
+ }
+
+ Style::new()
+ }
+}
+
+impl<'a, S, N: 'a> fmt::Display for FmtCtx<'a, S, N>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let bold = self.bold();
+ let mut seen = false;
+
+ let span = self
+ .span
+ .and_then(|id| self.ctx.ctx.span(id))
+ .or_else(|| self.ctx.ctx.lookup_current());
+
+ let scope = span.into_iter().flat_map(|span| span.scope().from_root());
+
+ for span in scope {
+ seen = true;
+ write!(f, "{}:", bold.paint(span.metadata().name()))?;
+ }
+
+ if seen {
+ f.write_char(' ')?;
+ }
+ Ok(())
+ }
+}
+
+#[cfg(not(feature = "ansi"))]
+struct Style;
+
+#[cfg(not(feature = "ansi"))]
+impl Style {
+ fn new() -> Self {
+ Style
+ }
+
+ fn bold(self) -> Self {
+ self
+ }
+
+ fn paint(&self, d: impl fmt::Display) -> impl fmt::Display {
+ d
+ }
+
+ fn prefix(&self) -> impl fmt::Display {
+ ""
+ }
+
+ fn suffix(&self) -> impl fmt::Display {
+ ""
+ }
+}
+
+struct FmtThreadName<'a> {
+ name: &'a str,
+}
+
+impl<'a> FmtThreadName<'a> {
+ pub(crate) fn new(name: &'a str) -> Self {
+ Self { name }
+ }
+}
+
+impl<'a> fmt::Display for FmtThreadName<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ use std::sync::atomic::{
+ AtomicUsize,
+ Ordering::{AcqRel, Acquire, Relaxed},
+ };
+
+ // Track the longest thread name length we've seen so far in an atomic,
+ // so that it can be updated by any thread.
+ static MAX_LEN: AtomicUsize = AtomicUsize::new(0);
+ let len = self.name.len();
+ // Snapshot the current max thread name length.
+ let mut max_len = MAX_LEN.load(Relaxed);
+
+ while len > max_len {
+ // Try to set a new max length, if it is still the value we took a
+ // snapshot of.
+ match MAX_LEN.compare_exchange(max_len, len, AcqRel, Acquire) {
+ // We successfully set the new max value
+ Ok(_) => break,
+ // Another thread set a new max value since we last observed
+ // it! It's possible that the new length is actually longer than
+ // ours, so we'll loop again and check whether our length is
+ // still the longest. If not, we'll just use the newer value.
+ Err(actual) => max_len = actual,
+ }
+ }
+
+ // pad thread name using `max_len`
+ write!(f, "{:>width$}", self.name, width = max_len)
+ }
+}
+
+struct FmtLevel<'a> {
+ level: &'a Level,
+ #[cfg(feature = "ansi")]
+ ansi: bool,
+}
+
+impl<'a> FmtLevel<'a> {
+ #[cfg(feature = "ansi")]
+ pub(crate) fn new(level: &'a Level, ansi: bool) -> Self {
+ Self { level, ansi }
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ pub(crate) fn new(level: &'a Level) -> Self {
+ Self { level }
+ }
+}
+
+const TRACE_STR: &str = "TRACE";
+const DEBUG_STR: &str = "DEBUG";
+const INFO_STR: &str = " INFO";
+const WARN_STR: &str = " WARN";
+const ERROR_STR: &str = "ERROR";
+
+#[cfg(not(feature = "ansi"))]
+impl<'a> fmt::Display for FmtLevel<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self.level {
+ Level::TRACE => f.pad(TRACE_STR),
+ Level::DEBUG => f.pad(DEBUG_STR),
+ Level::INFO => f.pad(INFO_STR),
+ Level::WARN => f.pad(WARN_STR),
+ Level::ERROR => f.pad(ERROR_STR),
+ }
+ }
+}
+
+#[cfg(feature = "ansi")]
+impl<'a> fmt::Display for FmtLevel<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ if self.ansi {
+ match *self.level {
+ Level::TRACE => write!(f, "{}", Colour::Purple.paint(TRACE_STR)),
+ Level::DEBUG => write!(f, "{}", Colour::Blue.paint(DEBUG_STR)),
+ Level::INFO => write!(f, "{}", Colour::Green.paint(INFO_STR)),
+ Level::WARN => write!(f, "{}", Colour::Yellow.paint(WARN_STR)),
+ Level::ERROR => write!(f, "{}", Colour::Red.paint(ERROR_STR)),
+ }
+ } else {
+ match *self.level {
+ Level::TRACE => f.pad(TRACE_STR),
+ Level::DEBUG => f.pad(DEBUG_STR),
+ Level::INFO => f.pad(INFO_STR),
+ Level::WARN => f.pad(WARN_STR),
+ Level::ERROR => f.pad(ERROR_STR),
+ }
+ }
+ }
+}
+
+// === impl FieldFn ===
+
+impl<'a, F> MakeVisitor<Writer<'a>> for FieldFn<F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result + Clone,
+{
+ type Visitor = FieldFnVisitor<'a, F>;
+
+ fn make_visitor(&self, writer: Writer<'a>) -> Self::Visitor {
+ FieldFnVisitor {
+ writer,
+ f: self.0.clone(),
+ result: Ok(()),
+ }
+ }
+}
+
+impl<'a, F> Visit for FieldFnVisitor<'a, F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result,
+{
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ if self.result.is_ok() {
+ self.result = (self.f)(&mut self.writer, field, value)
+ }
+ }
+}
+
+impl<'a, F> VisitOutput<fmt::Result> for FieldFnVisitor<'a, F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result,
+{
+ fn finish(self) -> fmt::Result {
+ self.result
+ }
+}
+
+impl<'a, F> VisitFmt for FieldFnVisitor<'a, F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result,
+{
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ &mut self.writer
+ }
+}
+
+impl<'a, F> fmt::Debug for FieldFnVisitor<'a, F> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FieldFnVisitor")
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .field("writer", &self.writer)
+ .field("result", &self.result)
+ .finish()
+ }
+}
+
+// === printing synthetic Span events ===
+
+/// Configures what points in the span lifecycle are logged as events.
+///
+/// See also [`with_span_events`](super::SubscriberBuilder.html::with_span_events).
+#[derive(Clone, Eq, PartialEq, Ord, PartialOrd)]
+pub struct FmtSpan(u8);
+
+impl FmtSpan {
+ /// one event when span is created
+ pub const NEW: FmtSpan = FmtSpan(1 << 0);
+ /// one event per enter of a span
+ pub const ENTER: FmtSpan = FmtSpan(1 << 1);
+ /// one event per exit of a span
+ pub const EXIT: FmtSpan = FmtSpan(1 << 2);
+ /// one event when the span is dropped
+ pub const CLOSE: FmtSpan = FmtSpan(1 << 3);
+
+ /// spans are ignored (this is the default)
+ pub const NONE: FmtSpan = FmtSpan(0);
+ /// one event per enter/exit of a span
+ pub const ACTIVE: FmtSpan = FmtSpan(FmtSpan::ENTER.0 | FmtSpan::EXIT.0);
+ /// events at all points (new, enter, exit, drop)
+ pub const FULL: FmtSpan =
+ FmtSpan(FmtSpan::NEW.0 | FmtSpan::ENTER.0 | FmtSpan::EXIT.0 | FmtSpan::CLOSE.0);
+
+ /// Check whether or not a certain flag is set for this [`FmtSpan`]
+ fn contains(&self, other: FmtSpan) -> bool {
+ self.clone() & other.clone() == other
+ }
+}
+
+macro_rules! impl_fmt_span_bit_op {
+ ($trait:ident, $func:ident, $op:tt) => {
+ impl std::ops::$trait for FmtSpan {
+ type Output = FmtSpan;
+
+ fn $func(self, rhs: Self) -> Self::Output {
+ FmtSpan(self.0 $op rhs.0)
+ }
+ }
+ };
+}
+
+macro_rules! impl_fmt_span_bit_assign_op {
+ ($trait:ident, $func:ident, $op:tt) => {
+ impl std::ops::$trait for FmtSpan {
+ fn $func(&mut self, rhs: Self) {
+ *self = FmtSpan(self.0 $op rhs.0)
+ }
+ }
+ };
+}
+
+impl_fmt_span_bit_op!(BitAnd, bitand, &);
+impl_fmt_span_bit_op!(BitOr, bitor, |);
+impl_fmt_span_bit_op!(BitXor, bitxor, ^);
+
+impl_fmt_span_bit_assign_op!(BitAndAssign, bitand_assign, &);
+impl_fmt_span_bit_assign_op!(BitOrAssign, bitor_assign, |);
+impl_fmt_span_bit_assign_op!(BitXorAssign, bitxor_assign, ^);
+
+impl Debug for FmtSpan {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut wrote_flag = false;
+ let mut write_flags = |flag, flag_str| -> fmt::Result {
+ if self.contains(flag) {
+ if wrote_flag {
+ f.write_str(" | ")?;
+ }
+
+ f.write_str(flag_str)?;
+ wrote_flag = true;
+ }
+
+ Ok(())
+ };
+
+ if FmtSpan::NONE | self.clone() == FmtSpan::NONE {
+ f.write_str("FmtSpan::NONE")?;
+ } else {
+ write_flags(FmtSpan::NEW, "FmtSpan::NEW")?;
+ write_flags(FmtSpan::ENTER, "FmtSpan::ENTER")?;
+ write_flags(FmtSpan::EXIT, "FmtSpan::EXIT")?;
+ write_flags(FmtSpan::CLOSE, "FmtSpan::CLOSE")?;
+ }
+
+ Ok(())
+ }
+}
+
+pub(super) struct FmtSpanConfig {
+ pub(super) kind: FmtSpan,
+ pub(super) fmt_timing: bool,
+}
+
+impl FmtSpanConfig {
+ pub(super) fn without_time(self) -> Self {
+ Self {
+ kind: self.kind,
+ fmt_timing: false,
+ }
+ }
+ pub(super) fn with_kind(self, kind: FmtSpan) -> Self {
+ Self {
+ kind,
+ fmt_timing: self.fmt_timing,
+ }
+ }
+ pub(super) fn trace_new(&self) -> bool {
+ self.kind.contains(FmtSpan::NEW)
+ }
+ pub(super) fn trace_enter(&self) -> bool {
+ self.kind.contains(FmtSpan::ENTER)
+ }
+ pub(super) fn trace_exit(&self) -> bool {
+ self.kind.contains(FmtSpan::EXIT)
+ }
+ pub(super) fn trace_close(&self) -> bool {
+ self.kind.contains(FmtSpan::CLOSE)
+ }
+}
+
+impl Debug for FmtSpanConfig {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ self.kind.fmt(f)
+ }
+}
+
+impl Default for FmtSpanConfig {
+ fn default() -> Self {
+ Self {
+ kind: FmtSpan::NONE,
+ fmt_timing: true,
+ }
+ }
+}
+
+pub(super) struct TimingDisplay(pub(super) u64);
+impl Display for TimingDisplay {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut t = self.0 as f64;
+ for unit in ["ns", "µs", "ms", "s"].iter() {
+ if t < 10.0 {
+ return write!(f, "{:.2}{}", t, unit);
+ } else if t < 100.0 {
+ return write!(f, "{:.1}{}", t, unit);
+ } else if t < 1000.0 {
+ return write!(f, "{:.0}{}", t, unit);
+ }
+ t /= 1000.0;
+ }
+ write!(f, "{:.0}s", t * 1000.0)
+ }
+}
+
+#[cfg(test)]
+pub(super) mod test {
+ use crate::fmt::{test::MockMakeWriter, time::FormatTime};
+ use tracing::{
+ self,
+ dispatcher::{set_default, Dispatch},
+ subscriber::with_default,
+ };
+
+ use super::*;
+
+ use regex::Regex;
+ use std::{fmt, path::Path};
+
+ pub(crate) struct MockTime;
+ impl FormatTime for MockTime {
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ write!(w, "fake time")
+ }
+ }
+
+ #[test]
+ fn disable_everything() {
+ // This test reproduces https://github.com/tokio-rs/tracing/issues/1354
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .without_time()
+ .with_level(false)
+ .with_target(false)
+ .with_thread_ids(false)
+ .with_thread_names(false);
+ #[cfg(feature = "ansi")]
+ let subscriber = subscriber.with_ansi(false);
+ assert_info_hello(subscriber, make_writer, "hello\n")
+ }
+
+ fn test_ansi<T>(
+ is_ansi: bool,
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_ansi(is_ansi)
+ .with_timer(MockTime);
+ run_test(subscriber, make_writer, expected)
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ fn test_without_ansi<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder.with_writer(make_writer).with_timer(MockTime);
+ run_test(subscriber, make_writer, expected)
+ }
+
+ fn test_without_level<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ run_test(subscriber, make_writer, expected);
+ }
+
+ #[test]
+ fn with_line_number_and_file_name() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_file(true)
+ .with_line_number(true)
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+
+ let expected = Regex::new(&format!(
+ "^fake time tracing_subscriber::fmt::format::test: {}:[0-9]+: hello\n$",
+ current_path()
+ // if we're on Windows, the path might contain backslashes, which
+ // have to be escpaed before compiling the regex.
+ .replace('\\', "\\\\")
+ ))
+ .unwrap();
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ let res = make_writer.get_string();
+ assert!(expected.is_match(&res));
+ }
+
+ #[test]
+ fn with_line_number() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_line_number(true)
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+
+ let expected =
+ Regex::new("^fake time tracing_subscriber::fmt::format::test: [0-9]+: hello\n$")
+ .unwrap();
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ let res = make_writer.get_string();
+ assert!(expected.is_match(&res));
+ }
+
+ #[test]
+ fn with_filename() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_file(true)
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected = &format!(
+ "fake time tracing_subscriber::fmt::format::test: {}: hello\n",
+ current_path(),
+ );
+ assert_info_hello(subscriber, make_writer, expected);
+ }
+
+ #[test]
+ fn with_thread_ids() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_thread_ids(true)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected =
+ "fake time INFO ThreadId(NUMERIC) tracing_subscriber::fmt::format::test: hello\n";
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, expected);
+ }
+
+ #[test]
+ fn pretty_default() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .pretty()
+ .with_writer(make_writer.clone())
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected = format!(
+ r#" fake time INFO tracing_subscriber::fmt::format::test: hello
+ at {}:NUMERIC
+
+"#,
+ file!()
+ );
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, &expected)
+ }
+
+ fn assert_info_hello(subscriber: impl Into<Dispatch>, buf: MockMakeWriter, expected: &str) {
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ let result = buf.get_string();
+
+ assert_eq!(expected, result)
+ }
+
+ // When numeric characters are used they often form a non-deterministic value as they usually represent things like a thread id or line number.
+ // This assert method should be used when non-deterministic numeric characters are present.
+ fn assert_info_hello_ignore_numeric(
+ subscriber: impl Into<Dispatch>,
+ buf: MockMakeWriter,
+ expected: &str,
+ ) {
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+
+ let regex = Regex::new("[0-9]+").unwrap();
+ let result = buf.get_string();
+ let result_cleaned = regex.replace_all(&result, "NUMERIC");
+
+ assert_eq!(expected, result_cleaned)
+ }
+
+ fn test_overridden_parents<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", span = 1);
+ let span2 = tracing::info_span!(parent: &span1, "span2", span = 2);
+ tracing::info!(parent: &span2, "hello");
+ });
+ assert_eq!(expected, make_writer.get_string());
+ }
+
+ fn test_overridden_parents_in_scope<T>(
+ expected1: &str,
+ expected2: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", span = 1);
+ let span2 = tracing::info_span!(parent: &span1, "span2", span = 2);
+ let span3 = tracing::info_span!("span3", span = 3);
+ let _e3 = span3.enter();
+
+ tracing::info!("hello");
+ assert_eq!(expected1, make_writer.get_string().as_str());
+
+ tracing::info!(parent: &span2, "hello");
+ assert_eq!(expected2, make_writer.get_string().as_str());
+ });
+ }
+
+ fn run_test(subscriber: impl Into<Dispatch>, buf: MockMakeWriter, expected: &str) {
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ assert_eq!(expected, buf.get_string())
+ }
+
+ mod default {
+ use super::*;
+
+ #[test]
+ fn with_thread_ids() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_thread_ids(true)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected =
+ "fake time INFO ThreadId(NUMERIC) tracing_subscriber::fmt::format::test: hello\n";
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, expected);
+ }
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_true() {
+ let expected = "\u{1b}[2mfake time\u{1b}[0m \u{1b}[32m INFO\u{1b}[0m \u{1b}[2mtracing_subscriber::fmt::format::test\u{1b}[0m\u{1b}[2m:\u{1b}[0m hello\n";
+ test_ansi(true, expected, crate::fmt::Subscriber::builder());
+ }
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_false() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_ansi(false, expected, crate::fmt::Subscriber::builder());
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ #[test]
+ fn without_ansi() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_without_ansi(expected, crate::fmt::Subscriber::builder())
+ }
+
+ #[test]
+ fn without_level() {
+ let expected = "fake time tracing_subscriber::fmt::format::test: hello\n";
+ test_without_level(expected, crate::fmt::Subscriber::builder())
+ }
+
+ #[test]
+ fn overridden_parents() {
+ let expected = "fake time span1{span=1}:span2{span=2}: tracing_subscriber::fmt::format::test: hello\n";
+ test_overridden_parents(expected, crate::fmt::Subscriber::builder())
+ }
+
+ #[test]
+ fn overridden_parents_in_scope() {
+ test_overridden_parents_in_scope(
+ "fake time span3{span=3}: tracing_subscriber::fmt::format::test: hello\n",
+ "fake time span1{span=1}:span2{span=2}: tracing_subscriber::fmt::format::test: hello\n",
+ crate::fmt::Subscriber::builder(),
+ )
+ }
+ }
+
+ mod compact {
+ use super::*;
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_true() {
+ let expected = "\u{1b}[2mfake time\u{1b}[0m \u{1b}[32m INFO\u{1b}[0m \u{1b}[1mtracing_subscriber::fmt::format::test\u{1b}[0m\u{1b}[2m:\u{1b}[0m hello\n";
+ test_ansi(true, expected, crate::fmt::Subscriber::builder().compact())
+ }
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_false() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_ansi(false, expected, crate::fmt::Subscriber::builder().compact());
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ #[test]
+ fn without_ansi() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_without_ansi(expected, crate::fmt::Subscriber::builder().compact())
+ }
+
+ #[test]
+ fn without_level() {
+ let expected = "fake time tracing_subscriber::fmt::format::test: hello\n";
+ test_without_level(expected, crate::fmt::Subscriber::builder().compact());
+ }
+
+ #[test]
+ fn overridden_parents() {
+ let expected = "fake time span1:span2: tracing_subscriber::fmt::format::test: hello span=1 span=2\n";
+ test_overridden_parents(expected, crate::fmt::Subscriber::builder().compact())
+ }
+
+ #[test]
+ fn overridden_parents_in_scope() {
+ test_overridden_parents_in_scope(
+ "fake time span3: tracing_subscriber::fmt::format::test: hello span=3\n",
+ "fake time span1:span2: tracing_subscriber::fmt::format::test: hello span=1 span=2\n",
+ crate::fmt::Subscriber::builder().compact(),
+ )
+ }
+ }
+
+ mod pretty {
+ use super::*;
+
+ #[test]
+ fn pretty_default() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .pretty()
+ .with_writer(make_writer.clone())
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected = format!(
+ " fake time INFO tracing_subscriber::fmt::format::test: hello\n at {}:NUMERIC\n\n",
+ file!()
+ );
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, &expected)
+ }
+ }
+
+ #[test]
+ fn format_nanos() {
+ fn fmt(t: u64) -> String {
+ TimingDisplay(t).to_string()
+ }
+
+ assert_eq!(fmt(1), "1.00ns");
+ assert_eq!(fmt(12), "12.0ns");
+ assert_eq!(fmt(123), "123ns");
+ assert_eq!(fmt(1234), "1.23µs");
+ assert_eq!(fmt(12345), "12.3µs");
+ assert_eq!(fmt(123456), "123µs");
+ assert_eq!(fmt(1234567), "1.23ms");
+ assert_eq!(fmt(12345678), "12.3ms");
+ assert_eq!(fmt(123456789), "123ms");
+ assert_eq!(fmt(1234567890), "1.23s");
+ assert_eq!(fmt(12345678901), "12.3s");
+ assert_eq!(fmt(123456789012), "123s");
+ assert_eq!(fmt(1234567890123), "1235s");
+ }
+
+ #[test]
+ fn fmt_span_combinations() {
+ let f = FmtSpan::NONE;
+ assert!(!f.contains(FmtSpan::NEW));
+ assert!(!f.contains(FmtSpan::ENTER));
+ assert!(!f.contains(FmtSpan::EXIT));
+ assert!(!f.contains(FmtSpan::CLOSE));
+
+ let f = FmtSpan::ACTIVE;
+ assert!(!f.contains(FmtSpan::NEW));
+ assert!(f.contains(FmtSpan::ENTER));
+ assert!(f.contains(FmtSpan::EXIT));
+ assert!(!f.contains(FmtSpan::CLOSE));
+
+ let f = FmtSpan::FULL;
+ assert!(f.contains(FmtSpan::NEW));
+ assert!(f.contains(FmtSpan::ENTER));
+ assert!(f.contains(FmtSpan::EXIT));
+ assert!(f.contains(FmtSpan::CLOSE));
+
+ let f = FmtSpan::NEW | FmtSpan::CLOSE;
+ assert!(f.contains(FmtSpan::NEW));
+ assert!(!f.contains(FmtSpan::ENTER));
+ assert!(!f.contains(FmtSpan::EXIT));
+ assert!(f.contains(FmtSpan::CLOSE));
+ }
+
+ /// Returns the test's module path.
+ fn current_path() -> String {
+ Path::new("tracing-subscriber")
+ .join("src")
+ .join("fmt")
+ .join("format")
+ .join("mod.rs")
+ .to_str()
+ .expect("path must not contain invalid unicode")
+ .to_owned()
+ }
+}
diff --git a/vendor/tracing-subscriber/src/fmt/format/pretty.rs b/vendor/tracing-subscriber/src/fmt/format/pretty.rs
new file mode 100644
index 000000000..a50d08ba7
--- /dev/null
+++ b/vendor/tracing-subscriber/src/fmt/format/pretty.rs
@@ -0,0 +1,511 @@
+use super::*;
+use crate::{
+ field::{VisitFmt, VisitOutput},
+ fmt::fmt_layer::{FmtContext, FormattedFields},
+ registry::LookupSpan,
+};
+
+use std::fmt;
+use tracing_core::{
+ field::{self, Field},
+ Event, Level, Subscriber,
+};
+
+#[cfg(feature = "tracing-log")]
+use tracing_log::NormalizeEvent;
+
+use ansi_term::{Colour, Style};
+
+/// An excessively pretty, human-readable event formatter.
+///
+/// Unlike the [`Full`], [`Compact`], and [`Json`] formatters, this is a
+/// multi-line output format. Each individual event may output multiple lines of
+/// text.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt-pretty
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt-pretty`
+/// 2022-02-15T18:44:24.535324Z <font color="#4E9A06"> INFO</font> <font color="#4E9A06"><b>fmt_pretty</b></font><font color="#4E9A06">: preparing to shave yaks, </font><font color="#4E9A06"><b>number_of_yaks</b></font><font color="#4E9A06">: 3</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt-pretty.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+///
+/// 2022-02-15T18:44:24.535403Z <font color="#4E9A06"> INFO</font> <font color="#4E9A06"><b>fmt_pretty::yak_shave</b></font><font color="#4E9A06">: shaving yaks</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:41 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535442Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: hello! I&apos;m gonna shave a yak, </font><font color="#75507B"><b>excitement</b></font><font color="#75507B">: &quot;yay!&quot;</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 1
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535469Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: yak shaved successfully</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:25 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 1
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535502Z <font color="#3465A4">DEBUG</font> <font color="#3465A4"><b>yak_events</b></font><font color="#3465A4">: </font><font color="#3465A4"><b>yak</b></font><font color="#3465A4">: 1, </font><font color="#3465A4"><b>shaved</b></font><font color="#3465A4">: true</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:46 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535524Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: </font><font color="#75507B"><b>yaks_shaved</b></font><font color="#75507B">: 1</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:55 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535551Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: hello! I&apos;m gonna shave a yak, </font><font color="#75507B"><b>excitement</b></font><font color="#75507B">: &quot;yay!&quot;</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 2
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535573Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: yak shaved successfully</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:25 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 2
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535600Z <font color="#3465A4">DEBUG</font> <font color="#3465A4"><b>yak_events</b></font><font color="#3465A4">: </font><font color="#3465A4"><b>yak</b></font><font color="#3465A4">: 2, </font><font color="#3465A4"><b>shaved</b></font><font color="#3465A4">: true</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:46 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535618Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: </font><font color="#75507B"><b>yaks_shaved</b></font><font color="#75507B">: 2</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:55 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535644Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: hello! I&apos;m gonna shave a yak, </font><font color="#75507B"><b>excitement</b></font><font color="#75507B">: &quot;yay!&quot;</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 3
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535670Z <font color="#C4A000"> WARN</font> <font color="#C4A000"><b>fmt_pretty::yak_shave</b></font><font color="#C4A000">: could not locate yak</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:18 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 3
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535698Z <font color="#3465A4">DEBUG</font> <font color="#3465A4"><b>yak_events</b></font><font color="#3465A4">: </font><font color="#3465A4"><b>yak</b></font><font color="#3465A4">: 3, </font><font color="#3465A4"><b>shaved</b></font><font color="#3465A4">: false</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:46 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535720Z <font color="#CC0000">ERROR</font> <font color="#CC0000"><b>fmt_pretty::yak_shave</b></font><font color="#CC0000">: failed to shave yak, </font><font color="#CC0000"><b>yak</b></font><font color="#CC0000">: 3, </font><font color="#CC0000"><b>error</b></font><font color="#CC0000">: missing yak, </font><font color="#CC0000"><b>error.sources</b></font><font color="#CC0000">: [out of space, out of cash]</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:51 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535742Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: </font><font color="#75507B"><b>yaks_shaved</b></font><font color="#75507B">: 2</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:55 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535765Z <font color="#4E9A06"> INFO</font> <font color="#4E9A06"><b>fmt_pretty</b></font><font color="#4E9A06">: yak shaving completed, </font><font color="#4E9A06"><b>all_yaks_shaved</b></font><font color="#4E9A06">: false</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt-pretty.rs:19 <font color="#AAAAAA"><i>on</i></font> main
+/// </pre>
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub struct Pretty {
+ display_location: bool,
+}
+
+/// The [visitor] produced by [`Pretty`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: field::Visit
+/// [`MakeVisitor`]: crate::field::MakeVisitor
+#[derive(Debug)]
+pub struct PrettyVisitor<'a> {
+ writer: Writer<'a>,
+ is_empty: bool,
+ style: Style,
+ result: fmt::Result,
+}
+
+/// An excessively pretty, human-readable [`MakeVisitor`] implementation.
+///
+/// [`MakeVisitor`]: crate::field::MakeVisitor
+#[derive(Debug)]
+pub struct PrettyFields {
+ /// A value to override the provided `Writer`'s ANSI formatting
+ /// configuration.
+ ///
+ /// If this is `Some`, we override the `Writer`'s ANSI setting. This is
+ /// necessary in order to continue supporting the deprecated
+ /// `PrettyFields::with_ansi` method. If it is `None`, we don't override the
+ /// ANSI formatting configuration (because the deprecated method was not
+ /// called).
+ // TODO: when `PrettyFields::with_ansi` is removed, we can get rid
+ // of this entirely.
+ ansi: Option<bool>,
+}
+
+// === impl Pretty ===
+
+impl Default for Pretty {
+ fn default() -> Self {
+ Self {
+ display_location: true,
+ }
+ }
+}
+
+impl Pretty {
+ fn style_for(level: &Level) -> Style {
+ match *level {
+ Level::TRACE => Style::new().fg(Colour::Purple),
+ Level::DEBUG => Style::new().fg(Colour::Blue),
+ Level::INFO => Style::new().fg(Colour::Green),
+ Level::WARN => Style::new().fg(Colour::Yellow),
+ Level::ERROR => Style::new().fg(Colour::Red),
+ }
+ }
+
+ /// Sets whether the event's source code location is displayed.
+ ///
+ /// This defaults to `true`.
+ #[deprecated(
+ since = "0.3.6",
+ note = "all formatters now support configurable source locations. Use `Format::with_source_location` instead."
+ )]
+ pub fn with_source_location(self, display_location: bool) -> Self {
+ Self {
+ display_location,
+ ..self
+ }
+ }
+}
+
+impl<C, N, T> FormatEvent<C, N> for Format<Pretty, T>
+where
+ C: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, C, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+ write!(&mut writer, " ")?;
+
+ // if the `Format` struct *also* has an ANSI color configuration,
+ // override the writer...the API for configuring ANSI color codes on the
+ // `Format` struct is deprecated, but we still need to honor those
+ // configurations.
+ if let Some(ansi) = self.ansi {
+ writer = writer.with_ansi(ansi);
+ }
+
+ self.format_timestamp(&mut writer)?;
+
+ let style = if self.display_level && writer.has_ansi_escapes() {
+ Pretty::style_for(meta.level())
+ } else {
+ Style::new()
+ };
+
+ if self.display_level {
+ write!(
+ writer,
+ "{} ",
+ super::FmtLevel::new(meta.level(), writer.has_ansi_escapes())
+ )?;
+ }
+
+ if self.display_target {
+ let target_style = if writer.has_ansi_escapes() {
+ style.bold()
+ } else {
+ style
+ };
+ write!(
+ writer,
+ "{}{}{}:",
+ target_style.prefix(),
+ meta.target(),
+ target_style.infix(style)
+ )?;
+ }
+ let line_number = if self.display_line_number {
+ meta.line()
+ } else {
+ None
+ };
+
+ // If the file name is disabled, format the line number right after the
+ // target. Otherwise, if we also display the file, it'll go on a
+ // separate line.
+ if let (Some(line_number), false, true) = (
+ line_number,
+ self.display_filename,
+ self.format.display_location,
+ ) {
+ write!(
+ writer,
+ "{}{}{}:",
+ style.prefix(),
+ line_number,
+ style.infix(style)
+ )?;
+ }
+
+ writer.write_char(' ')?;
+
+ let mut v = PrettyVisitor::new(writer.by_ref(), true).with_style(style);
+ event.record(&mut v);
+ v.finish()?;
+ writer.write_char('\n')?;
+
+ let dimmed = if writer.has_ansi_escapes() {
+ Style::new().dimmed().italic()
+ } else {
+ Style::new()
+ };
+ let thread = self.display_thread_name || self.display_thread_id;
+
+ if let (Some(file), true, true) = (
+ meta.file(),
+ self.format.display_location,
+ self.display_filename,
+ ) {
+ write!(writer, " {} {}", dimmed.paint("at"), file,)?;
+
+ if let Some(line) = line_number {
+ write!(writer, ":{}", line)?;
+ }
+ writer.write_char(if thread { ' ' } else { '\n' })?;
+ } else if thread {
+ write!(writer, " ")?;
+ };
+
+ if thread {
+ write!(writer, "{} ", dimmed.paint("on"))?;
+ let thread = std::thread::current();
+ if self.display_thread_name {
+ if let Some(name) = thread.name() {
+ write!(writer, "{}", name)?;
+ if self.display_thread_id {
+ writer.write_char(' ')?;
+ }
+ }
+ }
+ if self.display_thread_id {
+ write!(writer, "{:?}", thread.id())?;
+ }
+ writer.write_char('\n')?;
+ }
+
+ let bold = writer.bold();
+ let span = event
+ .parent()
+ .and_then(|id| ctx.span(id))
+ .or_else(|| ctx.lookup_current());
+
+ let scope = span.into_iter().flat_map(|span| span.scope());
+
+ for span in scope {
+ let meta = span.metadata();
+ if self.display_target {
+ write!(
+ writer,
+ " {} {}::{}",
+ dimmed.paint("in"),
+ meta.target(),
+ bold.paint(meta.name()),
+ )?;
+ } else {
+ write!(
+ writer,
+ " {} {}",
+ dimmed.paint("in"),
+ bold.paint(meta.name()),
+ )?;
+ }
+
+ let ext = span.extensions();
+ let fields = &ext
+ .get::<FormattedFields<N>>()
+ .expect("Unable to find FormattedFields in extensions; this is a bug");
+ if !fields.is_empty() {
+ write!(writer, " {} {}", dimmed.paint("with"), fields)?;
+ }
+ writer.write_char('\n')?;
+ }
+
+ writer.write_char('\n')
+ }
+}
+
+impl<'writer> FormatFields<'writer> for Pretty {
+ fn format_fields<R: RecordFields>(&self, writer: Writer<'writer>, fields: R) -> fmt::Result {
+ let mut v = PrettyVisitor::new(writer, true);
+ fields.record(&mut v);
+ v.finish()
+ }
+
+ fn add_fields(
+ &self,
+ current: &'writer mut FormattedFields<Self>,
+ fields: &span::Record<'_>,
+ ) -> fmt::Result {
+ let empty = current.is_empty();
+ let writer = current.as_writer();
+ let mut v = PrettyVisitor::new(writer, empty);
+ fields.record(&mut v);
+ v.finish()
+ }
+}
+
+// === impl PrettyFields ===
+
+impl Default for PrettyFields {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl PrettyFields {
+ /// Returns a new default [`PrettyFields`] implementation.
+ pub fn new() -> Self {
+ // By default, don't override the `Writer`'s ANSI colors
+ // configuration. We'll only do this if the user calls the
+ // deprecated `PrettyFields::with_ansi` method.
+ Self { ansi: None }
+ }
+
+ /// Enable ANSI encoding for formatted fields.
+ #[deprecated(
+ since = "0.3.3",
+ note = "Use `fmt::Subscriber::with_ansi` or `fmt::Layer::with_ansi` instead."
+ )]
+ pub fn with_ansi(self, ansi: bool) -> Self {
+ Self {
+ ansi: Some(ansi),
+ ..self
+ }
+ }
+}
+
+impl<'a> MakeVisitor<Writer<'a>> for PrettyFields {
+ type Visitor = PrettyVisitor<'a>;
+
+ #[inline]
+ fn make_visitor(&self, mut target: Writer<'a>) -> Self::Visitor {
+ if let Some(ansi) = self.ansi {
+ target = target.with_ansi(ansi);
+ }
+ PrettyVisitor::new(target, true)
+ }
+}
+
+// === impl PrettyVisitor ===
+
+impl<'a> PrettyVisitor<'a> {
+ /// Returns a new default visitor that formats to the provided `writer`.
+ ///
+ /// # Arguments
+ /// - `writer`: the writer to format to.
+ /// - `is_empty`: whether or not any fields have been previously written to
+ /// that writer.
+ pub fn new(writer: Writer<'a>, is_empty: bool) -> Self {
+ Self {
+ writer,
+ is_empty,
+ style: Style::default(),
+ result: Ok(()),
+ }
+ }
+
+ pub(crate) fn with_style(self, style: Style) -> Self {
+ Self { style, ..self }
+ }
+
+ fn write_padded(&mut self, value: &impl fmt::Debug) {
+ let padding = if self.is_empty {
+ self.is_empty = false;
+ ""
+ } else {
+ ", "
+ };
+ self.result = write!(self.writer, "{}{:?}", padding, value);
+ }
+
+ fn bold(&self) -> Style {
+ if self.writer.has_ansi_escapes() {
+ self.style.bold()
+ } else {
+ Style::new()
+ }
+ }
+}
+
+impl<'a> field::Visit for PrettyVisitor<'a> {
+ fn record_str(&mut self, field: &Field, value: &str) {
+ if self.result.is_err() {
+ return;
+ }
+
+ if field.name() == "message" {
+ self.record_debug(field, &format_args!("{}", value))
+ } else {
+ self.record_debug(field, &value)
+ }
+ }
+
+ fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
+ if let Some(source) = value.source() {
+ let bold = self.bold();
+ self.record_debug(
+ field,
+ &format_args!(
+ "{}, {}{}.sources{}: {}",
+ value,
+ bold.prefix(),
+ field,
+ bold.infix(self.style),
+ ErrorSourceList(source),
+ ),
+ )
+ } else {
+ self.record_debug(field, &format_args!("{}", value))
+ }
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ if self.result.is_err() {
+ return;
+ }
+ let bold = self.bold();
+ match field.name() {
+ "message" => self.write_padded(&format_args!("{}{:?}", self.style.prefix(), value,)),
+ // Skip fields that are actually log metadata that have already been handled
+ #[cfg(feature = "tracing-log")]
+ name if name.starts_with("log.") => self.result = Ok(()),
+ name if name.starts_with("r#") => self.write_padded(&format_args!(
+ "{}{}{}: {:?}",
+ bold.prefix(),
+ &name[2..],
+ bold.infix(self.style),
+ value
+ )),
+ name => self.write_padded(&format_args!(
+ "{}{}{}: {:?}",
+ bold.prefix(),
+ name,
+ bold.infix(self.style),
+ value
+ )),
+ };
+ }
+}
+
+impl<'a> VisitOutput<fmt::Result> for PrettyVisitor<'a> {
+ fn finish(mut self) -> fmt::Result {
+ write!(&mut self.writer, "{}", self.style.suffix())?;
+ self.result
+ }
+}
+
+impl<'a> VisitFmt for PrettyVisitor<'a> {
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ &mut self.writer
+ }
+}