mirror of
https://github.com/neondatabase/neon.git
synced 2026-05-21 15:10:44 +00:00
7216f22609
Whenever we start processing a request, we now enter a tracing "span" that includes context information like the tenant and timeline ID, and the operation we're performing. That context information gets attached to every log message we create within the span. That way, we don't need to include basic context information like that in every log message, and it also becomes easier to filter the logs programmatically. This removes the eplicit timeline and tenant IDs from most log messages, as you get that information from the enclosing span now. Also improve log messages in general, dialing down the level of some messages that are not very useful, and adding information to others. We now obey the RUST_LOG env variable, if it's set. The 'tracing' crate allows for different log formatters, like JSON or bunyan output. The one we use now is human-readable multi-line format, which is nice when reading the log directly, but hard for post-processing. For production, we'll probably want JSON output and some tools for working with it, but that's left as a TODO. The log format is easy to change.
57 lines
2.1 KiB
Rust
57 lines
2.1 KiB
Rust
use std::{
|
|
fs::{File, OpenOptions},
|
|
path::Path,
|
|
};
|
|
|
|
use anyhow::{Context, Result};
|
|
|
|
use tracing::subscriber::set_global_default;
|
|
use tracing_log::LogTracer;
|
|
use tracing_subscriber::fmt;
|
|
use tracing_subscriber::{layer::SubscriberExt, EnvFilter, Registry};
|
|
|
|
pub fn init(log_filename: impl AsRef<Path>, daemonize: bool) -> Result<File> {
|
|
// Don't open the same file for output multiple times;
|
|
// the different fds could overwrite each other's output.
|
|
let log_file = OpenOptions::new()
|
|
.create(true)
|
|
.append(true)
|
|
.open(&log_filename)
|
|
.with_context(|| format!("failed to open {:?}", log_filename.as_ref()))?;
|
|
|
|
let default_filter_str = "info";
|
|
|
|
// We fall back to printing all spans at info-level or above if
|
|
// the RUST_LOG environment variable is not set.
|
|
let env_filter =
|
|
EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new(default_filter_str));
|
|
|
|
// we are cloning and returning log file in order to allow redirecting daemonized stdout and stderr to it
|
|
// if we do not use daemonization (e.g. in docker) it is better to log to stdout directly
|
|
// for example to be in line with docker log command which expects logs comimg from stdout
|
|
//
|
|
// TODO: perhaps use a more human-readable format when !daemonize
|
|
if daemonize {
|
|
let x = log_file.try_clone().unwrap();
|
|
|
|
let fmt_layer = fmt::layer()
|
|
.pretty()
|
|
.with_target(false) // don't include event targets
|
|
.with_ansi(false) // don't use colors in log file
|
|
.with_writer(move || x.try_clone().unwrap());
|
|
let subscriber = Registry::default().with(env_filter).with(fmt_layer);
|
|
|
|
set_global_default(subscriber).expect("Failed to set subscriber");
|
|
} else {
|
|
let fmt_layer = fmt::layer().with_target(false); // don't include event targets
|
|
let subscriber = Registry::default().with(env_filter).with(fmt_layer);
|
|
|
|
set_global_default(subscriber).expect("Failed to set subscriber");
|
|
}
|
|
|
|
// Redirect all `log`'s events to our subscriber
|
|
LogTracer::init().expect("Failed to set logger");
|
|
|
|
Ok(log_file)
|
|
}
|