Skip to content

Commit

Permalink
subscriber: support NO_COLOR in fmt::Layer (#2647)
Browse files Browse the repository at this point in the history
It's necessary at times to be able to disable ANSI color output for
rust utilities using `tracing`.  The informal standard for this is the
`NO_COLOR` environment variable described here: https://no-color.org/

Further details/discussion in #2388

This commit updates `fmt::Layer` to check the `NO_COLOR`
environment variable when determining whether ANSI color output is
enabled by default. As described in the spec, any non-empty value set
for `NO_COLOR` will cause ANSI color support to be disabled by default.

If the user manually overrides ANSI color support, such as by calling
`with_ansi(true)`, this will still enable ANSI colors, even if
`NO_COLOR` is set. The `NO_COLOR` env var only effects the default
behavior.

Fixes #2388
  • Loading branch information
dmlary authored and davidbarsky committed Sep 27, 2023
1 parent 161c9cc commit 8372ba3
Showing 1 changed file with 102 additions and 6 deletions.
108 changes: 102 additions & 6 deletions tracing-subscriber/src/fmt/fmt_layer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ use crate::{
registry::{self, LookupSpan, SpanRef},
};
use format::{FmtSpan, TimingDisplay};
use std::{any::TypeId, cell::RefCell, fmt, io, marker::PhantomData, ops::Deref, time::Instant};
use std::{
any::TypeId, cell::RefCell, env, fmt, io, marker::PhantomData, ops::Deref, time::Instant,
};
use tracing_core::{
field,
span::{Attributes, Current, Id, Record},
Expand Down Expand Up @@ -276,6 +278,15 @@ impl<S, N, E, W> Layer<S, N, E, W> {
/// Sets whether or not the formatter emits ANSI terminal escape codes
/// for colors and other text formatting.
///
/// When the "ansi" crate feature flag is enabled, ANSI colors are enabled
/// by default unless the [`NO_COLOR`] environment variable is set to
/// a non-empty value. If the [`NO_COLOR`] environment variable is set to
/// any non-empty value, then ANSI colors will be suppressed by default.
/// The [`with_ansi`] and [`set_ansi`] methods can be used to forcibly
/// enable ANSI colors, overriding any [`NO_COLOR`] environment variable.
///
/// [`NO_COLOR`]: https://no-color.org/
///
/// Enabling ANSI escapes (calling `with_ansi(true)`) requires the "ansi"
/// crate feature flag. Calling `with_ansi(true)` without the "ansi"
/// feature flag enabled will panic if debug assertions are enabled, or
Expand All @@ -288,6 +299,9 @@ impl<S, N, E, W> Layer<S, N, E, W> {
/// ANSI escape codes can ensure that they are not used, regardless of
/// whether or not other crates in the dependency graph enable the "ansi"
/// feature flag.
///
/// [`with_ansi`]: Subscriber::with_ansi
/// [`set_ansi`]: Subscriber::set_ansi
pub fn with_ansi(self, ansi: bool) -> Self {
#[cfg(not(feature = "ansi"))]
if ansi {
Expand All @@ -311,10 +325,10 @@ impl<S, N, E, W> Layer<S, N, E, W> {
/// By default, `fmt::Layer` will write any `FormatEvent`-internal errors to
/// the writer. These errors are unlikely and will only occur if there is a
/// bug in the `FormatEvent` implementation or its dependencies.
///
///
/// If writing to the writer fails, the error message is printed to stderr
/// as a fallback.
///
///
/// [`FormatEvent`]: crate::fmt::FormatEvent
pub fn log_internal_errors(self, log_internal_errors: bool) -> Self {
Self {
Expand Down Expand Up @@ -677,12 +691,16 @@ impl<S, N, E, W> Layer<S, N, E, W> {

impl<S> Default for Layer<S> {
fn default() -> Self {
// only enable ANSI when the feature is enabled, and the NO_COLOR
// environment variable is unset or empty.
let ansi = cfg!(feature = "ansi") && env::var("NO_COLOR").map_or(true, |v| v.is_empty());

Layer {
fmt_fields: format::DefaultFields::default(),
fmt_event: format::Format::default(),
fmt_span: format::FmtSpanConfig::default(),
make_writer: io::stdout,
is_ansi: cfg!(feature = "ansi"),
is_ansi: ansi,
log_internal_errors: false,
_inner: PhantomData,
}
Expand Down Expand Up @@ -1288,8 +1306,17 @@ mod test {
let actual = sanitize_timings(make_writer.get_string());

// Only assert the start because the line number and callsite may change.
let expected = concat!("Unable to format the following event. Name: event ", file!(), ":");
assert!(actual.as_str().starts_with(expected), "\nactual = {}\nshould start with expected = {}\n", actual, expected);
let expected = concat!(
"Unable to format the following event. Name: event ",
file!(),
":"
);
assert!(
actual.as_str().starts_with(expected),
"\nactual = {}\nshould start with expected = {}\n",
actual,
expected
);
}

#[test]
Expand Down Expand Up @@ -1491,4 +1518,73 @@ mod test {
actual.as_str()
);
}

// Because we need to modify an environment variable for these test cases,
// we do them all in a single test.
#[cfg(feature = "ansi")]
#[test]
fn layer_no_color() {
const NO_COLOR: &str = "NO_COLOR";

// Restores the previous value of the `NO_COLOR` env variable when
// dropped.
//
// This is done in a `Drop` implementation, rather than just resetting
// the value at the end of the test, so that the previous value is
// restored even if the test panics.
struct RestoreEnvVar(Result<String, env::VarError>);
impl Drop for RestoreEnvVar {
fn drop(&mut self) {
match self.0 {
Ok(ref var) => env::set_var(NO_COLOR, var),
Err(_) => env::remove_var(NO_COLOR),
}
}
}

let _saved_no_color = RestoreEnvVar(env::var(NO_COLOR));

let cases: Vec<(Option<&str>, bool)> = vec![
(Some("0"), false), // any non-empty value disables ansi
(Some("off"), false), // any non-empty value disables ansi
(Some("1"), false),
(Some(""), true), // empty value does not disable ansi
(None, true),
];

for (var, ansi) in cases {
if let Some(value) = var {
env::set_var(NO_COLOR, value);
} else {
env::remove_var(NO_COLOR);
}

let layer: Layer<()> = fmt::Layer::default();
assert_eq!(
layer.is_ansi, ansi,
"NO_COLOR={:?}; Subscriber::default().is_ansi should be {}",
var, ansi
);

// with_ansi should override any `NO_COLOR` value
let layer: Layer<()> = fmt::Layer::default().with_ansi(true);
assert!(
layer.is_ansi,
"NO_COLOR={:?}; Subscriber::default().with_ansi(true).is_ansi should be true",
var
);

// set_ansi should override any `NO_COLOR` value
let mut layer: Layer<()> = fmt::Layer::default();
layer.set_ansi(true);
assert!(
layer.is_ansi,
"NO_COLOR={:?}; layer.set_ansi(true); layer.is_ansi should be true",
var
);
}

// dropping `_saved_no_color` will restore the previous value of
// `NO_COLOR`.
}
}

0 comments on commit 8372ba3

Please sign in to comment.