Merge pull request #1377 from guardian/grafana-annotation-urls

Add link to deployment log to grafana logger
guardian · Sep 23, 2024 · f901012 · f901012
2 parents c9e530e + d52f804
commit f901012
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/riff-raff/app/AppComponents.scala b/riff-raff/app/AppComponents.scala
@@ -223,7 +223,7 @@ class AppComponents(
     deployments,
     builds,
     targetResolver,
-    new GrafanaAnnotationLogger,
+    new GrafanaAnnotationLogger(config.urls.publicPrefix),
     hooksClient,
     new SummariseDeploysHousekeeping(config, datastore),
     continuousDeployment,

diff --git a/riff-raff/app/notification/GrafanaAnnotationLogger.scala b/riff-raff/app/notification/GrafanaAnnotationLogger.scala
@@ -10,6 +10,7 @@ import net.logstash.logback.marker.Markers.appendEntries
 import play.api.MarkerContext
 import rx.lang.scala.Subscription
 
+import java.util.UUID
 import scala.jdk.CollectionConverters._
 
 trait LogMarker {
@@ -18,27 +19,34 @@ trait LogMarker {
   def markerContents: Map[String, Any]
 }
 
-class GrafanaAnnotationLogger extends Lifecycle with Logging {
+class GrafanaAnnotationLogger(riffRaffUrl: String)
+    extends Lifecycle
+    with Logging {
 
   val messageSub: Subscription = DeployReporter.messages.subscribe(message => {
+    val deployId = message.context.deployId
     message.stack.top match {
       case StartContext(Deploy(parameters)) =>
-        log.info("Started deploy")(buildMarker(parameters))
+        log.info("Started deploy")(buildMarker(deployId, parameters))
       case FailContext(Deploy(parameters)) =>
-        log.info("Failed deploy")(buildMarker(parameters))
+        log.info("Failed deploy")(buildMarker(deployId, parameters))
       case FinishContext(Deploy(parameters)) =>
-        log.info("Finished deploy")(buildMarker(parameters))
+        log.info("Finished deploy")(buildMarker(deployId, parameters))
       case _ =>
     }
   })
 
-  private def buildMarker(parameters: DeployParameters): MarkerContext = {
+  private def buildMarker(
+      deployId: UUID,
+      parameters: DeployParameters
+  ): MarkerContext = {
     val params: Map[String, Any] =
       Map(
         "projectName" -> parameters.build.projectName,
         "projectBuild" -> parameters.build.id,
         "projectStage" -> parameters.stage.name,
-        "projectDeployer" -> parameters.deployer.name
+        "projectDeployer" -> parameters.deployer.name,
+        "projectDeploymentLink" -> s"<a target=\"_blank\" href=\"${riffRaffUrl}/deployment/view/$deployId\">${parameters.build.id}</a>"
       )
     MarkerContext(appendEntries(params.asJava))
   }