-
Notifications
You must be signed in to change notification settings - Fork 212
/
logger.rs
152 lines (129 loc) Β· 5.25 KB
/
logger.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
use opentelemetry::{
global,
sdk::{
propagation::TraceContextPropagator,
trace::{Config, Tracer},
Resource,
},
KeyValue,
};
use opentelemetry_otlp::WithExportConfig;
use query_core::is_user_facing_trace_filter;
use query_engine_metrics::MetricRegistry;
use tracing::{dispatcher::SetGlobalDefaultError, subscriber};
use tracing_subscriber::{filter::filter_fn, layer::SubscriberExt, EnvFilter, Layer};
use crate::LogFormat;
type LoggerResult<T> = Result<T, SetGlobalDefaultError>;
/// An installer for a global logger.
#[derive(Debug, Clone)]
pub struct Logger<'a> {
service_name: &'static str,
log_format: LogFormat,
enable_telemetry: bool,
log_queries: bool,
telemetry_endpoint: Option<&'a str>,
metrics: Option<MetricRegistry>,
}
impl<'a> Logger<'a> {
/// Initialize a new global logger installer.
pub fn new(service_name: &'static str) -> Self {
Self {
service_name,
log_format: LogFormat::Json,
enable_telemetry: false,
log_queries: false,
telemetry_endpoint: None,
metrics: None,
}
}
/// Sets the STDOUT log output format. Default: Json.
pub fn log_format(&mut self, log_format: LogFormat) {
self.log_format = log_format;
}
/// Enable query logging. Default: false.
pub fn log_queries(&mut self, log_queries: bool) {
self.log_queries = log_queries;
}
/// Enables Jaeger telemetry.
pub fn enable_telemetry(&mut self, enable_telemetry: bool) {
self.enable_telemetry = enable_telemetry;
}
/// Sets a custom telemetry endpoint
pub fn telemetry_endpoint(&mut self, endpoint: &'a str) {
if endpoint.is_empty() {
self.telemetry_endpoint = None
} else {
self.telemetry_endpoint = Some(endpoint);
}
}
pub fn enable_metrics(&mut self, metrics: MetricRegistry) {
self.metrics = Some(metrics);
}
/// Install logger as a global. Can be called only once per application
/// instance. The returned guard value needs to stay in scope for the whole
/// lifetime of the service.
pub fn install(self) -> LoggerResult<()> {
let filter = create_env_filter(self.log_queries);
let is_user_trace = filter_fn(is_user_facing_trace_filter);
let telemetry = if self.enable_telemetry {
let tracer = create_otel_tracer(self.service_name, self.telemetry_endpoint);
let telemetry = tracing_opentelemetry::layer().with_tracer(tracer);
let telemetry = telemetry.with_filter(is_user_trace);
Some(telemetry)
} else {
None
};
let fmt_layer = match self.log_format {
LogFormat::Text => {
let fmt_layer = tracing_subscriber::fmt::layer().with_filter(filter);
fmt_layer.boxed()
}
LogFormat::Json => {
let fmt_layer = tracing_subscriber::fmt::layer().json().with_filter(filter);
fmt_layer.boxed()
}
};
let subscriber = tracing_subscriber::registry()
.with(fmt_layer)
.with(self.metrics)
.with(telemetry);
subscriber::set_global_default(subscriber)?;
Ok(())
}
}
fn create_otel_tracer(service_name: &'static str, collector_endpoint: Option<&str>) -> Tracer {
global::set_text_map_propagator(TraceContextPropagator::new());
if let Some(endpoint) = collector_endpoint {
// A special parameter for Jaeger to set the service name in spans.
let resource = Resource::new(vec![KeyValue::new("service.name", service_name)]);
let config = Config::default().with_resource(resource);
let builder = opentelemetry_otlp::new_pipeline().tracing().with_trace_config(config);
let exporter = opentelemetry_otlp::new_exporter().tonic().with_endpoint(endpoint);
builder.with_exporter(exporter).install_simple().unwrap()
} else {
crate::tracer::new_pipeline().install_simple()
}
}
fn create_env_filter(log_queries: bool) -> EnvFilter {
let mut filter = EnvFilter::from_default_env()
.add_directive("tide=error".parse().unwrap())
.add_directive("tonic=error".parse().unwrap())
.add_directive("h2=error".parse().unwrap())
.add_directive("hyper=error".parse().unwrap())
.add_directive("tower=error".parse().unwrap());
if let Ok(qe_log_level) = std::env::var("QE_LOG_LEVEL") {
filter = filter
.add_directive(format!("query_engine={}", &qe_log_level).parse().unwrap())
.add_directive(format!("query_core={}", &qe_log_level).parse().unwrap())
.add_directive(format!("query_connector={}", &qe_log_level).parse().unwrap())
.add_directive(format!("sql_query_connector={}", &qe_log_level).parse().unwrap())
.add_directive(format!("mongodb_query_connector={}", &qe_log_level).parse().unwrap());
}
if log_queries {
// even when mongo queries are logged in debug mode, we want to log them if the log level is higher
filter = filter
.add_directive("quaint[{is_query}]=trace".parse().unwrap())
.add_directive("mongodb_query_connector=debug".parse().unwrap());
}
filter
}