use crate::metrics::latency::LatencyTracker;
use crate::metrics::IOCounters;
use std::sync::Arc;
use std::time::Duration;
pub(crate) const TARGET_CONCURRENCY: &str = "aws_s3_transfer::concurrency";
pub(crate) const TARGET_SCHEDULING: &str = "aws_s3_transfer::scheduling";
pub(crate) const TARGET_MEMORY: &str = "aws_s3_transfer::memory";
pub(crate) const TARGET_EXECUTION: &str = "aws_s3_transfer::execution";
pub(crate) const TARGET_TRANSFER: &str = "aws_s3_transfer::transfer";
pub(crate) const TARGET_TRANSFER_UPLOAD: &str = "aws_s3_transfer::transfer::upload";
pub(crate) const TARGET_TRANSFER_DOWNLOAD: &str = "aws_s3_transfer::transfer::download";
pub(crate) const TARGET_TRANSFER_UPLOAD_OBJECTS: &str = "aws_s3_transfer::transfer::upload_objects";
pub(crate) const TARGET_TRANSFER_DOWNLOAD_OBJECTS: &str =
"aws_s3_transfer::transfer::download_objects";
pub(crate) struct Telemetry {
pub(crate) recv_latencies: LatencyTracker,
pub(crate) io_counters: Arc<IOCounters>,
}
impl Telemetry {
pub(crate) fn new(counter_window: Duration) -> Self {
Self {
recv_latencies: LatencyTracker::new(),
io_counters: Arc::new(IOCounters::new(counter_window)),
}
}
}
impl std::fmt::Debug for Telemetry {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Telemetry")
.field("recv_latencies", &self.recv_latencies)
.finish_non_exhaustive()
}
}
#[cfg(test)]
mod tests {
use super::{
TARGET_TRANSFER, TARGET_TRANSFER_DOWNLOAD, TARGET_TRANSFER_DOWNLOAD_OBJECTS,
TARGET_TRANSFER_UPLOAD, TARGET_TRANSFER_UPLOAD_OBJECTS,
};
use tracing::Level;
use tracing_subscriber::EnvFilter;
fn with_filter(directives: &str, check: impl FnOnce()) {
let subscriber = tracing_subscriber::fmt()
.with_env_filter(EnvFilter::new(directives))
.with_writer(std::io::sink)
.finish();
tracing::subscriber::with_default(subscriber, check);
}
#[test]
fn transfer_directive_enables_every_operation() {
with_filter("aws_s3_transfer::transfer=debug", || {
assert!(tracing::enabled!(target: TARGET_TRANSFER, Level::DEBUG));
assert!(tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::DEBUG));
assert!(tracing::enabled!(target: TARGET_TRANSFER_DOWNLOAD, Level::DEBUG));
assert!(tracing::enabled!(
target: TARGET_TRANSFER_UPLOAD_OBJECTS,
Level::DEBUG
));
assert!(tracing::enabled!(
target: TARGET_TRANSFER_DOWNLOAD_OBJECTS,
Level::DEBUG
));
assert!(!tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::TRACE));
});
}
#[test]
fn operation_directive_matches_targets_it_prefixes() {
with_filter("aws_s3_transfer::transfer::download=debug", || {
assert!(tracing::enabled!(target: TARGET_TRANSFER_DOWNLOAD, Level::DEBUG));
assert!(!tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::DEBUG));
assert!(!tracing::enabled!(
target: TARGET_TRANSFER_UPLOAD_OBJECTS,
Level::DEBUG
));
assert!(!tracing::enabled!(target: TARGET_TRANSFER, Level::DEBUG));
assert!(tracing::enabled!(
target: TARGET_TRANSFER_DOWNLOAD_OBJECTS,
Level::DEBUG
));
});
}
#[test]
fn child_directive_overrides_parent_directive() {
with_filter(
"aws_s3_transfer::transfer=warn,aws_s3_transfer::transfer::upload=debug",
|| {
assert!(tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::DEBUG));
assert!(!tracing::enabled!(target: TARGET_TRANSFER_DOWNLOAD, Level::DEBUG));
assert!(tracing::enabled!(target: TARGET_TRANSFER_DOWNLOAD, Level::WARN));
},
);
}
#[test]
fn one_operation_at_a_different_level() {
with_filter(
"aws_s3_transfer::transfer=debug,aws_s3_transfer::transfer::upload_objects=trace",
|| {
assert!(tracing::enabled!(
target: TARGET_TRANSFER_UPLOAD_OBJECTS,
Level::TRACE
));
assert!(!tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::TRACE));
assert!(tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::DEBUG));
},
);
}
#[test]
fn longer_directive_sets_composite_parent_level() {
with_filter(
"aws_s3_transfer::transfer::upload=debug,aws_s3_transfer::transfer::upload_objects=warn",
|| {
assert!(tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::DEBUG));
assert!(!tracing::enabled!(
target: TARGET_TRANSFER_UPLOAD_OBJECTS,
Level::DEBUG
));
assert!(tracing::enabled!(
target: TARGET_TRANSFER_UPLOAD_OBJECTS,
Level::WARN
));
},
);
}
#[test]
fn quieting_children_keeps_parent_only_when_parent_is_named() {
let quiet_children =
"aws_s3_transfer::transfer=debug,aws_s3_transfer::transfer::upload=info";
with_filter(quiet_children, || {
assert!(!tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::DEBUG));
assert!(!tracing::enabled!(
target: TARGET_TRANSFER_UPLOAD_OBJECTS,
Level::DEBUG
));
});
with_filter(
&format!("{quiet_children},aws_s3_transfer::transfer::upload_objects=debug"),
|| {
assert!(!tracing::enabled!(target: TARGET_TRANSFER_UPLOAD, Level::DEBUG));
assert!(tracing::enabled!(
target: TARGET_TRANSFER_UPLOAD_OBJECTS,
Level::DEBUG
));
},
);
}
}