vortexpy 4.3.13__tar.gz → 4.3.14__tar.gz

{vortexpy-4.3.13 → vortexpy-4.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortexpy
-Version: 4.3.13
+Version: 4.3.14
 Summary: Flying Ion's observable, routable, data serialisation and transport code.
 Author-email: Flying Ion Pty Ltd <contact@flyingion.com>
 License: MIT

{vortexpy-4.3.13 → vortexpy-4.3.14}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortexpy"
-version = "4.3.13"
+version = "4.3.14"
 license = {text = "MIT"}
 authors = [{name = "Flying Ion Pty Ltd", email = "contact@flyingion.com"}]
 description = "Flying Ion's observable, routable, data serialisation and transport code."

{vortexpy-4.3.13 → vortexpy-4.3.14}/vortex/__init__.py

@@ -6,4 +6,4 @@
 # Website : https://flyingion.com
 # Support : contact@flyingion.com
 
-__version__ = '4.3.13'
+__version__ = '4.3.14'

{vortexpy-4.3.13 → vortexpy-4.3.14}/vortex/twisted_runtime_metrics.py

@@ -146,13 +146,20 @@ class TwistedRuntimeMetrics:
     def snapshotAndResetWindow(cls) -> TwistedRuntimeMetricsSnapshot:
         return cls._collector()._snapshotAndResetWindow()
 
+    @classmethod
+    def snapshotWindow(cls) -> TwistedRuntimeMetricsSnapshot:
+        """Snapshot the current window counters without resetting them."""
+        return cls._collector()._snapshotWindow()
+
     def _start(self, reactorArg: Any) -> None:
         if self._started:
             return
         from twisted.internet.task import LoopingCall
 
         self._windowStartedMonotonic = time.monotonic()
-        self._nextExpectedMonotonic = time.monotonic() + REACTOR_LAG_TICK_SECONDS
+        self._nextExpectedMonotonic = (
+            time.monotonic() + REACTOR_LAG_TICK_SECONDS
+        )
         self._loop = LoopingCall(
             vortexLoopingCallCatchWithMetrics(logger)(self._tickReactorLag)
         )
@@ -185,9 +192,12 @@ class TwistedRuntimeMetrics:
         with self._metricsLock:
             self._loopingCallExceptionCount += 1
             methodCount = (
-                self._loopingCallExceptionCountByMethod.get(methodQualname, 0) + 1
+                self._loopingCallExceptionCountByMethod.get(methodQualname, 0)
+                + 1
+            )
+            self._loopingCallExceptionCountByMethod[methodQualname] = (
+                methodCount
             )
-            self._loopingCallExceptionCountByMethod[methodQualname] = methodCount
             self._loopingCallLastExceptionMethod = methodQualname
             self._loopingCallLastExceptionFrame = exceptionFrame
             longestCount = 0
@@ -276,6 +286,20 @@ class TwistedRuntimeMetrics:
             limitConcurrencyMostQueuedCount,
         )
 
+    def _snapshotWindow(self) -> TwistedRuntimeMetricsSnapshot:
+        from twisted.internet import reactor
+
+        pool = reactor.getThreadPool()  # type: ignore[attr-defined]  # pyright: ignore[reportAttributeAccessIssue]
+        threadPoolBusy = len(pool.working)
+        threadPoolQueued = len(pool.waiters)
+
+        with self._metricsLock:
+            return self._utilBuildSnapshotLocked(
+                pool,
+                threadPoolBusy,
+                threadPoolQueued,
+            )
+
     def _snapshotAndResetWindow(self) -> TwistedRuntimeMetricsSnapshot:
         from twisted.internet import reactor
 
@@ -284,64 +308,79 @@ class TwistedRuntimeMetrics:
         threadPoolQueued = len(pool.waiters)
 
         with self._metricsLock:
