Add metric for counting number of sessions stored (#62)

open-coap · Aug 21, 2024 · f8aa937 · f8aa937
1 parent 823b4b1
commit f8aa937
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/...c/main/kotlin/org/opencoap/ssl/transport/metrics/micrometer/DtlsServerMetricsCallbacks.kt b/...c/main/kotlin/org/opencoap/ssl/transport/metrics/micrometer/DtlsServerMetricsCallbacks.kt
@@ -48,6 +48,7 @@ class DtlsServerMetricsCallbacks(
     private val sessionsClosed = registry.counter("$metricsPrefix.sessions.closed")
     private val sessionsFailedBuilder = Counter.builder("$metricsPrefix.sessions.failed")
     private val sessionsExpired = registry.counter("$metricsPrefix.sessions.expired")
+    private val sessionsStored = registry.counter("$metricsPrefix.sessions.stored")
     private val sessionsReloaded = registry.counter("$metricsPrefix.sessions.reloaded")
     private val messagesDropped = registry.counter("$metricsPrefix.messages.dropped")
 
@@ -79,6 +80,8 @@ class DtlsServerMetricsCallbacks(
             sessionsClosed.increment()
         DtlsSessionLifecycleCallbacks.Reason.EXPIRED ->
             sessionsExpired.increment()
+        DtlsSessionLifecycleCallbacks.Reason.STORED ->
+            sessionsStored.increment()
         else -> {}
     }
 

diff --git a/kotlin-mbedtls/src/main/kotlin/org/opencoap/ssl/transport/DtlsServer.kt b/kotlin-mbedtls/src/main/kotlin/org/opencoap/ssl/transport/DtlsServer.kt
@@ -119,7 +119,10 @@ class DtlsServer(
     }
 
     fun closeSession(addr: InetSocketAddress) {
-        sessions.remove(addr)?.storeAndClose()
+        sessions.remove(addr)?.apply {
+            storeAndClose()
+            logger.info("[{}] [CID:{}] DTLS session was stored", peerAddress, (this as? DtlsSession)?.sessionContext?.cid?.toHex() ?: "na")
+        }
     }
 
     fun loadSession(sessBuf: SessionWithContext?, adr: InetSocketAddress, cid: ByteArray): Boolean {
@@ -267,11 +270,14 @@ class DtlsServer(
                         sessionStartTimestamp = sessionStartTimestamp
                     )
                     storeSession(ctx.ownCid, session)
+                    reportSessionFinished(DtlsSessionLifecycleCallbacks.Reason.STORED)
                 } catch (ex: Exception) {
                     logger.error("[{}] [CID:{}] DTLS failed to store session: {}", peerAddress, ownCidHex, ex.message)
+                    reportSessionFinished(DtlsSessionLifecycleCallbacks.Reason.FAILED, ex)
                 }
             } else {
                 close()
+                reportSessionFinished(DtlsSessionLifecycleCallbacks.Reason.CLOSED)
             }
         }
 
@@ -315,7 +321,7 @@ class DtlsServer(
             sessions.remove(peerAddress, this)
             storeAndClose()
             logger.info("[{}] [CID:{}] DTLS connection expired", peerAddress, ownCidHex)
-            lifecycleCallbacks.sessionFinished(peerAddress, DtlsSessionLifecycleCallbacks.Reason.EXPIRED)
+            reportSessionFinished(DtlsSessionLifecycleCallbacks.Reason.EXPIRED)
         }
 
         private val ownCidHex: String get() = ctx.ownCid?.toHex() ?: "na"

diff --git a/kotlin-mbedtls/src/main/kotlin/org/opencoap/ssl/transport/DtlsSessionLifecycleCallbacks.kt b/kotlin-mbedtls/src/main/kotlin/org/opencoap/ssl/transport/DtlsSessionLifecycleCallbacks.kt
@@ -24,7 +24,8 @@ interface DtlsSessionLifecycleCallbacks {
         SUCCEEDED,
         FAILED,
         CLOSED,
-        EXPIRED
+        EXPIRED,
+        STORED
     }
 
     fun handshakeStarted(adr: InetSocketAddress) = Unit

diff --git a/kotlin-mbedtls/src/test/kotlin/org/opencoap/ssl/transport/DtlsServerTransportTest.kt b/kotlin-mbedtls/src/test/kotlin/org/opencoap/ssl/transport/DtlsServerTransportTest.kt
@@ -353,6 +353,7 @@ class DtlsServerTransportTest {
         client.close()
 
         verify {
+            sslLifecycleCallbacks.sessionFinished(any(), DtlsSessionLifecycleCallbacks.Reason.STORED)
             sslLifecycleCallbacks.sessionFinished(any(), DtlsSessionLifecycleCallbacks.Reason.EXPIRED)
         }
     }
@@ -391,8 +392,10 @@ class DtlsServerTransportTest {
             sslLifecycleCallbacks.handshakeStarted(any())
             sslLifecycleCallbacks.handshakeFinished(any(), any(), any(), DtlsSessionLifecycleCallbacks.Reason.SUCCEEDED)
             sslLifecycleCallbacks.sessionStarted(any(), any(), false)
+            sslLifecycleCallbacks.sessionFinished(any(), DtlsSessionLifecycleCallbacks.Reason.STORED)
             sslLifecycleCallbacks.sessionFinished(any(), DtlsSessionLifecycleCallbacks.Reason.EXPIRED)
             sslLifecycleCallbacks.sessionStarted(any(), any(), true)
+            sslLifecycleCallbacks.sessionFinished(any(), DtlsSessionLifecycleCallbacks.Reason.STORED)
             sslLifecycleCallbacks.sessionFinished(any(), DtlsSessionLifecycleCallbacks.Reason.EXPIRED)
         }