Add Micrometer Prometheus timer interceptor (#29)

* Add Micrometer & Prometheus counter interceptor

* Formatting code

* Remove spring boot actuator dependency

* Formatting code

buildSrc/src/main/kotlin/dependencies.kt

@@ -68,6 +68,8 @@ object Dependencies {
             const val cp = "$group:spring-boot-configuration-processor"
 
             const val jackson = "$group:spring-boot-starter-json"
+
+            const val actuator = "$group:spring-boot-starter-actuator"
         }
     }
 
@@ -111,6 +113,10 @@ object Dependencies {
         const val wagonHttp = "$group.wagon:wagon-http"
     }
 
+    object Micrometer {
+        const val prometheus = "io.micrometer:micrometer-registry-prometheus"
+    }
+
     const val elastic5 = "org.elasticsearch.client:transport"
 
     const val mysql = "mysql:mysql-connector-java"

dependencies/build.gradle.kts

@@ -50,5 +50,6 @@ dependencies {
         api("org.eclipse.jgit:org.eclipse.jgit:5.7.0.202003110725-r")
         api("com.palantir.gradle.docker:gradle-docker:0.25.0")
         api("io.grpc:grpc-kotlin-stub:0.1.2")
+        api("io.micrometer:micrometer-registry-prometheus:1.5.1")
     }
 }

middleware/sisyphus-configuration-artifact/src/main/kotlin/com/bybutter/sisyphus/middleware/configuration/SpringApplicationConfigArtifactPropertyExporter.kt

@@ -0,0 +1,5 @@
+package com.bybutter.sisyphus.middleware.configuration
+
+object SpringApplicationConfigArtifactPropertyExporter : ConfigFormatFilePropertyExporter() {
+    override val names: Collection<String> = listOf("spring/application")
+}

middleware/sisyphus-configuration-artifact/src/main/resources/META-INF/services/com.bybutter.sisyphus.middleware.configuration.ConfigArtifactPropertyExporter

@@ -0,0 +1 @@
+com.bybutter.sisyphus.middleware.configuration.SpringApplicationConfigArtifactPropertyExporter

starter/sisyphus-grpc-server-starter/build.gradle.kts

@@ -10,7 +10,10 @@ description = "Starter for building gRPC server in Sisyphus Framework"
 dependencies {
     api(project(":lib:sisyphus-protobuf"))
     api(project(":middleware:sisyphus-grpc-client"))
+    api(project(":middleware:sisyphus-configuration-artifact"))
     implementation(Dependencies.Grpc.stub)
+    implementation(Dependencies.Spring.Boot.actuator)
+    implementation(Dependencies.Micrometer.prometheus)
     runtimeOnly(Dependencies.Grpc.netty)
 }
 

starter/sisyphus-grpc-server-starter/src/main/kotlin/com/bybutter/sisyphus/starter/grpc/MicrometerRegistrar.kt

@@ -0,0 +1,38 @@
+package com.bybutter.sisyphus.starter.grpc
+
+import io.micrometer.core.instrument.MeterRegistry
+import io.micrometer.core.instrument.Timer
+import java.time.Duration
+import org.springframework.stereotype.Component
+
+/**
+ *  When Sisyphus calls other service interfaces, It will give priority to see if the service is referenced locally,
+ *  if requested, request the local service interfaces.
+ *  The remote request will be initiated if the local request is not available.
+ *  Requesting local services has little overhead for network requests,
+ *  So it may be inaccurate to calculate the average time of the request。
+ *  Use two [Timer] to count remote request and all requests separately.
+ * */
+@Component
+class MicrometerRegistrar constructor(private var registry: MeterRegistry) {
+    /**
+     *  Only record remote requests
+     * */
+    private val remoteRequestTimer: Timer by lazy {
+        registry.timer("sisyphus_remote_request")
+    }
+    /**
+     * Log all requests
+     * */
+    private val allRequestTimer: Timer by lazy {
+        registry.timer("sisyphus_all_request")
+    }
+
+    fun incrRemoteRequest(duration: Duration) {
+        remoteRequestTimer.record(duration)
+    }
+
+    fun incrAllRequest(duration: Duration) {
+        allRequestTimer.record(duration)
+    }
+}

starter/sisyphus-grpc-server-starter/src/main/kotlin/com/bybutter/sisyphus/starter/grpc/support/MicrometerInterceptor.kt

@@ -0,0 +1,36 @@
+package com.bybutter.sisyphus.starter.grpc.support
+
+import com.bybutter.sisyphus.starter.grpc.MicrometerRegistrar
+import io.grpc.Context
+import io.grpc.Contexts
+import io.grpc.ForwardingServerCall
+import io.grpc.Metadata
+import io.grpc.ServerCall
+import io.grpc.ServerCallHandler
+import io.grpc.ServerInterceptor
+import io.grpc.Status
+import java.time.Duration
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.stereotype.Component
+
+@Component
+class ServerMicrometerInterceptor : ServerInterceptor {
+    @Autowired
+    private lateinit var micrometerRegistrar: MicrometerRegistrar
+
+    override fun <ReqT : Any, RespT : Any> interceptCall(call: ServerCall<ReqT, RespT>, headers: Metadata, next: ServerCallHandler<ReqT, RespT>): ServerCall.Listener<ReqT> {
+        val host = headers.get(Metadata.Key.of("host", Metadata.ASCII_STRING_MARSHALLER))?.toString()
+        return Contexts.interceptCall(Context.current(), ServerMicrometerCall(call, micrometerRegistrar, host), headers, next)
+    }
+}
+
+class ServerMicrometerCall<ReqT : Any, RespT : Any>(call: ServerCall<ReqT, RespT>, private val micrometerRegistrar: MicrometerRegistrar, private val host: String?) : ForwardingServerCall.SimpleForwardingServerCall<ReqT, RespT>(call) {
+    override fun close(status: Status, trailers: Metadata) {
+        val costDuration = Duration.ofNanos(System.nanoTime() - REQUEST_TIMESTAMP_CONTEXT_KEY.get())
+        micrometerRegistrar.incrAllRequest(costDuration)
+        if (host != null && !host.startsWith("localhost")) {
+            micrometerRegistrar.incrRemoteRequest(costDuration)
+        }
+        super.close(status, trailers)
+    }
+}