connection-manager: counters

* Added `terminating` connections;
* Fixed an issue when we trace counters, but they haven't changed.

Author: coot

ouroboros-network-framework/CHANGELOG.md

@@ -6,6 +6,8 @@
 
 ### Breaking changes
 
+* Added `terminatingConns` to `ConnectionManagerCounters`
+
 ## 0.17.0.0 -- 2025-02-25
 
 ### Breaking changes

ouroboros-network-framework/sim-tests/Test/Ouroboros/Network/Server/Sim.hs

@@ -1330,17 +1330,17 @@ prop_connection_manager_counters (Fixed rnd) serverAcc (ArbDataFlow dataFlow)
             . List.foldl'
                (\ st ce -> case ce of
                  StartClient _ ta ->
-                   Map.alter (let c = ConnectionManagerCounters 0 0 1 0 0 in
+                   Map.alter (let c = ConnectionManagerCounters 0 0 1 0 0 0 in
                               maybe (Just c) (Just . maxCounters c))
                              ta st
 
                  OutboundConnection _ ta ->
-                   Map.alter (let c = ConnectionManagerCounters 0 ifDuplex ifUni 0 1 in
+                   Map.alter (let c = ConnectionManagerCounters 0 ifDuplex ifUni 0 1 0 in
                               maybe (Just c) (Just . maxCounters c))
                              ta st
 
                  InboundConnection _ ta ->
-                   Map.alter (let c = ConnectionManagerCounters 0 ifDuplex ifUni 1 0 in
+                   Map.alter (let c = ConnectionManagerCounters 0 ifDuplex ifUni 1 0 0 in
                               maybe (Just c) (Just . maxCounters c))
                              ta st
 
@@ -1359,8 +1359,8 @@ prop_connection_manager_counters (Fixed rnd) serverAcc (ArbDataFlow dataFlow)
                            (\cmc' provenance ->
                              cmc' <>
                              if provenance == serverAddress
-                                then ConnectionManagerCounters 0 0 0 0 1
-                                else ConnectionManagerCounters 0 0 0 1 0
+                                then ConnectionManagerCounters 0 0 0 0 1 0
+                                else ConnectionManagerCounters 0 0 0 1 0 0
                            )
                            mempty
                            conns
@@ -1372,14 +1372,15 @@ prop_connection_manager_counters (Fixed rnd) serverAcc (ArbDataFlow dataFlow)
     maxCounters :: ConnectionManagerCounters
                 -> ConnectionManagerCounters
                 -> ConnectionManagerCounters
-    maxCounters (ConnectionManagerCounters a b c d e)
-                (ConnectionManagerCounters a' b' c' d' e') =
+    maxCounters (ConnectionManagerCounters a b c d e f)
+                (ConnectionManagerCounters a' b' c' d' e' f') =
       ConnectionManagerCounters
         (max a a')
         (max b b')
         (max c c')
         (max d d')
         (max e e')
+        (max f f')
 
     -- It is possible for the ObservableNetworkState to have discrepancies between the
     -- counters traced by TrConnectionManagerCounters. This leads to different
@@ -1402,10 +1403,14 @@ prop_connection_manager_counters (Fixed rnd) serverAcc (ArbDataFlow dataFlow)
                              -- of the total sum.
                      -> ConnectionManagerCounters
                      -> (Int, Int, Int)
-    collapseCounters t (ConnectionManagerCounters _ a b c d) =
+    collapseCounters t ConnectionManagerCounters { duplexConns,
+                                                   unidirectionalConns,
+                                                   inboundConns,
+                                                   outboundConns
+                                                 } =
       if t
-         then (a, b, c + d)
-         else (a, b, c + d - a)
+         then (duplexConns, unidirectionalConns, inboundConns + outboundConns)
+         else (duplexConns, unidirectionalConns, inboundConns + outboundConns - duplexConns)
 
     networkStateTracer getState =
       Tracer $ \_ -> getState >>= traceM

ouroboros-network-framework/src/Ouroboros/Network/ConnectionManager/Core.hs

@@ -43,12 +43,12 @@ import Data.Typeable (Typeable)
 import GHC.Stack (CallStack, HasCallStack, callStack)
 import System.Random (StdGen, split)
 
+import Data.List qualified as List
 import Data.Map.Strict (Map)
 import Data.Map.Strict qualified as Map
-import Data.Set qualified as Set
-
 import Data.Monoid.Synchronisation
 import Data.Set (Set)
+import Data.Set qualified as Set
 import Data.Tuple (swap)
 import Data.Wedge
 import Data.Word (Word32)
@@ -209,14 +209,15 @@ connectionStateToCounters state =
                                              <> inboundConn
                                             <> outboundConn
 
-      TerminatingState {}                   -> mempty
+      TerminatingState {}                   -> terminatingConn
       TerminatedState {}                    -> mempty
   where
-    fullDuplexConn     = ConnectionManagerCounters 1 0 0 0 0
-    duplexConn         = ConnectionManagerCounters 0 1 0 0 0
-    unidirectionalConn = ConnectionManagerCounters 0 0 1 0 0
-    inboundConn        = ConnectionManagerCounters 0 0 0 1 0
-    outboundConn       = ConnectionManagerCounters 0 0 0 0 1
+    fullDuplexConn     = ConnectionManagerCounters 1 0 0 0 0 0
+    duplexConn         = ConnectionManagerCounters 0 1 0 0 0 0
+    unidirectionalConn = ConnectionManagerCounters 0 0 1 0 0 0
+    inboundConn        = ConnectionManagerCounters 0 0 0 1 0 0
+    outboundConn       = ConnectionManagerCounters 0 0 0 0 1 0
+    terminatingConn    = ConnectionManagerCounters 0 0 0 0 0 1
 
 
 getConnThread :: ConnectionState peerAddr handle handleError version m
@@ -781,7 +782,8 @@ with args@Arguments {
                        else return [ ]
 
                   traverse_ (traceWith trTracer . TransitionTrace connStateId) trs
-                  traceCounters stateVar
+                  when (not $ List.null trs) $
+                    traceCounters stateVar
 
     -- Pruning is done in two stages:
     -- * an STM transaction which selects which connections to prune, and sets

ouroboros-network-framework/src/Ouroboros/Network/ConnectionManager/Types.hs

@@ -695,16 +695,17 @@ data ConnectionManagerCounters = ConnectionManagerCounters {
                                    --   (including DuplexState connections)
       unidirectionalConns :: !Int, -- ^ number of negotiated unidirectional connections
       inboundConns        :: !Int, -- ^ number of inbound connections
-      outboundConns       :: !Int  -- ^ number of outbound connections
+      outboundConns       :: !Int, -- ^ number of outbound connections
+      terminatingConns    :: !Int  -- ^ number of terminating connections
     }
   deriving (Show, Eq, Ord)
 
 instance Semigroup ConnectionManagerCounters where
-    ConnectionManagerCounters fd1 d1 s1 i1 o1 <> ConnectionManagerCounters fd2 d2 s2 i2 o2 =
-      ConnectionManagerCounters (fd1 + fd2) (d1 + d2) (s1 + s2) (i1 + i2) (o1 + o2)
+    ConnectionManagerCounters fd1 d1 s1 i1 o1 t1 <> ConnectionManagerCounters fd2 d2 s2 i2 o2 t2 =
+      ConnectionManagerCounters (fd1 + fd2) (d1 + d2) (s1 + s2) (i1 + i2) (o1 + o2) (t1 + t2)
 
 instance Monoid ConnectionManagerCounters where
-    mempty = ConnectionManagerCounters 0 0 0 0 0
+    mempty = ConnectionManagerCounters 0 0 0 0 0 0
 
 -- | Exceptions used by 'ConnectionManager'.
 --