Publicise the mbean traits

build.sbt

@@ -676,7 +676,25 @@ lazy val core = crossProject(JSPlatform, JVMPlatform, NativePlatform)
         "cats.effect.unsafe.IORuntimeBuilder.this"),
       // introduced by #3695, which enabled fiber dumps on native
       ProblemFilters.exclude[MissingClassProblem](
-        "cats.effect.unsafe.FiberMonitorCompanionPlatform")
+        "cats.effect.unsafe.FiberMonitorCompanionPlatform"),
+      // introduced by #3813, which moved metrics to unsafe.metrics
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvation"),
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvation$"),
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvationMBean"),
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvationMetrics"),
+      ProblemFilters.exclude[MissingClassProblem](
+        "cats.effect.metrics.JvmCpuStarvationMetrics"),
+      ProblemFilters.exclude[MissingClassProblem](
+        "cats.effect.metrics.JvmCpuStarvationMetrics$"),
+      ProblemFilters.exclude[MissingClassProblem](
+        "cats.effect.metrics.JvmCpuStarvationMetrics$NoOpCpuStarvationMetrics"),
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.JsCpuStarvationMetrics"),
+      ProblemFilters.exclude[MissingClassProblem](
+        "cats.effect.metrics.JsCpuStarvationMetrics$"),
+      ProblemFilters.exclude[MissingClassProblem](
+        "cats.effect.metrics.NativeCpuStarvationMetrics"),
+      ProblemFilters.exclude[MissingClassProblem](
+        "cats.effect.metrics.NativeCpuStarvationMetrics$")
     ) ++ {
       if (tlIsScala3.value) {
         // Scala 3 specific exclusions

core/js/src/main/scala/cats/effect/IOApp.scala

@@ -16,9 +16,10 @@
 
 package cats.effect
 
-import cats.effect.metrics.{CpuStarvationWarningMetrics, JsCpuStarvationMetrics}
+import cats.effect.metrics.CpuStarvationWarningMetrics
 import cats.effect.std.Console
 import cats.effect.tracing.TracingConstants._
+import cats.effect.unsafe.metrics.JsCpuStarvationMetrics
 
 import scala.concurrent.CancellationException
 import scala.concurrent.duration._

core/js/src/main/scala/cats/effect/metrics/JsCpuStarvationMetrics.scala → core/js/src/main/scala/cats/effect/unsafe/metrics/JsCpuStarvationMetrics.scala

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 import cats.effect.IO
 

core/jvm/src/main/scala/cats/effect/IOApp.scala

@@ -16,9 +16,10 @@
 
 package cats.effect
 
-import cats.effect.metrics.{CpuStarvationWarningMetrics, JvmCpuStarvationMetrics}
+import cats.effect.metrics.CpuStarvationWarningMetrics
 import cats.effect.std.Console
 import cats.effect.tracing.TracingConstants._
+import cats.effect.unsafe.metrics.JvmCpuStarvationMetrics
 import cats.syntax.all._
 
 import scala.concurrent.{blocking, CancellationException, ExecutionContext}

core/jvm/src/main/scala/cats/effect/unsafe/IORuntimeCompanionPlatform.scala

@@ -104,11 +104,10 @@ private[unsafe] abstract class IORuntimeCompanionPlatform { this: IORuntime.type
         if (mBeanServer ne null) {
           val registeredMBeans = mutable.Set.empty[ObjectName]
 
-          val hash = System.identityHashCode(threadPool).toHexString
-
           try {
+            val cpsId = ComputePoolSampler.counter.getAndIncrement()
             val computePoolSamplerName = new ObjectName(
-              s"cats.effect.unsafe.metrics:type=ComputePoolSampler-$hash")
+              s"cats.effect.unsafe.metrics:type=ComputePoolSampler-${cpsId}")
             val computePoolSampler = new ComputePoolSampler(threadPool)
             mBeanServer.registerMBean(computePoolSampler, computePoolSamplerName)
             registeredMBeans += computePoolSamplerName
@@ -119,13 +118,14 @@ private[unsafe] abstract class IORuntimeCompanionPlatform { this: IORuntime.type
           val localQueues = threadPool.localQueues
           var i = 0
           val len = localQueues.length
+          val lqsId = LocalQueueSampler.counter.getAndIncrement()
 
           while (i < len) {
             val localQueue = localQueues(i)
 
             try {
               val localQueueSamplerName = new ObjectName(
-                s"cats.effect.unsafe.metrics:type=LocalQueueSampler-$hash-$i")
+                s"cats.effect.unsafe.metrics:type=LocalQueueSampler-${lqsId}-$i")
               val localQueueSampler = new LocalQueueSampler(localQueue)
               mBeanServer.registerMBean(localQueueSampler, localQueueSamplerName)
               registeredMBeans += localQueueSamplerName
@@ -262,11 +262,10 @@ private[unsafe] abstract class IORuntimeCompanionPlatform { this: IORuntime.type
         }
 
       if (mBeanServer ne null) {
-        val hash = System.identityHashCode(fiberMonitor).toHexString
-
         try {
+          val mbeanId = LiveFiberSnapshotTrigger.counter.getAndIncrement()
           val liveFiberSnapshotTriggerName = new ObjectName(
-            s"cats.effect.unsafe.metrics:type=LiveFiberSnapshotTrigger-$hash")
+            s"cats.effect.unsafe.metrics:type=LiveFiberSnapshotTrigger-${mbeanId}")
           val liveFiberSnapshotTrigger = new LiveFiberSnapshotTrigger(fiberMonitor)
           mBeanServer.registerMBean(liveFiberSnapshotTrigger, liveFiberSnapshotTriggerName)
 

core/jvm/src/main/scala/cats/effect/unsafe/metrics/ComputePoolSampler.scala

@@ -17,6 +17,8 @@
 package cats.effect.unsafe
 package metrics
 
+import java.util.concurrent.atomic.AtomicLong
+
 /**
  * An implementation of the [[ComputePoolSamplerMBean]] interface which simply delegates to the
  * corresponding methods of the [[cats.effect.unsafe.WorkStealingThreadPool]] being monitored.
@@ -25,11 +27,15 @@ package metrics
  *   the monitored compute work stealing thread pool
  */
 private[unsafe] final class ComputePoolSampler(compute: WorkStealingThreadPool[_])
-    extends ComputePoolSamplerMBean {
+    extends UnsealedComputePoolSamplerMBean {
   def getWorkerThreadCount(): Int = compute.getWorkerThreadCount()
   def getActiveThreadCount(): Int = compute.getActiveThreadCount()
   def getSearchingThreadCount(): Int = compute.getSearchingThreadCount()
   def getBlockedWorkerThreadCount(): Int = compute.getBlockedWorkerThreadCount()
   def getLocalQueueFiberCount(): Long = compute.getLocalQueueFiberCount()
   def getSuspendedFiberCount(): Long = compute.getSuspendedFiberCount()
 }
+
+private[unsafe] object ComputePoolSampler {
+  val counter: AtomicLong = new AtomicLong(0)
+}

core/jvm/src/main/scala/cats/effect/unsafe/metrics/ComputePoolSamplerMBean.scala

@@ -17,15 +17,15 @@
 package cats.effect.unsafe.metrics
 
 /**
- * An MBean interface for monitoring a [[WorkStealingThreadPool]] backed compute thread pool.
+ * An MBean interface for monitoring a `WorkStealingThreadPool` backed compute thread pool.
  */
-private[unsafe] trait ComputePoolSamplerMBean {
+sealed trait ComputePoolSamplerMBean {
 
   /**
-   * Returns the number of [[WorkerThread]] instances backing the [[WorkStealingThreadPool]].
+   * Returns the number of `WorkerThread` instances backing the `WorkStealingThreadPool`.
    *
    * @note
-   *   This is a fixed value, as the [[WorkStealingThreadPool]] has a fixed number of worker
+   *   This is a fixed value, as the `WorkStealingThreadPool` has a fixed number of worker
    *   threads.
    *
    * @return
@@ -34,7 +34,7 @@ private[unsafe] trait ComputePoolSamplerMBean {
   def getWorkerThreadCount(): Int
 
   /**
-   * Returns the number of active [[WorkerThread]] instances currently executing fibers on the
+   * Returns the number of active `WorkerThread` instances currently executing fibers on the
    * compute thread pool.
    *
    * @return
@@ -43,16 +43,16 @@ private[unsafe] trait ComputePoolSamplerMBean {
   def getActiveThreadCount(): Int
 
   /**
-   * Returns the number of [[WorkerThread]] instances currently searching for fibers to steal
-   * from other worker threads.
+   * Returns the number of `WorkerThread` instances currently searching for fibers to steal from
+   * other worker threads.
    *
    * @return
    *   the number of worker threads searching for work
    */
   def getSearchingThreadCount(): Int
 
   /**
-   * Returns the number of [[WorkerThread]] instances which are currently blocked due to running
+   * Returns the number of `WorkerThread` instances which are currently blocked due to running
    * blocking actions on the compute thread pool.
    *
    * @return
@@ -76,3 +76,5 @@ private[unsafe] trait ComputePoolSamplerMBean {
    */
   def getSuspendedFiberCount(): Long
 }
+
+private[unsafe] trait UnsealedComputePoolSamplerMBean extends ComputePoolSamplerMBean

core/jvm/src/main/scala/cats/effect/metrics/CpuStarvation.scala → core/jvm/src/main/scala/cats/effect/unsafe/metrics/CpuStarvation.scala

@@ -14,19 +14,19 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 import cats.effect.IO
 
 import scala.concurrent.duration.FiniteDuration
 
 import java.util.concurrent.atomic.AtomicLong
 
-private[metrics] class CpuStarvation private (
+private[unsafe] class CpuStarvation private (
     counter: AtomicLong,
     currentClockDrift: AtomicLong,
     maxClockDrift: AtomicLong)
-    extends CpuStarvationMBean {
+    extends UnsealedCpuStarvationMBean {
 
   override def getCpuStarvationCount(): Long = counter.get()
 
@@ -48,8 +48,8 @@ private[metrics] class CpuStarvation private (
 
 }
 
-private[metrics] object CpuStarvation {
-  private[metrics] def apply(): IO[CpuStarvation] = for {
+private[unsafe] object CpuStarvation {
+  private[unsafe] def apply(): IO[CpuStarvation] = for {
     counter <- IO.delay(new AtomicLong(0))
     currentClockDrift <- IO.delay(new AtomicLong(0))
     maxClockDrift <- IO.delay(new AtomicLong(0))

core/jvm/src/main/scala/cats/effect/metrics/CpuStarvationMbean.scala → core/jvm/src/main/scala/cats/effect/unsafe/metrics/CpuStarvationMbean.scala

@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 /**
  * An MBean interfaces for monitoring when CPU starvation occurs.
  */
-private[metrics] trait CpuStarvationMBean {
+sealed trait CpuStarvationMBean {
 
   /**
    * Returns the number of times CPU starvation has occurred.
@@ -45,3 +45,5 @@ private[metrics] trait CpuStarvationMBean {
    */
   def getCurrentClockDriftMs(): Long
 }
+
+private[unsafe] trait UnsealedCpuStarvationMBean extends CpuStarvationMBean

core/jvm/src/main/scala/cats/effect/metrics/JvmCpuStarvationMetrics.scala → core/jvm/src/main/scala/cats/effect/unsafe/metrics/JvmCpuStarvationMetrics.scala

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 import cats.effect.{IO, Resource}
 import cats.effect.std.Console

core/jvm/src/main/scala/cats/effect/unsafe/metrics/LiveFiberSnapshotTrigger.scala

@@ -19,6 +19,8 @@ package metrics
 
 import scala.collection.mutable.ArrayBuffer
 
+import java.util.concurrent.atomic.AtomicLong
+
 /**
  * An implementation of the [[LiveFiberSnapshotTriggerMBean]] interface which simply delegates
  * to the corresponding method of the backing [[cats.effect.unsafe.FiberMonitor]].
@@ -27,10 +29,14 @@ import scala.collection.mutable.ArrayBuffer
  *   the backing fiber monitor
  */
 private[unsafe] final class LiveFiberSnapshotTrigger(monitor: FiberMonitor)
-    extends LiveFiberSnapshotTriggerMBean {
+    extends UnsealedLiveFiberSnapshotTriggerMBean {
   def liveFiberSnapshot(): Array[String] = {
     val buffer = new ArrayBuffer[String]
     monitor.liveFiberSnapshot(buffer += _)
     buffer.toArray
   }
 }
+
+private[unsafe] object LiveFiberSnapshotTrigger {
+  val counter: AtomicLong = new AtomicLong(0)
+}

core/jvm/src/main/scala/cats/effect/unsafe/metrics/LiveFiberSnapshotTriggerMBean.scala

@@ -19,7 +19,7 @@ package cats.effect.unsafe.metrics
 /**
  * An MBean interface for triggering live fiber snapshots.
  */
-private[unsafe] trait LiveFiberSnapshotTriggerMBean {
+sealed trait LiveFiberSnapshotTriggerMBean {
 
   /**
    * Obtains a snapshot of the fibers currently live on the [[IORuntime]] which this fiber
@@ -30,3 +30,6 @@ private[unsafe] trait LiveFiberSnapshotTriggerMBean {
    */
   def liveFiberSnapshot(): Array[String]
 }
+
+private[unsafe] trait UnsealedLiveFiberSnapshotTriggerMBean
+    extends LiveFiberSnapshotTriggerMBean

core/jvm/src/main/scala/cats/effect/unsafe/metrics/LocalQueueSampler.scala

@@ -17,6 +17,8 @@
 package cats.effect.unsafe
 package metrics
 
+import java.util.concurrent.atomic.AtomicLong
+
 /**
  * An implementation of the [[LocalQueueSamplerMBean]] interface which simply delegates to the
  * corresponding methods of the [[cats.effect.unsafe.LocalQueue]] being monitored.
@@ -25,7 +27,7 @@ package metrics
  *   the monitored local queue
  */
 private[unsafe] final class LocalQueueSampler(queue: LocalQueue)
-    extends LocalQueueSamplerMBean {
+    extends UnsealedLocalQueueSamplerMBean {
   def getFiberCount(): Int = queue.getFiberCount()
   def getHeadIndex(): Int = queue.getHeadIndex()
   def getTailIndex(): Int = queue.getTailIndex()
@@ -37,3 +39,7 @@ private[unsafe] final class LocalQueueSampler(queue: LocalQueue)
   def getStealHeadTag(): Int = queue.getStealHeadTag()
   def getTailTag(): Int = queue.getTailTag()
 }
+
+private[unsafe] object LocalQueueSampler {
+  val counter: AtomicLong = new AtomicLong(0)
+}