Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tracing: simplify subscriber construction with Boxed layers #1304

Merged
merged 1 commit into from
Oct 8, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 27 additions & 22 deletions linkerd/tracing/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,8 @@ mod uptime;
use self::uptime::Uptime;
use linkerd_error::Error;
use std::{env, str};
use tracing::Dispatch;
use tracing_subscriber::{fmt::format, layer::Layered, prelude::*, reload, EnvFilter};

type Registry =
Layered<reload::Layer<EnvFilter, tracing_subscriber::Registry>, tracing_subscriber::Registry>;
use tracing::{Dispatch, Subscriber};
use tracing_subscriber::{fmt::format, prelude::*, registry::LookupSpan, reload, EnvFilter, Layer};

const ENV_LOG_LEVEL: &str = "LINKERD2_PROXY_LOG";
const ENV_LOG_FORMAT: &str = "LINKERD2_PROXY_LOG_FORMAT";
Expand Down Expand Up @@ -94,14 +91,11 @@ impl Settings {
.to_uppercase()
}

fn mk_registry(&self) -> (Registry, level::Handle) {
let log_level = self.filter.as_deref().unwrap_or(DEFAULT_LOG_LEVEL);
let (filter, level) = reload::Layer::new(EnvFilter::new(log_level));
let reg = tracing_subscriber::registry().with(filter);
(reg, level::Handle::new(level))
}

fn mk_json(&self, registry: Registry) -> Dispatch {
fn mk_json<S>(&self) -> Box<dyn Layer<S> + Send + Sync + 'static>
where
S: Subscriber + for<'span> LookupSpan<'span>,
S: Send + Sync,
{
let fmt = tracing_subscriber::fmt::format()
.with_timer(Uptime::starting_now())
.with_thread_ids(!self.is_test)
Expand All @@ -121,32 +115,43 @@ impl Settings {
.fmt_fields(format::JsonFields::default());

if self.is_test {
registry.with(fmt.with_test_writer()).into()
Box::new(fmt.with_test_writer())
} else {
registry.with(fmt).into()
Box::new(fmt)
}
}

fn mk_plain(&self, registry: Registry) -> Dispatch {
fn mk_plain<S>(&self) -> Box<dyn Layer<S> + Send + Sync + 'static>
where
S: Subscriber + for<'span> LookupSpan<'span>,
S: Send + Sync,
{
let fmt = tracing_subscriber::fmt::format()
.with_timer(Uptime::starting_now())
.with_thread_ids(!self.is_test);
let fmt = tracing_subscriber::fmt::layer().event_format(fmt);
if self.is_test {
registry.with(fmt.with_test_writer()).into()
Box::new(fmt.with_test_writer())
} else {
registry.with(fmt).into()
Box::new(fmt)
}
}

pub fn build(self) -> (Dispatch, Handle) {
let (registry, level) = self.mk_registry();
let log_level = self.filter.as_deref().unwrap_or(DEFAULT_LOG_LEVEL);
let (filter, level) = reload::Layer::new(EnvFilter::new(log_level));
let level = level::Handle::new(level);

let dispatch = match self.format().as_ref() {
"JSON" => self.mk_json(registry),
_ => self.mk_plain(registry),
let logger = match self.format().as_ref() {
"JSON" => self.mk_json(),
_ => self.mk_plain(),
};

let dispatch = tracing_subscriber::registry()
.with(filter)
.with(logger)
.into();

(dispatch, Handle(Some(level)))
}
}
Expand Down