expose library version in logs and as metric (#631)

evolution-gaming · Sep 13, 2024 · 29b71e1 · 29b71e1
1 parent 2176e5a
commit 29b71e1
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 3 deletions.
diff --git a/build.sbt b/build.sbt
@@ -1,4 +1,5 @@
-import Dependencies._
+import Dependencies.*
+import sbt.Package.ManifestAttributes
 
 lazy val commonSettings = Seq(
   organization := "com.evolutiongaming",
@@ -18,7 +19,15 @@ lazy val commonSettings = Seq(
   libraryDependencySchemes ++= Seq(
     "org.scala-lang.modules" %% "scala-java8-compat" % "always",
     "org.scala-lang.modules" %% "scala-xml"          % "always"),
-  versionScheme := Some("early-semver"))
+  versionScheme := Some("early-semver"),
+  packageOptions := {
+    Seq(
+      ManifestAttributes(
+        ("Implementation-Version", (ThisProject / version).value),
+      ),
+    )
+  },
+)
 
 
 lazy val root = (project in file(".")

diff --git a/...c/main/scala/com/evolutiongaming/kafka/journal/eventual/cassandra/EventualCassandra.scala b/...c/main/scala/com/evolutiongaming/kafka/journal/eventual/cassandra/EventualCassandra.scala
@@ -81,6 +81,7 @@ object EventualCassandra {
       schema       <- SetupSchema[F](schemaConfig, origin, consistencyConfig)
       segmentNrsOf  = SegmentNrsOf[F](first = Segments.default, second = Segments.old)
       statements   <- Statements.of(schema, segmentNrsOf, Segments.default, consistencyConfig.read)
+      _            <- log.info(s"kafka-journal version: ${Version.current.value}")
     } yield {
       val journal = apply[F](statements).withLog(log)
       metrics

diff --git a/...main/scala/com/evolutiongaming/kafka/journal/eventual/cassandra/ReplicatedCassandra.scala b/...main/scala/com/evolutiongaming/kafka/journal/eventual/cassandra/ReplicatedCassandra.scala
@@ -44,6 +44,7 @@ object ReplicatedCassandra {
       statements    <- Statements.of[F](schema, config.consistencyConfig)
       log           <- LogOf[F].apply(ReplicatedCassandra.getClass)
       expiryService <- ExpiryService.of[F]
+      _             <- log.info(s"kafka-journal version: ${Version.current.value}")
     } yield {
       val segmentOf = SegmentNrsOf[F](first = Segments.default, second = Segments.old)
       val journal = apply[F](config.segmentSize, segmentOf, statements, expiryService)

diff --git a/journal/src/main/scala/com/evolutiongaming/kafka/journal/Version.scala b/journal/src/main/scala/com/evolutiongaming/kafka/journal/Version.scala
@@ -11,7 +11,7 @@ final case class Version(value: String) {
 
 object Version {
 
-  val current: Version = Version("0.3.4")
+  val current: Version = Version(Option(Version.getClass.getPackage.getImplementationVersion).getOrElse("unknown"))
 
 
   implicit val eqVersion: Eq[Version] = Eq.fromUniversalEquals

diff --git a/journal/src/main/scala/com/evolutiongaming/kafka/journal/eventual/EventualJournal.scala b/journal/src/main/scala/com/evolutiongaming/kafka/journal/eventual/EventualJournal.scala
@@ -4,6 +4,7 @@ import cats._
 import cats.arrow.FunctionK
 import cats.effect.Resource
 import cats.syntax.all._
+import com.evolutiongaming.catshelper.CatsHelper.OpsCatsHelper
 import com.evolutiongaming.catshelper.{Log, MeasureDuration, MonadThrowable}
 import com.evolutiongaming.kafka.journal._
 import com.evolutiongaming.kafka.journal.util.StreamHelper._
@@ -84,6 +85,12 @@ object EventualJournal {
       prefix: String = "eventual_journal"
     ): Resource[F, Metrics[F]] = {
 
+      val versionGauge = registry.gauge(
+        name   = s"${prefix}_info",
+        help   = "Journal version information",
+        labels = LabelNames("version"),
+      )
+
       val latencySummary = registry.summary(
         name = s"${ prefix }_topic_latency",
         help = "Journal call latency in seconds",
@@ -97,6 +104,8 @@ object EventualJournal {
         labels = LabelNames("topic"))
 
       for {
+        versionGauge   <- versionGauge
+        _              <- versionGauge.labels(Version.current.value).set(1).toResource
         latencySummary <- latencySummary
         eventsSummary  <- eventsSummary
       } yield {

diff --git a/journal/src/main/scala/com/evolutiongaming/kafka/journal/eventual/ReplicatedJournal.scala b/journal/src/main/scala/com/evolutiongaming/kafka/journal/eventual/ReplicatedJournal.scala
@@ -188,6 +188,12 @@ object ReplicatedJournal {
       prefix: String = "replicated_journal"
     ): Resource[F, Metrics[F]] = {
 
+      val versionGauge = registry.gauge(
+        name   = s"${prefix}_info",
+        help   = "Journal version information",
+        labels = LabelNames("version"),
+      )
+
       val latencySummary = registry.summary(
         name      = s"${ prefix }_latency",
         help      = "Journal call latency in seconds",
@@ -207,6 +213,8 @@ object ReplicatedJournal {
         labels    = LabelNames("topic"))
 
       for {
+        versionGauge        <- versionGauge
+        _                   <- versionGauge.labels(Version.current.value).set(1).toResource
         latencySummary      <- latencySummary
         topicLatencySummary <- topicLatencySummary
         eventsSummary       <- eventsSummary