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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
//! A log thread implementation.
use crate::{
common::{
error::{err, Result},
log::{
callback::LogCallback,
deinit, init,
proxy::LogProxy,
tee_file::{TeeFile, TeeFileConfiguration},
Log, LogRecord, Loglevel, LoglevelFilter, PID,
},
},
trace,
};
use std::thread;
use term::stderr;
#[derive(Debug)]
pub struct LogThread {
sender: Option<crossbeam_channel::Sender<LogRecord>>,
ipc_sender: Option<ipc_channel::ipc::IpcSender<LogRecord>>,
handler: Option<thread::JoinHandle<Result<()>>>,
}
impl LogThread {
/// Spawn a [`LogThread`].
///
/// Returns [`LogThread`] instance if succesful. Also spawns a [`LogProxy`] in the current thread with the provided [`name`] and [`proxy_level`] as [`LogLevelFilter`].
///
/// Output to Standard Error can be enabled by settings the [`stderr_level`] above [`LoglevelFilter::Off`].
/// Output by invocatio of a callback function can be enabled by passing a
/// [`LogCallback`] to [`callback`].
pub fn spawn(
name: impl Into<String>,
proxy_level: LoglevelFilter,
stderr_level: LoglevelFilter,
callback: Option<LogCallback>,
tee_files: Vec<TeeFileConfiguration>,
) -> Result<LogThread> {
// Create the log channel.
let (sender, receiver): (_, crossbeam_channel::Receiver<LogRecord>) =
crossbeam_channel::unbounded();
// Create the IPC log channel.
let (ipc_sender, ipc_receiver) = ipc_channel::ipc::channel()?;
// Spawn the local channel log thread.
let handler = thread::spawn(move || {
let mut t = if stderr_level > LoglevelFilter::Off {
// This may return None which results in no logging to stderr
stderr()
} else {
None
};
let supports_dim = t.is_some() && t.as_ref().unwrap().supports_attr(term::Attr::Dim);
let supports_colors = t.is_some()
&& t.as_ref()
.unwrap()
.supports_attr(term::Attr::ForegroundColor(9));
let trace = t.is_some() && stderr_level >= LoglevelFilter::Trace;
let debug = t.is_some() && stderr_level >= LoglevelFilter::Debug;
let tee_files: Vec<TeeFile> = tee_files
.into_iter()
.map(TeeFile::new)
.collect::<Result<Vec<_>>>()
.or_else(|e| err(e.to_string()))?;
while let Ok(record) = receiver.recv() {
let level = LoglevelFilter::from(record.level());
// Callback
if let Some(callback) = &callback {
callback.log(&record);
}
// Tee files
tee_files
.iter()
.filter(|tf| tf.enabled(record.level()))
.for_each(|tf| tf.log(&record));
// Standard Error
if t.is_some() && level <= stderr_level {
let t = t.as_mut().unwrap();
let color: term::color::Color = record.level().into();
// Timestamp
t.reset()?;
if supports_dim {
t.attr(term::Attr::Dim)?;
}
write!(
t,
"{} ",
humantime::format_rfc3339_seconds(record.timestamp()),
)?;
t.reset()?;
// Delay
if debug {
if supports_colors {
t.fg(8)?;
}
write!(
t,
"{:<6}",
format!("+{}ms", record.timestamp().elapsed().unwrap().as_millis())
)?;
t.reset()?;
}
// LogRecord level
if supports_colors {
t.fg(color)?;
}
write!(t, "{:>5} ", format!("{}", record.level()))?;
t.reset()?;
// Identifier
if supports_colors && *PID != record.process() {
t.fg(record.process() % 7 + 1)?;
}
if supports_dim {
t.attr(term::Attr::Dim)?;
}
if trace {
// With process + thread identifier
write!(
t,
"{:<32} ",
format!(
"{:>5}:{:<2} {} ",
record.process(),
record.thread(),
record.logger(),
)
)?;
} else {
write!(t, "{:<25} ", record.logger())?;
}
t.reset()?;
// LogRecord
if supports_colors && record.level() == Loglevel::Trace {
t.fg(color)?;
}
writeln!(t, "{}", record.payload())?;
t.reset()?;
}
}
// Trace log thread down
if trace {
let t = t.as_mut().unwrap();
if supports_colors {
if t.supports_attr(term::Attr::Standout(true)) {
t.attr(term::Attr::Standout(true))?;
}
t.fg(term::color::BRIGHT_BLACK)?;
}
writeln!(t, "$")?;
}
if t.is_some() {
t.unwrap().reset()?;
}
Ok(())
});
// Start the IPC proxy.
ipc_channel::router::ROUTER
.route_ipc_receiver_to_crossbeam_sender(ipc_receiver, sender.clone());
// Start a LogProxy for the current thread.
init(vec![LogProxy::boxed(name, proxy_level, sender.clone())])?;
trace!("LogThread started");
Ok(LogThread {
sender: Some(sender),
ipc_sender: Some(ipc_sender),
handler: Some(handler),
})
}
pub fn get_sender(&self) -> crossbeam_channel::Sender<LogRecord> {
self.sender.clone().unwrap()
}
pub fn get_ipc_sender(&self) -> ipc_channel::ipc::IpcSender<LogRecord> {
self.ipc_sender.clone().unwrap()
}
}
/// Drops the sender side of the log channel and wait for the log thread to drop.
impl Drop for LogThread {
fn drop(&mut self) {
trace!("Dropping LogThread");
// Disconnect the LogProxy running in the main thread.
deinit().expect("Failed to deinitialize thread-local logger");
// Drop the owned senders to disconnect the log channels.
self.sender = None;
self.ipc_sender = None;
// Wait for the logger thread to be dropped.
self.handler
.take()
.expect("LogThread failed to start")
.join()
.expect("LogThread failed to terminate")
.expect("LogThread failed");
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn debug() {
let _lt = LogThread::spawn(
"name",
LoglevelFilter::Debug,
LoglevelFilter::Error,
None,
vec![],
)
.unwrap();
#[cfg(target_os = "macos")]
assert_eq!(&format!("{:?}", _lt).as_str()[..100], "LogThread { sender: Some(Sender { .. }), ipc_sender: Some(IpcSender { os_sender: OsIpcSender { port:");
#[cfg(target_os = "linux")]
assert_eq!(&format!("{:?}", _lt).as_str()[..98], "LogThread { sender: Some(Sender { .. }), ipc_sender: Some(IpcSender { os_sender: OsIpcSender { fd:");
}
}