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 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
use std::{
cmp,
collections::{BTreeMap, HashSet},
fs::{self, remove_file},
path::PathBuf,
sync::Arc,
time::{self, Duration},
};
use bytes::Bytes;
use chrono::{DateTime, Utc};
use futures::{
future::{select, Either},
Future, Sink, SinkExt,
};
use indexmap::IndexMap;
use tokio::time::sleep;
use tracing::{debug, error, info, trace};
use crate::{
checkpointer::{Checkpointer, CheckpointsView},
file_watcher::FileWatcher,
fingerprinter::{FileFingerprint, Fingerprinter},
paths_provider::PathsProvider,
FileSourceInternalEvents, ReadFrom,
};
/// `FileServer` is a Source which cooperatively schedules reads over files,
/// converting the lines of said files into `LogLine` structures. As
/// `FileServer` is intended to be useful across multiple operating systems with
/// POSIX filesystem semantics `FileServer` must poll for changes. That is, no
/// event notification is used by `FileServer`.
///
/// `FileServer` is configured on a path to watch. The files do _not_ need to
/// exist at startup. `FileServer` will discover new files which match
/// its path in at most 60 seconds.
pub struct FileServer<PP, E: FileSourceInternalEvents>
where
PP: PathsProvider,
{
pub paths_provider: PP,
pub max_read_bytes: usize,
pub ignore_checkpoints: bool,
pub read_from: ReadFrom,
pub ignore_before: Option<DateTime<Utc>>,
pub max_line_bytes: usize,
pub line_delimiter: Bytes,
pub data_dir: PathBuf,
pub glob_minimum_cooldown: Duration,
pub fingerprinter: Fingerprinter,
pub oldest_first: bool,
pub remove_after: Option<Duration>,
pub emitter: E,
pub handle: tokio::runtime::Handle,
pub rotate_wait: Duration,
}
/// `FileServer` as Source
///
/// The 'run' of `FileServer` performs the cooperative scheduling of reads over
/// `FileServer`'s configured files. Much care has been taking to make this
/// scheduling 'fair', meaning busy files do not drown out quiet files or vice
/// versa but there's no one perfect approach. Very fast files _will_ be lost if
/// your system aggressively rolls log files. `FileServer` will keep a file
/// handler open but should your system move so quickly that a file disappears
/// before `FileServer` is able to open it the contents will be lost. This should be a
/// rare occurrence.
///
/// Specific operating systems support evented interfaces that correct this
/// problem but your intrepid authors know of no generic solution.
impl<PP, E> FileServer<PP, E>
where
PP: PathsProvider,
E: FileSourceInternalEvents,
{
// The first `shutdown_data` signal here is to stop this file
// server from outputting new data; the second
// `shutdown_checkpointer` is for finishing the background
// checkpoint writer task, which has to wait for all
// acknowledgements to be completed.
pub fn run<C, S1, S2>(
self,
mut chans: C,
mut shutdown_data: S1,
shutdown_checkpointer: S2,
mut checkpointer: Checkpointer,
) -> Result<Shutdown, <C as Sink<Vec<Line>>>::Error>
where
C: Sink<Vec<Line>> + Unpin,
<C as Sink<Vec<Line>>>::Error: std::error::Error,
S1: Future + Unpin + Send + 'static,
S2: Future + Unpin + Send + 'static,
{
let mut fingerprint_buffer = Vec::new();
let mut fp_map: IndexMap<FileFingerprint, FileWatcher> = Default::default();
let mut backoff_cap: usize = 1;
let mut lines = Vec::new();
checkpointer.read_checkpoints(self.ignore_before);
let mut known_small_files = HashSet::new();
let mut existing_files = Vec::new();
for path in self.paths_provider.paths().into_iter() {
if let Some(file_id) = self.fingerprinter.get_fingerprint_or_log_error(
&path,
&mut fingerprint_buffer,
&mut known_small_files,
&self.emitter,
) {
existing_files.push((path, file_id));
}
}
existing_files.sort_by_key(|(path, _file_id)| {
fs::metadata(path)
.and_then(|m| m.created())
.map(DateTime::<Utc>::from)
.unwrap_or_else(|_| Utc::now())
});
let checkpoints = checkpointer.view();
for (path, file_id) in existing_files {
checkpointer.maybe_upgrade(
&path,
file_id,
&self.fingerprinter,
&mut fingerprint_buffer,
);
self.watch_new_file(path, file_id, &mut fp_map, &checkpoints, true);
}
self.emitter.emit_files_open(fp_map.len());
let mut stats = TimingStats::default();
// Spawn the checkpoint writer task
let checkpoint_task_handle = self.handle.spawn(checkpoint_writer(
checkpointer,
self.glob_minimum_cooldown,
shutdown_checkpointer,
self.emitter.clone(),
));
// Alright friends, how does this work?
//
// We want to avoid burning up users' CPUs. To do this we sleep after
// reading lines out of files. But! We want to be responsive as well. We
// keep track of a 'backoff_cap' to decide how long we'll wait in any
// given loop. This cap grows each time we fail to read lines in an
// exponential fashion to some hard-coded cap. To reduce time using glob,
// we do not re-scan for major file changes (new files, moves, deletes),
// or write new checkpoints, on every iteration.
let mut next_glob_time = time::Instant::now();
loop {
// Glob find files to follow, but not too often.
let now_time = time::Instant::now();
if next_glob_time <= now_time {
// Schedule the next glob time.
next_glob_time = now_time.checked_add(self.glob_minimum_cooldown).unwrap();
if stats.started_at.elapsed() > Duration::from_secs(1) {
stats.report();
}
if stats.started_at.elapsed() > Duration::from_secs(10) {
stats = TimingStats::default();
}
// Search (glob) for files to detect major file changes.
let start = time::Instant::now();
for (_file_id, watcher) in &mut fp_map {
watcher.set_file_findable(false); // assume not findable until found
}
for path in self.paths_provider.paths().into_iter() {
if let Some(file_id) = self.fingerprinter.get_fingerprint_or_log_error(
&path,
&mut fingerprint_buffer,
&mut known_small_files,
&self.emitter,
) {
if let Some(watcher) = fp_map.get_mut(&file_id) {
// file fingerprint matches a watched file
let was_found_this_cycle = watcher.file_findable();
watcher.set_file_findable(true);
if watcher.path == path {
trace!(
message = "Continue watching file.",
path = ?path,
);
} else if !was_found_this_cycle {
// matches a file with a different path
info!(
message = "Watched file has been renamed.",
path = ?path,
old_path = ?watcher.path
);
watcher.update_path(path).ok(); // ok if this fails: might fix next cycle
} else {
info!(
message = "More than one file has the same fingerprint.",
path = ?path,
old_path = ?watcher.path
);
let (old_path, new_path) = (&watcher.path, &path);
if let (Ok(old_modified_time), Ok(new_modified_time)) = (
fs::metadata(old_path).and_then(|m| m.modified()),
fs::metadata(new_path).and_then(|m| m.modified()),
) {
if old_modified_time < new_modified_time {
info!(
message = "Switching to watch most recently modified file.",
new_modified_time = ?new_modified_time,
old_modified_time = ?old_modified_time,
);
watcher.update_path(path).ok(); // ok if this fails: might fix next cycle
}
}
}
} else {
// untracked file fingerprint
self.watch_new_file(path, file_id, &mut fp_map, &checkpoints, false);
self.emitter.emit_files_open(fp_map.len());
}
}
}
stats.record("discovery", start.elapsed());
}
// Collect lines by polling files.
let mut global_bytes_read: usize = 0;
let mut maxed_out_reading_single_file = false;
for (&file_id, watcher) in &mut fp_map {
if !watcher.should_read() {
continue;
}
let start = time::Instant::now();
let mut bytes_read: usize = 0;
while let Ok(Some(line)) = watcher.read_line() {
let sz = line.bytes.len();
trace!(
message = "Read bytes.",
path = ?watcher.path,
bytes = ?sz
);
stats.record_bytes(sz);
bytes_read += sz;
lines.push(Line {
text: line.bytes,
filename: watcher.path.to_str().expect("not a valid path").to_owned(),
file_id,
start_offset: line.offset,
end_offset: watcher.get_file_position(),
});
if bytes_read > self.max_read_bytes {
maxed_out_reading_single_file = true;
break;
}
}
stats.record("reading", start.elapsed());
if bytes_read > 0 {
global_bytes_read = global_bytes_read.saturating_add(bytes_read);
} else {
// Should the file be removed
if let Some(grace_period) = self.remove_after {
if watcher.last_read_success().elapsed() >= grace_period {
// Try to remove
match remove_file(&watcher.path) {
Ok(()) => {
self.emitter.emit_file_deleted(&watcher.path);
watcher.set_dead();
}
Err(error) => {
// We will try again after some time.
self.emitter.emit_file_delete_error(&watcher.path, error);
}
}
}
}
}
// Do not move on to newer files if we are behind on an older file
if self.oldest_first && maxed_out_reading_single_file {
break;
}
}
for (_, watcher) in &mut fp_map {
if !watcher.file_findable() && watcher.last_seen().elapsed() > self.rotate_wait {
watcher.set_dead();
}
}
// A FileWatcher is dead when the underlying file has disappeared.
// If the FileWatcher is dead we don't retain it; it will be deallocated.
fp_map.retain(|file_id, watcher| {
if watcher.dead() {
self.emitter
.emit_file_unwatched(&watcher.path, watcher.reached_eof());
checkpoints.set_dead(*file_id);
false
} else {
true
}
});
self.emitter.emit_files_open(fp_map.len());
let start = time::Instant::now();
let to_send = std::mem::take(&mut lines);
let result = self.handle.block_on(chans.send(to_send));
match result {
Ok(()) => {}
Err(error) => {
error!(message = "Output channel closed.", %error);
return Err(error);
}
}
stats.record("sending", start.elapsed());
let start = time::Instant::now();
// When no lines have been read we kick the backup_cap up by twice,
// limited by the hard-coded cap. Else, we set the backup_cap to its
// minimum on the assumption that next time through there will be
// more lines to read promptly.
backoff_cap = if global_bytes_read == 0 {
cmp::min(2_048, backoff_cap.saturating_mul(2))
} else {
1
};
let backoff = backoff_cap.saturating_sub(global_bytes_read);
// This works only if run inside tokio context since we are using
// tokio's Timer. Outside of such context, this will panic on the first
// call. Also since we are using block_on here and in the above code,
// this should be run in its own thread. `spawn_blocking` fulfills
// all of these requirements.
let sleep = async move {
if backoff > 0 {
sleep(Duration::from_millis(backoff as u64)).await;
}
};
futures::pin_mut!(sleep);
match self.handle.block_on(select(shutdown_data, sleep)) {
Either::Left((_, _)) => {
self.handle
.block_on(chans.close())
.expect("error closing file_server data channel.");
let checkpointer = self
.handle
.block_on(checkpoint_task_handle)
.expect("checkpoint task has panicked");
if let Err(error) = checkpointer.write_checkpoints() {
error!(?error, "Error writing checkpoints before shutdown");
}
return Ok(Shutdown);
}
Either::Right((_, future)) => shutdown_data = future,
}
stats.record("sleeping", start.elapsed());
}
}
fn watch_new_file(
&self,
path: PathBuf,
file_id: FileFingerprint,
fp_map: &mut IndexMap<FileFingerprint, FileWatcher>,
checkpoints: &CheckpointsView,
startup: bool,
) {
// Determine the initial _requested_ starting point in the file. This can be overridden
// once the file is actually opened and we determine it is compressed, older than we're
// configured to read, etc.
let fallback = if startup {
self.read_from
} else {
// Always read new files that show up while we're running from the beginning. There's
// not a good way to determine if they were moved or just created and written very
// quickly, so just make sure we're not missing any data.
ReadFrom::Beginning
};
// Always prefer the stored checkpoint unless the user has opted out. Previously, the
// checkpoint was only loaded for new files when Vector was started up, but the
// `kubernetes_logs` source returns the files well after start-up, once it has populated
// them from the k8s metadata, so we now just always use the checkpoints unless opted out.
// https://github.com/vectordotdev/vector/issues/7139
let read_from = if !self.ignore_checkpoints {
checkpoints
.get(file_id)
.map(ReadFrom::Checkpoint)
.unwrap_or(fallback)
} else {
fallback
};
match FileWatcher::new(
path.clone(),
read_from,
self.ignore_before,
self.max_line_bytes,
self.line_delimiter.clone(),
) {
Ok(mut watcher) => {
if let ReadFrom::Checkpoint(file_position) = read_from {
self.emitter.emit_file_resumed(&path, file_position);
} else {
self.emitter.emit_file_added(&path);
}
watcher.set_file_findable(true);
fp_map.insert(file_id, watcher);
}
Err(error) => self.emitter.emit_file_watch_error(&path, error),
};
}
}
async fn checkpoint_writer(
checkpointer: Checkpointer,
sleep_duration: Duration,
mut shutdown: impl Future + Unpin,
emitter: impl FileSourceInternalEvents,
) -> Arc<Checkpointer> {
let checkpointer = Arc::new(checkpointer);
loop {
let sleep = sleep(sleep_duration);
tokio::select! {
_ = &mut shutdown => break,
_ = sleep => {},
}
let emitter = emitter.clone();
let checkpointer = Arc::clone(&checkpointer);
tokio::task::spawn_blocking(move || {
let start = time::Instant::now();
match checkpointer.write_checkpoints() {
Ok(count) => emitter.emit_file_checkpointed(count, start.elapsed()),
Err(error) => emitter.emit_file_checkpoint_write_error(error),
}
})
.await
.ok();
}
checkpointer
}
pub fn calculate_ignore_before(ignore_older_secs: Option<u64>) -> Option<DateTime<Utc>> {
ignore_older_secs.map(|secs| Utc::now() - chrono::Duration::seconds(secs as i64))
}
/// A sentinel type to signal that file server was gracefully shut down.
///
/// The purpose of this type is to clarify the semantics of the result values
/// returned from the [`FileServer::run`] for both the users of the file server,
/// and the implementors.
#[derive(Debug)]
pub struct Shutdown;
struct TimingStats {
started_at: time::Instant,
segments: BTreeMap<&'static str, Duration>,
events: usize,
bytes: usize,
}
impl TimingStats {
fn record(&mut self, key: &'static str, duration: Duration) {
let segment = self.segments.entry(key).or_default();
*segment += duration;
}
fn record_bytes(&mut self, bytes: usize) {
self.events += 1;
self.bytes += bytes;
}
fn report(&self) {
let total = self.started_at.elapsed();
let counted: Duration = self.segments.values().sum();
let other: Duration = self.started_at.elapsed() - counted;
let mut ratios = self
.segments
.iter()
.map(|(k, v)| (*k, v.as_secs_f32() / total.as_secs_f32()))
.collect::<BTreeMap<_, _>>();
ratios.insert("other", other.as_secs_f32() / total.as_secs_f32());
let (event_throughput, bytes_throughput) = if total.as_secs() > 0 {
(
self.events as u64 / total.as_secs(),
self.bytes as u64 / total.as_secs(),
)
} else {
(0, 0)
};
debug!(event_throughput = %scale(event_throughput), bytes_throughput = %scale(bytes_throughput), ?ratios);
}
}
fn scale(bytes: u64) -> String {
let units = ["", "k", "m", "g"];
let mut bytes = bytes as f32;
let mut i = 0;
while bytes > 1000.0 && i <= 3 {
bytes /= 1000.0;
i += 1;
}
format!("{:.3}{}/sec", bytes, units[i])
}
impl Default for TimingStats {
fn default() -> Self {
Self {
started_at: time::Instant::now(),
segments: Default::default(),
events: Default::default(),
bytes: Default::default(),
}
}
}
#[derive(Debug)]
pub struct Line {
pub text: Bytes,
pub filename: String,
pub file_id: FileFingerprint,
pub start_offset: u64,
pub end_offset: u64,
}