Fix tracing messages for Snapshot checksum errors

Author: jasagredo

cardano-node/src/Cardano/Node/Tracing/Tracers/ChainDB.hs

@@ -35,6 +35,7 @@ import           Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal (chunkN
 import qualified Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types as ImmDB
 import           Ouroboros.Consensus.Storage.LedgerDB (ReplayStart (..),
                    UpdateLedgerDbTraceEvent (..))
+import qualified Ouroboros.Consensus.Storage.LedgerDB.Snapshots as LedgerDB
 import qualified Ouroboros.Consensus.Storage.LedgerDB as LedgerDB
 import qualified Ouroboros.Consensus.Storage.VolatileDB as VolDB
 import           Ouroboros.Consensus.Util.Condense (condense)
@@ -1566,12 +1567,19 @@ instance ( StandardHash blk
                  ]
     where
       context = case failure of
-        LedgerDB.InitFailureRead{} ->
-             " This is most likely an expected change in the serialization format,"
-          <> " which currently requires a chain replay"
+        LedgerDB.InitFailureRead LedgerDB.ReadSnapshotFailed{} ->
+                   " This is most likely an expected change in the serialization format,"
+                <> " which currently requires a chain replay"
+        LedgerDB.InitFailureRead LedgerDB.ReadSnapshotDataCorruption ->
+                   " The checksum does not match the snapshot. Seems like the snapshot is corrupted"
+        LedgerDB.InitFailureRead LedgerDB.ReadSnapshotInvalidChecksumFile{} ->
+                   " The checksum file contains malformed json"
+        LedgerDB.InitFailureRead LedgerDB.ReadSnapshotNoChecksumFile{} ->
+                   " Snapshot checksum checks are enabled but the snapshot had no checksum file."
+                <> " Did you intend to disable them with `\"DoDiskSnapshotChecksum\": True` in the configuration file?"
         _ -> ""
   forHuman (LedgerDB.SnapshotMissingChecksum snap) =
-    Text.unwords ["Snapshot missing checksum", showT snap]
+      "Checksum file is missing for snapshot " <> showT snap
 
   forMachine dtals (LedgerDB.TookSnapshot snap pt enclosedTiming) =
     mconcat [ "kind" .= String "TookSnapshot"
@@ -1586,19 +1594,20 @@ instance ( StandardHash blk
              , "snapshot" .= forMachine dtals snap
              , "failure" .= show failure ]
   forMachine dtals (LedgerDB.SnapshotMissingChecksum snap) =
-    mconcat [ "kind" .= String "MissingChecksum"
-             , "snapshot" .= forMachine dtals snap ]
+    mconcat [ "kind" .= String "SnapshotMissingChecksum"
+            , "snapshot" .= forMachine dtals snap
+            ]
 
 instance MetaTrace (LedgerDB.TraceSnapshotEvent blk) where
     namespaceFor LedgerDB.TookSnapshot {} = Namespace [] ["TookSnapshot"]
     namespaceFor LedgerDB.DeletedSnapshot {} = Namespace [] ["DeletedSnapshot"]
     namespaceFor LedgerDB.InvalidSnapshot {} = Namespace [] ["InvalidSnapshot"]
-    namespaceFor LedgerDB.SnapshotMissingChecksum {} = Namespace [] ["MissingChecksum"]
+    namespaceFor LedgerDB.SnapshotMissingChecksum {} = Namespace [] ["SnapshotMissingChecksum"]
 
     severityFor  (Namespace _ ["TookSnapshot"]) _ = Just Info
     severityFor  (Namespace _ ["DeletedSnapshot"]) _ = Just Debug
     severityFor  (Namespace _ ["InvalidSnapshot"]) _ = Just Error
-    severityFor  (Namespace _ ["MissingChecksum"]) _ = Just Error
+    severityFor  (Namespace _ ["SnapshotMissingChecksum"]) _ = Just Warning
     severityFor _ _ = Nothing
 
     documentFor (Namespace _ ["TookSnapshot"]) = Just $ mconcat
@@ -1610,15 +1619,15 @@ instance MetaTrace (LedgerDB.TraceSnapshotEvent blk) where
           "A snapshot was deleted from the disk."
     documentFor (Namespace _ ["InvalidSnapshot"]) = Just
           "An on disk snapshot was invalid. Unless it was suffixed, it will be deleted"
-    documentFor (Namespace _ ["MissingChecksum"]) = Just
-          "Snapshot is missing checksum"
+    documentFor (Namespace _ ["SnapshotMissingChecksum"]) = Just
+          "Checksum file was missing for snapshot."
     documentFor _ = Nothing
 
     allNamespaces =
       [ Namespace [] ["TookSnapshot"]
       , Namespace [] ["DeletedSnapshot"]
       , Namespace [] ["InvalidSnapshot"]
-      , Namespace [] ["MissingChecksum"]
+      , Namespace [] ["SnapshotMissingChecksum"]
       ]
 
 

cardano-node/src/Cardano/Tracing/OrphanInstances/Consensus.hs

@@ -69,6 +69,7 @@ import qualified Ouroboros.Consensus.Storage.ImmutableDB.Impl.Types as ImmDB
 import           Ouroboros.Consensus.Storage.LedgerDB (PushGoal (..), PushStart (..), Pushing (..),
                    ReplayStart (..))
 import qualified Ouroboros.Consensus.Storage.LedgerDB as LedgerDB
+import qualified Ouroboros.Consensus.Storage.LedgerDB.Snapshots as LedgerDB
 import qualified Ouroboros.Consensus.Storage.VolatileDB.Impl as VolDb
 import           Ouroboros.Consensus.Util.Condense
 import           Ouroboros.Consensus.Util.Enclose
@@ -173,7 +174,7 @@ instance HasSeverityAnnotation (ChainDB.TraceEvent blk) where
     LedgerDB.TookSnapshot {} -> Info
     LedgerDB.DeletedSnapshot {} -> Debug
     LedgerDB.InvalidSnapshot {} -> Error
-    LedgerDB.SnapshotMissingChecksum {} -> Error
+    LedgerDB.SnapshotMissingChecksum {} -> Warning
 
   getSeverityAnnotation (ChainDB.TraceCopyToImmutableDBEvent ev) = case ev of
     ChainDB.CopiedBlockToImmutableDB {} -> Debug
@@ -599,11 +600,19 @@ instance ( ConvertRawHash blk
           "Invalid snapshot " <> showT snap <> showT failure <> context
           where
             context = case failure of
-              LedgerDB.InitFailureRead{} ->
+              LedgerDB.InitFailureRead LedgerDB.ReadSnapshotFailed{} ->
                    " This is most likely an expected change in the serialization format,"
                 <> " which currently requires a chain replay"
+              LedgerDB.InitFailureRead LedgerDB.ReadSnapshotDataCorruption ->
+                   " The checksum does not match the snapshot. Seems like the snapshot is corrupted"
+              LedgerDB.InitFailureRead LedgerDB.ReadSnapshotInvalidChecksumFile{} ->
+                   " The checksum file contains malformed json"
+              LedgerDB.InitFailureRead LedgerDB.ReadSnapshotNoChecksumFile{} ->
+                   " Snapshot checksum checks are enabled but the snapshot had no checksum file."
+                <> " Did you intend to disable them with `\"DoDiskSnapshotChecksum\": True` in the configuration file?"
               _ -> ""
-
+        LedgerDB.SnapshotMissingChecksum snap ->
+          "Checksum file is missing for snapshot " <> showT snap
         LedgerDB.TookSnapshot snap pt RisingEdge ->
           "Taking ledger snapshot " <> showT snap <>
           " at " <> renderRealPointAsPhrase pt
@@ -613,8 +622,6 @@ instance ( ConvertRawHash blk
           ", duration: " <> showT t
         LedgerDB.DeletedSnapshot snap ->
           "Deleted old snapshot " <> showT snap
-        LedgerDB.SnapshotMissingChecksum snap ->
-          "Missing snapshot checksum " <> showT snap
       ChainDB.TraceCopyToImmutableDBEvent ev -> case ev of
         ChainDB.CopiedBlockToImmutableDB pt ->
           "Copied block " <> renderPointAsPhrase pt <> " to the ImmutableDB"
@@ -1060,7 +1067,7 @@ instance ( ConvertRawHash blk
                , "snapshot" .= toObject verb snap
                , "failure" .= show failure ]
     LedgerDB.SnapshotMissingChecksum snap ->
-      mconcat [ "kind" .= String "TraceSnapshotEvent.InvalidSnapshot"
+      mconcat [ "kind" .= String "TraceSnapshotEvent.SnapshotMissingChecksum"
                , "snapshot" .= toObject verb snap
                ]