From 569f84472b9b7c7ac09ff21fec4d4d8e1c4983dd Mon Sep 17 00:00:00 2001 From: Jorge Azevedo Date: Fri, 20 Sep 2024 14:14:04 +0100 Subject: [PATCH 1/7] Add html tag parameter --- riff-raff/app/notification/GrafanaAnnotationLogger.scala | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/riff-raff/app/notification/GrafanaAnnotationLogger.scala b/riff-raff/app/notification/GrafanaAnnotationLogger.scala index 4f2dd32aa..a0bcb67a1 100644 --- a/riff-raff/app/notification/GrafanaAnnotationLogger.scala +++ b/riff-raff/app/notification/GrafanaAnnotationLogger.scala @@ -38,7 +38,8 @@ class GrafanaAnnotationLogger extends Lifecycle with Logging { "projectName" -> parameters.build.projectName, "projectBuild" -> parameters.build.id, "projectStage" -> parameters.stage.name, - "projectDeployer" -> parameters.deployer.name + "projectDeployer" -> parameters.deployer.name, + "projectHistoryTag" -> s"${parameters.deployer.name}" ) MarkerContext(appendEntries(params.asJava)) } From 27926b759f093a245b6f249f9802a509dd34d0d0 Mon Sep 17 00:00:00 2001 From: Jorge Azevedo Date: Fri, 20 Sep 2024 14:22:41 +0100 Subject: [PATCH 2/7] Use project name paramter --- riff-raff/app/notification/GrafanaAnnotationLogger.scala | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/riff-raff/app/notification/GrafanaAnnotationLogger.scala b/riff-raff/app/notification/GrafanaAnnotationLogger.scala index a0bcb67a1..312d39263 100644 --- a/riff-raff/app/notification/GrafanaAnnotationLogger.scala +++ b/riff-raff/app/notification/GrafanaAnnotationLogger.scala @@ -39,7 +39,7 @@ class GrafanaAnnotationLogger extends Lifecycle with Logging { "projectBuild" -> parameters.build.id, "projectStage" -> parameters.stage.name, "projectDeployer" -> parameters.deployer.name, - "projectHistoryTag" -> s"${parameters.deployer.name}" + "projectHistoryTag" -> s"${parameters.build.projectName}" ) MarkerContext(appendEntries(params.asJava)) } From b7b7ca471e435fa2fc4d1b31a59dba54f4d11bf4 Mon Sep 17 00:00:00 2001 From: akash1810 Date: Fri, 20 Sep 2024 15:10:31 +0100 Subject: [PATCH 3/7] Add `projectDeploymentLink` marker to grafana annotation logger --- .../notification/GrafanaAnnotationLogger.scala | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/riff-raff/app/notification/GrafanaAnnotationLogger.scala b/riff-raff/app/notification/GrafanaAnnotationLogger.scala index 312d39263..b2aa4cc97 100644 --- 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 { @@ -21,25 +22,30 @@ trait LogMarker { class GrafanaAnnotationLogger 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, - "projectHistoryTag" -> s"${parameters.build.projectName}" + "projectHistoryTag" -> s"${parameters.build.projectName}", + "projectDeploymentLink" -> s"${parameters.build.id}" ) MarkerContext(appendEntries(params.asJava)) } From 127cdd90722b72bcfc3fa2c081f9fba8bf85734d Mon Sep 17 00:00:00 2001 From: Jorge Azevedo Date: Fri, 20 Sep 2024 15:26:57 +0100 Subject: [PATCH 4/7] Avoid hardcoding riff raff url --- riff-raff/app/AppComponents.scala | 2 +- riff-raff/app/notification/GrafanaAnnotationLogger.scala | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/riff-raff/app/AppComponents.scala b/riff-raff/app/AppComponents.scala index 1e3888556..00c123c07 100644 --- a/riff-raff/app/AppComponents.scala +++ b/riff-raff/app/AppComponents.scala @@ -222,7 +222,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 index b2aa4cc97..e4ce72725 100644 --- a/riff-raff/app/notification/GrafanaAnnotationLogger.scala +++ b/riff-raff/app/notification/GrafanaAnnotationLogger.scala @@ -19,7 +19,7 @@ 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 @@ -44,8 +44,8 @@ class GrafanaAnnotationLogger extends Lifecycle with Logging { "projectBuild" -> parameters.build.id, "projectStage" -> parameters.stage.name, "projectDeployer" -> parameters.deployer.name, - "projectHistoryTag" -> s"${parameters.build.projectName}", - "projectDeploymentLink" -> s"${parameters.build.id}" + "projectHistoryTag" -> s"${parameters.build.projectName}", + "projectDeploymentLink" -> s"${parameters.build.id}" ) MarkerContext(appendEntries(params.asJava)) } From eabe0ddcfc782cf8559c230df5520959d338c3ea Mon Sep 17 00:00:00 2001 From: Jorge Azevedo Date: Fri, 20 Sep 2024 15:29:54 +0100 Subject: [PATCH 5/7] Scalafmt fix --- riff-raff/app/notification/GrafanaAnnotationLogger.scala | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/riff-raff/app/notification/GrafanaAnnotationLogger.scala b/riff-raff/app/notification/GrafanaAnnotationLogger.scala index e4ce72725..9477d17b5 100644 --- a/riff-raff/app/notification/GrafanaAnnotationLogger.scala +++ b/riff-raff/app/notification/GrafanaAnnotationLogger.scala @@ -19,7 +19,9 @@ trait LogMarker { def markerContents: Map[String, Any] } -class GrafanaAnnotationLogger(riffRaffUrl: String) extends Lifecycle with Logging { +class GrafanaAnnotationLogger(riffRaffUrl: String) + extends Lifecycle + with Logging { val messageSub: Subscription = DeployReporter.messages.subscribe(message => { val deployId = message.context.deployId From 63be458288c75dff5ae87ee3a83ccefc67723e54 Mon Sep 17 00:00:00 2001 From: Jorge Azevedo Date: Fri, 20 Sep 2024 16:39:14 +0100 Subject: [PATCH 6/7] Make link open in new tab --- riff-raff/app/notification/GrafanaAnnotationLogger.scala | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/riff-raff/app/notification/GrafanaAnnotationLogger.scala b/riff-raff/app/notification/GrafanaAnnotationLogger.scala index 9477d17b5..ae8636191 100644 --- a/riff-raff/app/notification/GrafanaAnnotationLogger.scala +++ b/riff-raff/app/notification/GrafanaAnnotationLogger.scala @@ -47,7 +47,7 @@ class GrafanaAnnotationLogger(riffRaffUrl: String) "projectStage" -> parameters.stage.name, "projectDeployer" -> parameters.deployer.name, "projectHistoryTag" -> s"${parameters.build.projectName}", - "projectDeploymentLink" -> s"${parameters.build.id}" + "projectDeploymentLink" -> s"${parameters.build.id}" ) MarkerContext(appendEntries(params.asJava)) } From df5ef6737bd8eab74187f4f6ce2c1a7c7c66947f Mon Sep 17 00:00:00 2001 From: Jorge Azevedo Date: Fri, 20 Sep 2024 16:40:28 +0100 Subject: [PATCH 7/7] Remove project history link --- riff-raff/app/notification/GrafanaAnnotationLogger.scala | 1 - 1 file changed, 1 deletion(-) diff --git a/riff-raff/app/notification/GrafanaAnnotationLogger.scala b/riff-raff/app/notification/GrafanaAnnotationLogger.scala index ae8636191..baf4eff88 100644 --- a/riff-raff/app/notification/GrafanaAnnotationLogger.scala +++ b/riff-raff/app/notification/GrafanaAnnotationLogger.scala @@ -46,7 +46,6 @@ class GrafanaAnnotationLogger(riffRaffUrl: String) "projectBuild" -> parameters.build.id, "projectStage" -> parameters.stage.name, "projectDeployer" -> parameters.deployer.name, - "projectHistoryTag" -> s"${parameters.build.projectName}", "projectDeploymentLink" -> s"${parameters.build.id}" ) MarkerContext(appendEntries(params.asJava))