-            elapsedSeconds = time.monotonic() - self._windowStartedMonotonic
-            windowSeconds = int(max(1, round(elapsedSeconds)))
-            (
-                limitConcurrencyRunning,
-                limitConcurrencyQueued,
-                limitConcurrencyMax,
-                limitConcurrencyLimiterCount,
-                limitConcurrencySaturatedCount,
-                limitConcurrencyMostQueuedMethod,
-                limitConcurrencyMostQueuedCount,
-            ) = self._snapshotLimitConcurrencyStateLocked()
-            snapshot = TwistedRuntimeMetricsSnapshot(
-                threadPoolBusy=threadPoolBusy,
-                threadPoolQueued=threadPoolQueued,
-                threadPoolMax=pool.max,
-                threadedCallCount=self._threadedCallCount,
-                longestThreadedMethodName=self._longestThreadedMethodName,
-                longestThreadedMethodMs=self._longestThreadedMethodMs,
-                longestThreadedMethodFrame=self._longestThreadedMethodFrame,
-                longestReactorBlockMs=self._longestReactorBlockMs,
-                longestReactorBlockFrame=self._longestReactorBlockFrame,
-                loopingCallExceptionCount=self._loopingCallExceptionCount,
-                loopingCallLongestExceptionMethod=(
-                    self._loopingCallLongestExceptionMethod
-                ),
-                loopingCallLastExceptionMethod=(self._loopingCallLastExceptionMethod),
-                loopingCallLastExceptionFrame=(self._loopingCallLastExceptionFrame),
-                limitConcurrencyRunning=limitConcurrencyRunning,
-                limitConcurrencyQueued=limitConcurrencyQueued,
-                limitConcurrencyMax=limitConcurrencyMax,
-                limitConcurrencyLimiterCount=limitConcurrencyLimiterCount,
-                limitConcurrencySaturatedCount=limitConcurrencySaturatedCount,
-                limitConcurrencyCallCount=self._limitConcurrencyCallCount,
-                limitConcurrencyCallTimeoutCount=(
-                    self._limitConcurrencyCallTimeoutCount
-                ),
-                limitConcurrencyLastCallTimeoutMethodName=(
-                    self._limitConcurrencyLastCallTimeoutMethodName
-                ),
-                longestLimitConcurrencyMethodName=(
-                    self._longestLimitConcurrencyMethodName
-                ),
-                longestLimitConcurrencyMethodMs=(
-                    self._longestLimitConcurrencyMethodMs
-                ),
-                longestLimitConcurrencyQueueWaitMs=(
-                    self._longestLimitConcurrencyQueueWaitMs
-                ),
-                longestLimitConcurrencyQueueWaitMethod=(
-                    self._longestLimitConcurrencyQueueWaitMethod
-                ),
-                limitConcurrencyMostQueuedMethod=limitConcurrencyMostQueuedMethod,
-                limitConcurrencyMostQueuedCount=limitConcurrencyMostQueuedCount,
-                windowSeconds=windowSeconds,
+            snapshot = self._utilBuildSnapshotLocked(
+                pool,
+                threadPoolBusy,
+                threadPoolQueued,
             )
             self._resetWindowCountersLocked()
             return snapshot
 
+    def _utilBuildSnapshotLocked(
+        self,
+        pool: Any,
+        threadPoolBusy: int,
+        threadPoolQueued: int,
+    ) -> TwistedRuntimeMetricsSnapshot:
+        """Build one snapshot from current counters; caller holds the lock."""
+        elapsedSeconds = time.monotonic() - self._windowStartedMonotonic
+        windowSeconds = int(max(1, round(elapsedSeconds)))
+        (
+            limitConcurrencyRunning,
+            limitConcurrencyQueued,
+            limitConcurrencyMax,
+            limitConcurrencyLimiterCount,
+            limitConcurrencySaturatedCount,
+            limitConcurrencyMostQueuedMethod,
+            limitConcurrencyMostQueuedCount,
+        ) = self._snapshotLimitConcurrencyStateLocked()
+        return TwistedRuntimeMetricsSnapshot(
+            threadPoolBusy=threadPoolBusy,
+            threadPoolQueued=threadPoolQueued,
+            threadPoolMax=pool.max,
+            threadedCallCount=self._threadedCallCount,
+            longestThreadedMethodName=self._longestThreadedMethodName,
+            longestThreadedMethodMs=self._longestThreadedMethodMs,
+            longestThreadedMethodFrame=self._longestThreadedMethodFrame,
+            longestReactorBlockMs=self._longestReactorBlockMs,
+            longestReactorBlockFrame=self._longestReactorBlockFrame,
+            loopingCallExceptionCount=self._loopingCallExceptionCount,
+            loopingCallLongestExceptionMethod=(
+                self._loopingCallLongestExceptionMethod
+            ),
+            loopingCallLastExceptionMethod=(
+                self._loopingCallLastExceptionMethod
+            ),
+            loopingCallLastExceptionFrame=(self._loopingCallLastExceptionFrame),
+            limitConcurrencyRunning=limitConcurrencyRunning,
+            limitConcurrencyQueued=limitConcurrencyQueued,
+            limitConcurrencyMax=limitConcurrencyMax,
+            limitConcurrencyLimiterCount=limitConcurrencyLimiterCount,
+            limitConcurrencySaturatedCount=limitConcurrencySaturatedCount,
+            limitConcurrencyCallCount=self._limitConcurrencyCallCount,
+            limitConcurrencyCallTimeoutCount=(
+                self._limitConcurrencyCallTimeoutCount
+            ),
+            limitConcurrencyLastCallTimeoutMethodName=(
+                self._limitConcurrencyLastCallTimeoutMethodName
+            ),
+            longestLimitConcurrencyMethodName=(
+                self._longestLimitConcurrencyMethodName
+            ),
+            longestLimitConcurrencyMethodMs=(
+                self._longestLimitConcurrencyMethodMs
+            ),
+            longestLimitConcurrencyQueueWaitMs=(
+                self._longestLimitConcurrencyQueueWaitMs
+            ),
+            longestLimitConcurrencyQueueWaitMethod=(
+                self._longestLimitConcurrencyQueueWaitMethod
+            ),
+            limitConcurrencyMostQueuedMethod=limitConcurrencyMostQueuedMethod,
+            limitConcurrencyMostQueuedCount=limitConcurrencyMostQueuedCount,
+            windowSeconds=windowSeconds,
+        )
+
     def _tickReactorLag(self) -> None:
         now = time.monotonic()
         lagMs = (now - self._nextExpectedMonotonic) * 1000.0
@@ -394,7 +433,9 @@ class TwistedRuntimeMetrics:
         if frame is None:
             return None
         for summary in reversed(traceback.extract_stack(frame)):
-            if TwistedRuntimeMetrics._utilSkipInternalMetricsFrame(summary.filename):
+            if TwistedRuntimeMetrics._utilSkipInternalMetricsFrame(
+                summary.filename
+            ):
                 continue
             return f"{summary.filename}:{summary.name}:{summary.lineno}"
         return None
@@ -402,7 +443,9 @@ class TwistedRuntimeMetrics:
     @staticmethod
     def _captureWorkerThreadFrame() -> str | None:
         for summary in reversed(traceback.extract_stack()):
-            if TwistedRuntimeMetrics._utilSkipInternalMetricsFrame(summary.filename):
+            if TwistedRuntimeMetrics._utilSkipInternalMetricsFrame(
+                summary.filename
+            ):
                 continue
             return f"{summary.filename}:{summary.name}:{summary.lineno}"
         return None
@@ -413,7 +456,9 @@ class TwistedRuntimeMetrics:
         if excTraceback is None:
             return None
         for summary in reversed(traceback.extract_tb(excTraceback)):
-            if TwistedRuntimeMetrics._utilSkipInternalMetricsFrame(summary.filename):
+            if TwistedRuntimeMetrics._utilSkipInternalMetricsFrame(
+                summary.filename
+            ):
                 continue
             return f"{summary.filename}:{summary.name}:{summary.lineno}"
         return None

{vortexpy-4.3.13 → vortexpy-4.3.14}/vortex/twisted_runtime_metrics_test.py

@@ -10,11 +10,11 @@ from typing import Any
 import pytest
 from twisted.internet.defer import Deferred, fail, succeed
 
-from vortex.VortexUtil import limitConcurrency
 from vortex.twisted_runtime_metrics import (
     TwistedRuntimeMetrics,
     vortexLoopingCallCatchWithMetrics,
 )
+from vortex.VortexUtil import limitConcurrency
 
 logger = logging.getLogger(__name__)
 
@@ -46,7 +46,9 @@ def testRecordThreadedCallTracksCountAndLongestMethod() -> None:
     collector._recordThreadedCall("slow.Method", 100.0)
     collector._recordThreadedCall("slower.Method", 250.5, "slow.py:run:10")
     snapshot = TwistedRuntimeMetrics.snapshotAndResetWindow()
-    assert snapshot.threadedCallCount == 2, "both threaded calls must count in window"
+    assert snapshot.threadedCallCount == 2, (
+        "both threaded calls must count in window"
+    )
     assert snapshot.longestThreadedMethodName == "slower.Method", (
         "longest name must be the slowest call"
     )
@@ -56,18 +58,39 @@ def testRecordThreadedCallTracksCountAndLongestMethod() -> None:
     assert snapshot.longestThreadedMethodFrame == "slow.py:run:10", (
         "slow-call frame must be preserved"
     )
-    assert snapshot.windowSeconds >= 1, "snapshot must report elapsed window seconds"
+    assert snapshot.windowSeconds >= 1, (
+        "snapshot must report elapsed window seconds"
+    )
+
+
+def testSnapshotWindowDoesNotResetCounters() -> None:
+    TwistedRuntimeMetrics._collector()._recordThreadedCall("one.Method", 50.0)
+    firstSnapshot = TwistedRuntimeMetrics.snapshotWindow()
+    secondSnapshot = TwistedRuntimeMetrics.snapshotWindow()
+    assert firstSnapshot.threadedCallCount == 1, (
+        "first snapshot includes recorded call"
+    )
+    assert secondSnapshot.threadedCallCount == 1, (
+        "read-only snapshot must leave window counters intact"
+    )
+    assert secondSnapshot.longestThreadedMethodMs == 50.0, (
+        "read-only snapshot must preserve longest threaded method"
+    )
 
 
 def testSnapshotResetsWindowCounters() -> None:
     TwistedRuntimeMetrics._collector()._recordThreadedCall("one.Method", 50.0)
     firstSnapshot = TwistedRuntimeMetrics.snapshotAndResetWindow()
     secondSnapshot = TwistedRuntimeMetrics.snapshotAndResetWindow()
-    assert firstSnapshot.threadedCallCount == 1, "first snapshot includes recorded call"
+    assert firstSnapshot.threadedCallCount == 1, (
+        "first snapshot includes recorded call"
+    )
     assert firstSnapshot.longestThreadedMethodMs == 50.0, (
         "first snapshot longest ms must match recorded call"
     )
-    assert secondSnapshot.threadedCallCount == 0, "window counters reset after snapshot"
+    assert secondSnapshot.threadedCallCount == 0, (
+        "window counters reset after snapshot"
+    )
     assert secondSnapshot.longestThreadedMethodMs == 0.0, (
         "longest ms resets to zero after snapshot"
     )
@@ -96,7 +119,9 @@ def testLoopingCallLongestExceptionMethodUsesHighestCount() -> None:
     collector._recordLoopingCallException("noisyTick", "a.py:2")
     collector._recordLoopingCallException("quietTick", "b.py:1")
     snapshot = TwistedRuntimeMetrics.snapshotAndResetWindow()
-    assert snapshot.loopingCallExceptionCount == 3, "three exceptions must be counted"
+    assert snapshot.loopingCallExceptionCount == 3, (
+        "three exceptions must be counted"
+    )
     assert snapshot.loopingCallLongestExceptionMethod == "noisyTick", (
         "longest method is highest per-method exception count"
     )
@@ -191,9 +216,9 @@ def testLoopingCallCatchWithMetricsRecordsDeferredFailure() -> None:
     assert snapshot.loopingCallExceptionCount == 1, (
         "deferred tick failure must increment exception count"
     )
-    assert snapshot.loopingCallLongestExceptionMethod == "failingDeferredTick", (
-        "deferred failure must set longest exception method"
-    )
+    assert (
+        snapshot.loopingCallLongestExceptionMethod == "failingDeferredTick"
+    ), "deferred failure must set longest exception method"
     assert snapshot.loopingCallLastExceptionMethod == "failingDeferredTick", (
         "deferred failure must set last exception method"
     )

{vortexpy-4.3.13 → vortexpy-4.3.14}/vortexpy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vortexpy
-Version: 4.3.13
+Version: 4.3.14
 Summary: Flying Ion's observable, routable, data serialisation and transport code.
 Author-email: Flying Ion Pty Ltd <contact@flyingion.com>
 License: MIT