Move IORuntimeMetrics to cats.effect.unsafe.metrics package

iRevive · Jul 31, 2024 · c66b328 · c66b328
1 parent ce1fa92
commit c66b328
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 18 deletions.
diff --git a/build.sbt b/build.sbt
@@ -679,7 +679,12 @@ lazy val core = crossProject(JSPlatform, JVMPlatform, NativePlatform)
         "cats.effect.unsafe.FiberMonitorCompanionPlatform"),
       // internal API change, makes CpuStarvationMetrics available on all platforms
       ProblemFilters.exclude[MissingClassProblem](
-        "cats.effect.metrics.JvmCpuStarvationMetrics$NoOpCpuStarvationMetrics")
+        "cats.effect.metrics.JvmCpuStarvationMetrics$NoOpCpuStarvationMetrics"),
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvationMetrics"),
+      // package-private classes moved to the `cats.effect.unsafe.metrics` package
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvation"),
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvation$"),
+      ProblemFilters.exclude[MissingClassProblem]("cats.effect.metrics.CpuStarvationMBean")
     ) ++ {
       if (tlIsScala3.value) {
         // Scala 3 specific exclusions

diff --git a/...s/IORuntimeMetricsCompanionPlatform.scala → ...s/IORuntimeMetricsCompanionPlatform.scala b/...s/IORuntimeMetricsCompanionPlatform.scala → ...s/IORuntimeMetricsCompanionPlatform.scala
@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 private[metrics] abstract class IORuntimeMetricsCompanionPlatform {
   this: IORuntimeMetrics.type =>
 
-  private[effect] def apply(): IORuntimeMetrics =
+  private[unsafe] def apply(): IORuntimeMetrics =
     new IORuntimeMetrics {
       private[effect] val cpuStarvationSampler: CpuStarvationSampler =
         CpuStarvationSampler()

diff --git a/...ct/metrics/IORuntimeMetricsPlatform.scala → ...fe/metrics/IORuntimeMetricsPlatform.scala b/...ct/metrics/IORuntimeMetricsPlatform.scala → ...fe/metrics/IORuntimeMetricsPlatform.scala
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 private[metrics] trait IORuntimeMetricsPlatform { this: IORuntimeMetrics => }
diff --git a/core/jvm/src/main/scala/cats/effect/metrics/JvmCpuStarvationMetrics.scala b/core/jvm/src/main/scala/cats/effect/metrics/JvmCpuStarvationMetrics.scala
@@ -18,6 +18,7 @@ package cats.effect.metrics
 
 import cats.effect.{IO, Resource}
 import cats.effect.std.Console
+import cats.effect.unsafe.metrics.{CpuStarvation, CpuStarvationSampler}
 import cats.syntax.functor._
 
 import java.io.{PrintWriter, StringWriter}

diff --git a/...a/cats/effect/metrics/CpuStarvation.scala → ...effect/unsafe/metrics/CpuStarvation.scala b/...a/cats/effect/metrics/CpuStarvation.scala → ...effect/unsafe/metrics/CpuStarvation.scala
@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
+
+private[effect] final class CpuStarvation(
+    sampler: CpuStarvationSampler
+) extends CpuStarvationMBean {
 
-private final class CpuStarvation(sampler: CpuStarvationSampler) extends CpuStarvationMBean {
   def getCpuStarvationCount(): Long =
     sampler.cpuStarvationCount()
 
@@ -26,5 +29,3 @@ private final class CpuStarvation(sampler: CpuStarvationSampler) extends CpuStar
   def getCurrentClockDriftMs(): Long =
     sampler.clockDriftCurrentMs()
 }
-
-private object CpuStarvation
diff --git a/...s/effect/metrics/CpuStarvationMbean.scala → ...t/unsafe/metrics/CpuStarvationMBean.scala b/...s/effect/metrics/CpuStarvationMbean.scala → ...t/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 {
+private[unsafe] trait CpuStarvationMBean {
 
   /**
    * Returns the number of times CPU starvation has occurred.

diff --git a/...s/IORuntimeMetricsCompanionPlatform.scala → ...s/IORuntimeMetricsCompanionPlatform.scala b/...s/IORuntimeMetricsCompanionPlatform.scala → ...s/IORuntimeMetricsCompanionPlatform.scala
@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 private[metrics] abstract class IORuntimeMetricsCompanionPlatform {
   this: IORuntimeMetrics.type =>
 
-  private[effect] def apply(): IORuntimeMetrics =
+  private[unsafe] def apply(): IORuntimeMetrics =
     new IORuntimeMetrics {
       private[effect] val cpuStarvationSampler: CpuStarvationSampler =
         CpuStarvationSampler()

diff --git a/...ct/metrics/IORuntimeMetricsPlatform.scala → ...fe/metrics/IORuntimeMetricsPlatform.scala b/...ct/metrics/IORuntimeMetricsPlatform.scala → ...fe/metrics/IORuntimeMetricsPlatform.scala
@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 private[metrics] trait IORuntimeMetricsPlatform { this: IORuntimeMetrics => }
diff --git a/core/shared/src/main/scala/cats/effect/CpuStarvationCheck.scala b/core/shared/src/main/scala/cats/effect/CpuStarvationCheck.scala
@@ -16,9 +16,10 @@
 
 package cats.effect
 
-import cats.effect.metrics.{CpuStarvationSampler, CpuStarvationWarningMetrics}
+import cats.effect.metrics.CpuStarvationWarningMetrics
 import cats.effect.std.Console
 import cats.effect.unsafe.IORuntimeConfig
+import cats.effect.unsafe.metrics.CpuStarvationSampler
 import cats.syntax.all._
 
 import scala.concurrent.duration.{Duration, FiniteDuration}

diff --git a/core/shared/src/main/scala/cats/effect/unsafe/IORuntime.scala b/core/shared/src/main/scala/cats/effect/unsafe/IORuntime.scala
@@ -18,7 +18,7 @@ package cats.effect
 package unsafe
 
 import cats.effect.Platform.static
-import cats.effect.metrics.IORuntimeMetrics
+import cats.effect.unsafe.metrics.IORuntimeMetrics
 
 import scala.concurrent.ExecutionContext
 

diff --git a/...effect/metrics/CpuStarvationMetrics.scala → ...unsafe/metrics/CpuStarvationMetrics.scala b/...effect/metrics/CpuStarvationMetrics.scala → ...unsafe/metrics/CpuStarvationMetrics.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 import scala.concurrent.duration._
 

diff --git a/...effect/metrics/CpuStarvationSampler.scala → ...unsafe/metrics/CpuStarvationSampler.scala b/...effect/metrics/CpuStarvationSampler.scala → ...unsafe/metrics/CpuStarvationSampler.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 import cats.effect.IO
 

diff --git a/...ats/effect/metrics/IORuntimeMetrics.scala → ...ect/unsafe/metrics/IORuntimeMetrics.scala b/...ats/effect/metrics/IORuntimeMetrics.scala → ...ect/unsafe/metrics/IORuntimeMetrics.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package cats.effect.metrics
+package cats.effect.unsafe.metrics
 
 /**
  * The runtime-specific metrics.