Skip to content

Commit 94d8915

Browse files
committed
Improve tracing spans and log levels
Adjust log levels so that important events are visible atl og level INFO. Adjust spans so that they carry more useful names and fields.
1 parent 3de7886 commit 94d8915

File tree

3 files changed

+14
-13
lines changed

3 files changed

+14
-13
lines changed

aggligator/src/agg/task.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,8 @@ where
386386
///
387387
/// This returns when the connection has been terminated.
388388
/// Cancelling the returned future leads to immediate termination of the connection.
389-
#[tracing::instrument(level = "debug")]
389+
#[tracing::instrument(name = "aggligator::connection", level = "info", skip_all,
390+
fields(conn_id =? self.conn_id, dir =% self.direction), ret)]
390391
pub async fn run(mut self) -> Result<(), TaskError> {
391392
tracing::debug!("link aggregator task starting");
392393
self.start_time = Instant::now();

aggligator/src/transport/acceptor.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ impl Acceptor {
283283
}
284284

285285
/// Task managing all listening transports.
286-
#[tracing::instrument(level="debug", skip_all, fields(id=?server.id()))]
286+
#[tracing::instrument(name = "aggligator::acceptor", level = "info", skip_all, fields(server_id =? server.id()))]
287287
async fn task(
288288
server: BoxServer, active_transports: Arc<RwLock<Vec<Weak<dyn AcceptingTransport>>>>,
289289
mut transport_rx: mpsc::UnboundedReceiver<AcceptingTransportPack>,
@@ -338,7 +338,7 @@ impl Acceptor {
338338
}
339339

340340
/// Task managing a listening transport.
341-
#[tracing::instrument(level="debug", skip_all, fields(transport=transport.transport.name()))]
341+
#[tracing::instrument(level = "debug", skip_all, fields(transport = transport.transport.name()))]
342342
async fn transport_task(
343343
server: BoxServer, transport: AcceptingTransportPack, link_error_tx: broadcast::Sender<BoxLinkError>,
344344
wrappers: Arc<Vec<BoxAcceptingWrapper>>,
@@ -392,12 +392,12 @@ impl Acceptor {
392392
let link = match server.add_incoming(tx, rx, tag.clone(), &user_data).await {
393393
Ok(link) => link,
394394
Err(err) => {
395-
tracing::debug!("adding link for tag {tag} to connection failed: {err}");
395+
tracing::warn!("adding link for tag {tag} to connection failed: {err}");
396396
let _ = link_error_tx.send(LinkError::incoming(&tag, err.into()));
397397
return;
398398
}
399399
};
400-
tracing::debug!("link for tag {tag} connected");
400+
tracing::info!("link for tag {tag} connected to {:?}", link.conn_id());
401401

402402
// Disconnect link when transport is removed.
403403
struct DisconnectLink<'a>(&'a BoxLink);
@@ -410,14 +410,14 @@ impl Acceptor {
410410

411411
// Wait for disconnection and publish reason.
412412
let reason = link.disconnected().await;
413-
tracing::debug!("link for tag {tag} disconnected: {reason}");
413+
tracing::info!("link for tag {tag} disconnected: {reason}");
414414
let _ = link_error_tx.send(BoxLinkError::incoming(&tag, reason.into()));
415415
};
416416
accepting_tasks.push(task);
417417
};
418418

419419
if let Err(err) = &res {
420-
tracing::warn!("transport failed: {err}");
420+
tracing::warn!("transport {} failed: {err}", transport.name());
421421
}
422422

423423
let _ = result_tx.send(res);

aggligator/src/transport/connector.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ impl Connector {
242242

243243
/// Task for handling all transports.
244244
#[allow(clippy::too_many_arguments)]
245-
#[tracing::instrument(level="debug", skip_all, fields(id=?control.id()))]
245+
#[tracing::instrument(name = "aggligator::connector", level = "info", skip_all, fields(conn_id =? control.id()))]
246246
async fn task(
247247
control: BoxControl, active_transports: Arc<RwLock<Vec<Weak<dyn ConnectingTransport>>>>,
248248
mut transport_rx: mpsc::UnboundedReceiver<TransportPack>, tags_tx: watch::Sender<HashSet<LinkTagBox>>,
@@ -327,7 +327,7 @@ impl Connector {
327327
}
328328

329329
/// Task for handling a transport.
330-
#[tracing::instrument(level="debug", skip_all, fields(transport=transport_pack.transport.name()))]
330+
#[tracing::instrument(level = "debug", skip_all, fields(transport = transport_pack.transport.name()))]
331331
async fn transport_task(
332332
transport_pack: TransportPack, control: BoxControl, tags_fw_tx: watch::Sender<HashSet<LinkTagBox>>,
333333
mut disabled_tags_rx: watch::Receiver<HashSet<LinkTagBox>>,
@@ -425,13 +425,13 @@ impl Connector {
425425
let link = match control.add(tx, rx, tag.clone(), &tag.user_data()).await {
426426
Ok(link) => link,
427427
Err(err) => {
428-
tracing::debug!("adding link for tag {tag} to connection failed: {err}");
428+
tracing::warn!("adding link for tag {tag} to connection failed: {err}");
429429
let _ = link_error_tx.send(BoxLinkError::outgoing(conn_id, &tag, err.into()));
430430
sleep(reconnect_delay).await;
431431
return (tag, None);
432432
}
433433
};
434-
tracing::debug!("link for tag {tag} connected");
434+
tracing::info!("link for tag {tag} connected");
435435

436436
// Disconnect link when transport is removed.
437437
struct DisconnectLink<'a>(&'a BoxLink);
@@ -445,7 +445,7 @@ impl Connector {
445445
// Wait for disconnection and publish reason.
446446
let sleep_until = sleep(reconnect_delay);
447447
let reason = link.disconnected().await;
448-
tracing::debug!("link for tag {tag} disconnected: {reason}");
448+
tracing::info!("link for tag {tag} disconnected: {reason}");
449449
let _ = link_error_tx.send(BoxLinkError::outgoing(conn_id, &tag, reason.clone().into()));
450450
sleep_until.await;
451451

@@ -483,7 +483,7 @@ impl Connector {
483483
// Publish result.
484484
match &res {
485485
Ok(()) => tracing::debug!("transport terminated"),
486-
Err(err) => tracing::debug!("transport failed: {err}"),
486+
Err(err) => tracing::warn!("transport {} failed: {err}", transport.name()),
487487
}
488488
let _ = result_tx.send(res);
489489
}

0 commit comments

Comments
 (0)