(Minor) Improve logs (#1648)

We need to manually set the MDC in `onTermination` handler because the `StopEvent` isn't processed like a regular message by the actor.
ACINQ · Dec 18, 2020 · d44ff85 · d44ff85
1 parent 39d9bfb
commit d44ff85
Showing 1 changed file with 11 additions and 10 deletions.
diff --git a/eclair-core/src/main/scala/fr/acinq/eclair/crypto/TransportHandler.scala b/eclair-core/src/main/scala/fr/acinq/eclair/crypto/TransportHandler.scala
@@ -17,6 +17,7 @@
 package fr.acinq.eclair.crypto
 
 import java.nio.ByteOrder
+
 import akka.actor.{Actor, ActorRef, ExtendedActorSystem, FSM, PoisonPill, Props, Terminated}
 import akka.event.Logging.MDC
 import akka.event._
@@ -29,13 +30,10 @@ import fr.acinq.eclair.crypto.ChaCha20Poly1305.ChaCha20Poly1305Error
 import fr.acinq.eclair.crypto.Noise._
 import fr.acinq.eclair.remote.EclairInternalsSerializer.RemoteTypes
 import fr.acinq.eclair.wire.{AnnouncementSignatures, RoutingMessage}
-import fr.acinq.eclair.{Diagnostics, FSMDiagnosticActorLogging, Logs}
-import fr.acinq.eclair.wire.{ChannelAnnouncement, ChannelUpdate, NodeAnnouncement}
 import fr.acinq.eclair.{Diagnostics, FSMDiagnosticActorLogging, Logs, getSimpleClassName}
 import scodec.bits.ByteVector
 import scodec.{Attempt, Codec, DecodeResult}
 
-import java.nio.ByteOrder
 import scala.annotation.tailrec
 import scala.collection.immutable.Queue
 import scala.reflect.ClassTag
@@ -274,13 +272,16 @@ class TransportHandler[T: ClassTag](keyPair: KeyPair, rs: Option[ByteVector], co
 
   onTermination {
     case _: StopEvent =>
-      connection ! Tcp.Close // attempts to gracefully close the connection when dying
-      stateData match {
-        case normal: NormalData[_] =>
-          // NB: we deduplicate on the class name: each class will appear once but there may be many instances (less verbose and gives debug hints)
-          log.info("stopping (unackedReceived={} unackedSent={})", normal.unackedReceived.keys.map(getSimpleClassName).toSet.mkString(","), normal.unackedSent.map(getSimpleClassName))
-        case _ =>
-          log.info("stopping")
+      // we need to set the mdc here, because StopEvent doesn't go through the regular actor's mailbox
+      Logs.withMdc(diagLog)(Logs.mdc(category_opt = Some(Logs.LogCategory.CONNECTION), remoteNodeId_opt = remoteNodeId_opt)) {
+        connection ! Tcp.Close // attempts to gracefully close the connection when dying
+        stateData match {
+          case normal: NormalData[_] =>
+            // NB: we deduplicate on the class name: each class will appear once but there may be many instances (less verbose and gives debug hints)
+            log.info("stopping (unackedReceived={} unackedSent={})", normal.unackedReceived.keys.map(getSimpleClassName).toSet.mkString(","), normal.unackedSent.map(getSimpleClassName))
+          case _ =>
+            log.info("stopping")
+        }
       }
   }