feat: replacing micrometer with metrics (#112)

Author: Frnd-me

build.gradle.kts

@@ -44,12 +44,7 @@ dependencies {
 
   implementation("io.github.microutils:kotlin-logging:3.0.5")
   implementation("org.slf4j:slf4j-jdk14:2.0.12")
-  implementation("io.micrometer:micrometer-core:1.17.0-M1")
-  implementation("io.micrometer:micrometer-registry-influx:1.17.0-M1")
-  implementation("io.micrometer:micrometer-tracing:1.7.0-M1")
-  implementation("io.micrometer:micrometer-tracing-bridge-otel:1.7.0-M1")
-  implementation("io.opentelemetry:opentelemetry-exporter-zipkin:1.58.0")
-  implementation("io.opentelemetry.semconv:opentelemetry-semconv:1.39.0")
+  implementation("io.dropwizard.metrics5:metrics-core:5.0.6")
 
   implementation("org.pkl-lang:pkl-config-java:0.30.2")
   implementation("org.pkl-lang:pkl-codegen-java:0.30.2")

metrics/.gitkeep

@@ -15,11 +15,7 @@ class Cirrina {
     logger.info { "cirrina version ${getBuildVersion()}" }
     logger.info { component.identifier() }
 
-    runCatching {
-        component.persistentContext().use { _ -> component.runtime().run() }
-
-        component.meterRegistry().close()
-      }
+    runCatching { component.persistentContext().use { _ -> component.runtime().run() } }
       .onFailure { ex -> logger.error(ex) { "a fatal error occurred during runtime execution" } }
   }
 

src/main/kotlin/at/ac/uibk/dps/cirrina/Cirrina.kt

@@ -24,14 +24,8 @@ object EnvironmentVariables {
   val zenohEventHandlerConfigUri =
     EnvironmentVariable<String?>("ZENOH_EVENT_HANDLER_CONFIG_URI", null)
 
-  val influxMetricUrl = EnvironmentVariable<String?>("INFLUX_METRIC_URL", null)
-
-  val influxMetricOrg = EnvironmentVariable("INFLUX_METRIC_ORG", "org")
-  val influxMetricBucket = EnvironmentVariable("INFLUX_METRIC_BUCKET", "bucket")
-  val influxMetricToken = EnvironmentVariable("INFLUX_METRIC_TOKEN", "bzO10KmR8x")
-  val influxMetricStep = EnvironmentVariable("INFLUX_METRIC_STEP", 5000L, { it.toLong() })
-
-  val zipkinTraceUrl = EnvironmentVariable<String?>("ZIPKIN_TRACE_URL", null)
+  val metricsDirectory = EnvironmentVariable("METRICS_DIRECTORY", "metrics")
+  val metricsPeriod = EnvironmentVariable("METRICS_PERIOD", 1L)
 
   val mainUri = EnvironmentVariable("MAIN_URI", "file:///app/main.pkl")
 

src/main/kotlin/at/ac/uibk/dps/cirrina/EnvironmentVariables.kt

@@ -13,8 +13,8 @@ import at.ac.uibk.dps.cirrina.execution.service.ServiceImplementation
 import at.ac.uibk.dps.cirrina.execution.service.ServiceImplementationSelector
 import at.ac.uibk.dps.cirrina.io.CsmParser
 import at.ac.uibk.dps.cirrina.spec.Csml as CsmlSpec
-import io.micrometer.core.instrument.MeterRegistry
-import io.micrometer.core.instrument.Timer
+import io.dropwizard.metrics5.MetricRegistry
+import io.dropwizard.metrics5.Timer
 import jakarta.inject.Inject
 import java.net.URI
 import kotlin.time.measureTime
@@ -32,7 +32,7 @@ constructor(
   @Main main: URI,
   persistentContext: Context?,
   stateMachineFactory: StateMachine.Factory,
-  val meterRegistry: MeterRegistry,
+  val metricRegistry: MetricRegistry,
 ) {
   val eventHandler = EventHandler()
   val extent = persistentContext?.let { Extent.of(it) } ?: Extent.of()
@@ -43,7 +43,7 @@ constructor(
 
   private val graph: EventGraph
 
-  private var completion: Timer = meterRegistry.timer("runtime.completionTime")
+  private var completion: Timer = metricRegistry.timer("runtime.completionTime")
 
   init {
     val spec =
@@ -92,7 +92,7 @@ constructor(
   fun run() = runBlocking {
     measureTime { instances.values.map { it.start() }.joinAll() }
       .also {
-        completion.record(it.toJavaDuration())
+        completion.update(it.toJavaDuration())
         logger.info { "runtime terminated in $it" }
       }
   }

src/main/kotlin/at/ac/uibk/dps/cirrina/Runtime.kt

@@ -5,15 +5,15 @@ import at.ac.uibk.dps.cirrina.cirrina.di.CirrinaModule
 import at.ac.uibk.dps.cirrina.cirrina.di.Identifier
 import at.ac.uibk.dps.cirrina.execution.`object`.Context
 import dagger.Component
-import io.micrometer.core.instrument.MeterRegistry
+import io.dropwizard.metrics5.MetricRegistry
 import jakarta.inject.Singleton
 
 @Singleton
 @Component(modules = [CirrinaModule::class])
 interface CirrinaComponent {
   fun persistentContext(): Context?
 
-  fun meterRegistry(): MeterRegistry
+  fun metricRegistry(): MetricRegistry
 
   fun runtime(): Runtime
 

src/main/kotlin/at/ac/uibk/dps/cirrina/di/CirrinaComponent.kt

@@ -4,39 +4,16 @@ import at.ac.uibk.dps.cirrina.EnvironmentVariables
 import at.ac.uibk.dps.cirrina.PersistentContextProvider
 import at.ac.uibk.dps.cirrina.execution.`object`.Context
 import at.ac.uibk.dps.cirrina.execution.provider.ContextEtcd
-import at.ac.uibk.dps.cirrina.util.getBuildVersion
 import dagger.Module
 import dagger.Provides
-import io.micrometer.core.instrument.Clock
-import io.micrometer.core.instrument.MeterRegistry
-import io.micrometer.core.instrument.binder.jvm.ClassLoaderMetrics
-import io.micrometer.core.instrument.binder.jvm.JvmGcMetrics
-import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics
-import io.micrometer.core.instrument.binder.jvm.JvmThreadMetrics
-import io.micrometer.core.instrument.binder.system.ProcessorMetrics
-import io.micrometer.core.instrument.composite.CompositeMeterRegistry
-import io.micrometer.core.instrument.observation.DefaultMeterObservationHandler
-import io.micrometer.influx.InfluxConfig
-import io.micrometer.influx.InfluxMeterRegistry
-import io.micrometer.observation.ObservationHandler
-import io.micrometer.observation.ObservationRegistry
-import io.micrometer.tracing.handler.DefaultTracingObservationHandler
-import io.micrometer.tracing.otel.bridge.OtelBaggageManager
-import io.micrometer.tracing.otel.bridge.OtelCurrentTraceContext
-import io.micrometer.tracing.otel.bridge.OtelTracer
-import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator
-import io.opentelemetry.context.propagation.ContextPropagators
-import io.opentelemetry.exporter.zipkin.ZipkinSpanExporter
-import io.opentelemetry.sdk.OpenTelemetrySdk
-import io.opentelemetry.sdk.resources.Resource
-import io.opentelemetry.sdk.trace.SdkTracerProvider
-import io.opentelemetry.sdk.trace.export.BatchSpanProcessor
-import io.opentelemetry.semconv.ServiceAttributes
+import io.dropwizard.metrics5.CsvReporter
+import io.dropwizard.metrics5.MetricRegistry
 import jakarta.inject.Qualifier
 import jakarta.inject.Singleton
 import java.net.URI
-import java.time.Duration
+import java.nio.file.Paths
 import java.util.UUID
+import java.util.concurrent.TimeUnit
 
 @Qualifier @Retention(AnnotationRetention.RUNTIME) annotation class Identifier
 
@@ -60,92 +37,16 @@ class CirrinaModule {
 
   @Provides
   @Singleton
-  fun provideMeterRegistry(): MeterRegistry {
-    val compositeRegistry = CompositeMeterRegistry()
-
-    EnvironmentVariables.influxMetricUrl.get()?.let { url ->
-      compositeRegistry.add(createInfluxRegistry(url))
-    }
-
-    return compositeRegistry.apply {
-      ClassLoaderMetrics().bindTo(this)
-      JvmMemoryMetrics().bindTo(this)
-      JvmGcMetrics().bindTo(this)
-      JvmThreadMetrics().bindTo(this)
-      ProcessorMetrics().bindTo(this)
-    }
-  }
-
-  @Provides
-  @Singleton
-  fun provideObservationRegistry(
-    @Identifier identifier: String,
-    meterRegistry: MeterRegistry,
-  ): ObservationRegistry {
-    val observationRegistry = ObservationRegistry.create()
-
-    val traceUrl = EnvironmentVariables.zipkinTraceUrl.get() ?: return observationRegistry
-
-    val zipkinExporter = ZipkinSpanExporter.builder().setEndpoint(traceUrl).build()
-
-    val sdkTracerProvider =
-      SdkTracerProvider.builder()
-        .addSpanProcessor(BatchSpanProcessor.builder(zipkinExporter).build())
-        .setResource(
-          Resource.getDefault()
-            .toBuilder()
-            .put(ServiceAttributes.SERVICE_NAME, identifier)
-            .put(ServiceAttributes.SERVICE_VERSION, getBuildVersion())
-            .build()
-        )
-        .build()
-
-    val openTelemetry =
-      OpenTelemetrySdk.builder()
-        .setTracerProvider(sdkTracerProvider)
-        .setPropagators(ContextPropagators.create(W3CTraceContextPropagator.getInstance()))
-        .build()
-
-    val otelTracer = openTelemetry.getTracer("io.micrometer.tracing")
-    val otelCurrentTraceContext = OtelCurrentTraceContext()
-    val baggageManager = OtelBaggageManager(otelCurrentTraceContext, emptyList(), emptyList())
-
-    val otelTracerBridge = OtelTracer(otelTracer, otelCurrentTraceContext, {}, baggageManager)
-
-    return observationRegistry.apply {
-      observationConfig()
-        .observationHandler(
-          ObservationHandler.FirstMatchingCompositeObservationHandler(
-            DefaultTracingObservationHandler(otelTracerBridge),
-            DefaultMeterObservationHandler(meterRegistry),
-          )
-        )
+  fun provideMeterRegistry(): MetricRegistry =
+    MetricRegistry().apply {
+      CsvReporter.forRegistry(this)
+        .build(Paths.get(EnvironmentVariables.metricsDirectory.get()).toAbsolutePath().toFile())
+        .start(EnvironmentVariables.metricsPeriod.get(), TimeUnit.SECONDS)
     }
-  }
 
   @Provides @Singleton @Identifier fun provideIdentifier(): String = "cirrina.${UUID.randomUUID()}"
 
   @Provides @Singleton @Main fun provideMain(): URI = URI(EnvironmentVariables.mainUri.get())
 
   @Provides @Singleton @Run fun provideRun(): List<String> = EnvironmentVariables.run.get()
-
-  private fun createInfluxRegistry(url: String): InfluxMeterRegistry {
-    val config =
-      object : InfluxConfig {
-        override fun step(): Duration =
-          Duration.ofMillis(EnvironmentVariables.influxMetricStep.get())
-
-        override fun uri(): String = url
-
-        override fun org(): String = EnvironmentVariables.influxMetricOrg.get()
-
-        override fun bucket(): String = EnvironmentVariables.influxMetricBucket.get()
-
-        override fun token(): String = EnvironmentVariables.influxMetricToken.get()
-
-        override fun get(k: String): String? = null
-      }
-
-    return InfluxMeterRegistry(config, Clock.SYSTEM)
-  }
 }

src/main/kotlin/at/ac/uibk/dps/cirrina/di/CirrinaModule.kt

@@ -41,10 +41,10 @@ sealed interface Action {
 
         is LogDescription -> LogAction(Expression.create(description.message))
 
-        is IncrCtrDescription ->
-          IncrCtrAction(
+        is CtrDescription ->
+          CtrAction(
             description.counter,
-            description.by ?: "1.0",
+            description.by,
             description.tags?.mapValues { (_, v) -> Expression.create(v) } ?: emptyMap(),
           )
 
@@ -115,8 +115,7 @@ class TimeoutResetAction internal constructor(val action: String) : Action {
 
 class LogAction internal constructor(val message: Expression) : Action
 
-class IncrCtrAction
-internal constructor(val counter: String, val by: String, val tag: Map<String, Expression>) :
-  Action {
-  override fun toString() = "IncrCtrAction(metric='$counter', by='$by', tag='$tag')"
+class CtrAction
+internal constructor(val counter: String, val by: Long, val tag: Map<String, Expression>) : Action {
+  override fun toString() = "CtrAction(metric='$counter', by='$by', tag='$tag')"
 }

src/main/kotlin/at/ac/uibk/dps/cirrina/execution/object/Action.kt

@@ -2,9 +2,8 @@ package at.ac.uibk.dps.cirrina.execution.`object`
 
 import at.ac.uibk.dps.cirrina.csm.Csml.EventChannel
 import at.ac.uibk.dps.cirrina.execution.service.ServiceImplementationSelector
-import io.micrometer.core.instrument.MeterRegistry
-import io.micrometer.core.instrument.Tag
-import io.micrometer.core.instrument.Tags
+import io.dropwizard.metrics5.MetricName
+import io.dropwizard.metrics5.MetricRegistry
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import mu.KotlinLogging
@@ -17,9 +16,9 @@ interface Scope {
 
 class ActionExecutor(
   private val selector: ServiceImplementationSelector,
+  private val metricRegistry: MetricRegistry,
   private val eventHandler: StateMachine.StateMachineEventHandler,
   private val coroutineScope: CoroutineScope,
-  private val meterRegistry: MeterRegistry,
 ) {
   fun execute(action: Action, scope: Scope): List<Action> =
     when (action) {
@@ -30,7 +29,7 @@ class ActionExecutor(
       is TimeoutAction -> listOf(action.triggers)
       is TimeoutResetAction -> emptyList()
       is LogAction -> executeLog(action, scope)
-      is IncrCtrAction -> executeIncrCtr(action, scope)
+      is CtrAction -> executeCtr(action, scope)
       else -> error("unknown action type: ${action::class.simpleName}")
     }
 
@@ -90,12 +89,13 @@ class ActionExecutor(
     return emptyList()
   }
 
-  private fun executeIncrCtr(action: IncrCtrAction, scope: Scope): List<Action> {
+  private fun executeCtr(action: CtrAction, scope: Scope): List<Action> {
     val tags =
-      Tags.of(
-        action.tag.map { (key, value) -> Tag.of(key, value.execute(scope.extent).toString()) }
-      )
-    meterRegistry.counter(action.counter, tags).increment(action.by.toDouble())
+      action.tag.entries.associate { (key, value) -> key to value.execute(scope.extent).toString() }
+
+    val name = MetricName.build(action.counter).tagged(tags)
+    metricRegistry.counter(name).inc(action.by)
+
     return emptyList()
   }
 }