feat: adding action to increment micrometer counter (#108)

Author: AlexZangerle

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

@@ -32,7 +32,7 @@ constructor(
   @Main main: URI,
   persistentContext: Context?,
   stateMachineFactory: StateMachine.Factory,
-  meterRegistry: MeterRegistry,
+  val meterRegistry: MeterRegistry,
 ) {
   val eventHandler = EventHandler()
   val extent = persistentContext?.let { Extent.of(it) } ?: Extent.of()

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

@@ -41,6 +41,13 @@ sealed interface Action {
 
         is LogDescription -> LogAction(Expression.create(description.message))
 
+        is IncrCtrDescription ->
+          IncrCtrAction(
+            description.counter,
+            description.by ?: "1.0",
+            description.tags?.mapValues { (_, v) -> Expression.create(v) } ?: emptyMap(),
+          )
+
         else -> error("unknown action type: ${description.javaClass.simpleName}")
       }
 
@@ -107,3 +114,9 @@ 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')"
+}

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

@@ -2,6 +2,9 @@ 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 kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import mu.KotlinLogging
@@ -16,6 +19,7 @@ class ActionExecutor(
   private val selector: ServiceImplementationSelector,
   private val eventHandler: StateMachine.StateMachineEventHandler,
   private val coroutineScope: CoroutineScope,
+  private val meterRegistry: MeterRegistry,
 ) {
   fun execute(action: Action, scope: Scope): List<Action> =
     when (action) {
@@ -26,6 +30,7 @@ class ActionExecutor(
       is TimeoutAction -> listOf(action.triggers)
       is TimeoutResetAction -> emptyList()
       is LogAction -> executeLog(action, scope)
+      is IncrCtrAction -> executeIncrCtr(action, scope)
       else -> error("unknown action type: ${action::class.simpleName}")
     }
 
@@ -84,4 +89,13 @@ class ActionExecutor(
     action.message.execute(scope.extent).toString().also { logger.info(it) }
     return emptyList()
   }
+
+  private fun executeIncrCtr(action: IncrCtrAction, 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())
+    return emptyList()
+  }
 }

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

@@ -46,7 +46,12 @@ internal constructor(
   private val timeoutActionManager = TimeoutActionManager(coroutineScope)
   private val stateMachineEventHandler = StateMachineEventHandler(runtime.eventHandler)
   private val actionExecutor =
-    ActionExecutor(runtime.selector, stateMachineEventHandler, coroutineScope)
+    ActionExecutor(
+      runtime.selector,
+      stateMachineEventHandler,
+      coroutineScope,
+      runtime.meterRegistry,
+    )
 
   private val stateInstances =
     specification.vertexSet().associate { it.name to stateFactory.create(it, this) }

src/main/resources/pkl/csm/csml.pkl

@@ -103,7 +103,6 @@ class EvalDescription extends ActionDescription {
   expression: Expression
 }
 
-
 class EmitDescription extends ActionDescription {
   event: EventDescription
   target: Expression?
@@ -114,12 +113,10 @@ class TimeoutDescription extends ActionDescription {
   triggers: EmitDescription
 }
 
-
 class ResetDescription extends ActionDescription {
   name: TimeoutName
 }
 
-
 class CaseDescription {
   of: Expression
   yields: Listing<ActionDescription>
@@ -192,4 +189,13 @@ typealias Log = LogDescription
 
 // Event aliases
 typealias Event = EventDescription
-typealias Internal = InternalDescription
+typealias Internal = InternalDescription
+
+// Private API - not meant for production use
+class IncrCtrDescription extends ActionDescription {
+  counter: String
+  by: String?
+  tags: Mapping<String, Expression>?
+}
+
+typealias IncrCtr = IncrCtrDescription