Added x-source-ui header, logged in http server metrics (#3581)

ray-roestenburg-da · web-flow · commit 8cd8373f8550 · 2026-01-20T15:32:03.000+01:00
---------

Signed-off-by: Raymond Roestenburg &lt;raymond.roestenburg@digitalasset.com&gt;
diff --git a/apps/app/src/main/scala/org/lfdecentralizedtrust/splice/metrics/SpliceMetricsFactory.scala b/apps/app/src/main/scala/org/lfdecentralizedtrust/splice/metrics/SpliceMetricsFactory.scala
@@ -33,6 +33,7 @@ case class SpliceMetricsFactory(
         new ValidatorAppMetrics(
           metricsFactoryProvider.generateMetricsFactory(metricsContext),
           storageHistograms,
+          loggerFactory,
         )
       },
     )
@@ -45,6 +46,7 @@ case class SpliceMetricsFactory(
         new SvAppMetrics(
           metricsFactoryProvider.generateMetricsFactory(metricsContext),
           storageHistograms,
+          loggerFactory,
         )
       },
     )
@@ -71,9 +73,9 @@ case class SpliceMetricsFactory(
         new SplitwellAppMetrics(
           metricsFactoryProvider.generateMetricsFactory(metricsContext),
           storageHistograms,
+          loggerFactory,
         )
       },
     )
   }
-
 }
diff --git a/apps/common/frontend/src/api/scan/ScanClientContext.tsx b/apps/common/frontend/src/api/scan/ScanClientContext.tsx
@@ -19,7 +19,16 @@ export const ScanClientProvider: React.FC<React.PropsWithChildren<ScanProps>> =
   const client: openapi.ScanApi | undefined = useMemo(() => {
     const configuration = openapi.createConfiguration({
       baseServer: new openapi.ServerConfiguration(url, {}),
-      promiseMiddleware: [new OpenAPILoggingMiddleware('scan')],
+      promiseMiddleware: [
+        new OpenAPILoggingMiddleware('scan'),
+        {
+          pre: async context => {
+            context.setHeaderParam('x-source-ui', 'scan');
+            return context;
+          },
+          post: async context => context,
+        },
+      ],
     });
 
     return new openapi.ScanApi(configuration);
diff --git a/apps/common/src/main/scala/org/lfdecentralizedtrust/splice/SpliceMetrics.scala b/apps/common/src/main/scala/org/lfdecentralizedtrust/splice/SpliceMetrics.scala
@@ -7,6 +7,7 @@ import com.daml.metrics.HealthMetrics
 import com.daml.metrics.api.MetricHandle.LabeledMetricsFactory
 import com.daml.metrics.api.{MetricName, MetricsContext}
 import com.digitalasset.canton.environment.BaseMetrics
+import com.digitalasset.canton.logging.NamedLoggerFactory
 import com.digitalasset.canton.metrics.ActiveRequestsMetrics.GrpcServerMetricsX
 import com.digitalasset.canton.metrics.{
   DbStorageHistograms,
@@ -33,6 +34,7 @@ abstract class BaseSpliceMetrics(
     nodeType: String,
     override val openTelemetryMetricsFactory: LabeledMetricsFactory,
     storageHistograms: DbStorageHistograms,
+    loggerFactory: NamedLoggerFactory,
 ) extends SpliceMetrics {
 
   override val prefix = MetricName(nodeType)
@@ -48,7 +50,8 @@ abstract class BaseSpliceMetrics(
     new DbStorageMetrics(storageHistograms, openTelemetryMetricsFactory)
 
   override def httpServerMetrics: HttpServerMetrics = new HttpServerMetrics(
-    openTelemetryMetricsFactory
+    openTelemetryMetricsFactory,
+    loggerFactory,
   )
   override def httpClientMetrics: HttpClientMetrics = new HttpClientMetrics(
     openTelemetryMetricsFactory
diff --git a/apps/common/src/main/scala/org/lfdecentralizedtrust/splice/http/HttpServerMetrics.scala b/apps/common/src/main/scala/org/lfdecentralizedtrust/splice/http/HttpServerMetrics.scala
@@ -6,11 +6,29 @@ package org.lfdecentralizedtrust.splice.http
 import com.daml.metrics.api.MetricHandle.LabeledMetricsFactory
 import com.daml.metrics.api.MetricQualification.Latency
 import com.daml.metrics.api.{MetricInfo, MetricName, MetricsContext}
+import com.digitalasset.canton.logging.{NamedLoggerFactory, NamedLogging}
+import com.digitalasset.canton.tracing.TraceContext
 import org.apache.pekko.http.scaladsl.server.{Directive0, RouteResult}
 
 import scala.util.{Failure, Success}
 
-class HttpServerMetrics(metricsFactory: LabeledMetricsFactory) {
+object HttpServerMetrics {
+  val customSourceUiHeader = "x-source-ui"
+  object LabelNames {
+    val Operation = "operation"
+    val Status = "status"
+    val StatusCode = "status_code"
+    val HttpService = "http_service"
+    val SourceUi = "source_ui"
+  }
+}
+
+class HttpServerMetrics(
+    metricsFactory: LabeledMetricsFactory,
+    override protected val loggerFactory: NamedLoggerFactory,
+) extends NamedLogging {
+  import HttpServerMetrics.*
+  import HttpServerMetrics.LabelNames.*
 
   private val prefix: MetricName = MetricName.Daml :+ "http"
 
@@ -20,8 +38,8 @@ class HttpServerMetrics(metricsFactory: LabeledMetricsFactory) {
       summary = "Histogram for http request durations",
       qualification = Latency,
       labelsWithDescription = Map(
-        "operation" -> "Descriptor of the HTTP operation done, as per the OpenAPI spec",
-        "status" -> "Status of the HTTP request: completed, rejected, failure",
+        Operation -> "Descriptor of the HTTP operation done, as per the OpenAPI spec",
+        Status -> "Status of the HTTP request: completed, rejected, failure",
       ),
     )
   )
@@ -32,38 +50,53 @@ class HttpServerMetrics(metricsFactory: LabeledMetricsFactory) {
       summary = "Count of in-flight http requests",
       qualification = Latency,
       labelsWithDescription = Map(
-        "operation" -> "Descriptor of the HTTP operation done, as per the OpenAPI spec"
+        Operation -> "Descriptor of the HTTP operation done, as per the OpenAPI spec"
       ),
     )
   )
 
   // This directive is used to wrap HTTP routes with metrics collection.
   // We need to pass the operation explicitly, which represents the OpenAPI operation ID.
-  def withMetrics(service: String)(operation: String): Directive0 = {
+  def withMetrics(service: String)(operation: String)(implicit tc: TraceContext): Directive0 = {
     import org.apache.pekko.http.scaladsl.server.Directives.*
-    implicit val mc: MetricsContext =
-      MetricsContext("operation" -> operation, "http_service" -> service)
 
     extractExecutionContext.flatMap { implicit ec =>
-      extractRequest.flatMap { _ =>
+      extractRequest.flatMap { req =>
+        val c = MetricsContext(Operation -> operation, HttpService -> service)
+        implicit val mc: MetricsContext = req.headers
+          .find(_.is(customSourceUiHeader)) // custom header added by the UI
+          .map { header =>
+            val sourceUi = header.value
+            logger.debug(
+              s"HTTP Request from UI($customSourceUiHeader: $sourceUi): service = $service, operation= $operation"
+            )
+            c.withExtraLabels(SourceUi -> sourceUi)
+          }
+          .getOrElse {
+            logger.debug(
+              s"HTTP Request no source UI header: service = $service, operation= $operation"
+            )
+            c
+          }
+
         inFlightRequests.inc()
         val timing = requestTiming.startAsync()
         mapRouteResultFuture { resultFuture =>
           resultFuture.map[RouteResult] {
             case res @ RouteResult.Complete(response) =>
               timing.stop()(
                 MetricsContext(
-                  "status_code" -> response.status.intValue().toString,
-                  "status" -> "completed",
+                  StatusCode -> response.status.intValue().toString,
+                  Status -> "completed",
                 )
               )
               res
             case res @ RouteResult.Rejected(_) =>
-              timing.stop()(MetricsContext("status" -> "rejected"))
+              timing.stop()(MetricsContext(Status -> "rejected"))
               res
           } andThen {
             case Failure(_) =>
-              timing.stop()(MetricsContext("status" -> "failure"))
+              timing.stop()(MetricsContext(Status -> "failure"))
               inFlightRequests.dec()
             case Success(_) =>
               inFlightRequests.dec()
diff --git a/apps/scan/frontend/src/api/TokenMetadataClientContext.tsx b/apps/scan/frontend/src/api/TokenMetadataClientContext.tsx
@@ -18,7 +18,16 @@ export const TokenMetadataClientProvider: React.FC<React.PropsWithChildren<ScanC
   const client: openapi.DefaultApi | undefined = useMemo(() => {
     const configuration = openapi.createConfiguration({
       baseServer: new openapi.ServerConfiguration(scanUrl, {}),
-      promiseMiddleware: [new OpenAPILoggingMiddleware('TokenMetadata')],
+      promiseMiddleware: [
+        new OpenAPILoggingMiddleware('TokenMetadata'),
+        {
+          pre: async context => {
+            context.setHeaderParam('x-source-ui', 'scan');
+            return context;
+          },
+          post: async context => context,
+        },
+      ],
     });
 
     return new openapi.DefaultApi(configuration);
diff --git a/apps/scan/src/main/scala/org/lfdecentralizedtrust/splice/scan/metrics/ScanAppMetrics.scala b/apps/scan/src/main/scala/org/lfdecentralizedtrust/splice/scan/metrics/ScanAppMetrics.scala
@@ -19,7 +19,7 @@ class ScanAppMetrics(
     storageHistograms: DbStorageHistograms,
     loggerFactory: NamedLoggerFactory,
     timeouts: ProcessingTimeout,
-) extends BaseSpliceMetrics("scan", metricsFactory, storageHistograms) {
+) extends BaseSpliceMetrics("scan", metricsFactory, storageHistograms, loggerFactory) {
   val dbScanStore = new DbScanStoreMetrics(metricsFactory, loggerFactory, timeouts)
   val verdictIngestion = new ScanMediatorVerdictIngestionMetrics(metricsFactory)
 }
diff --git a/apps/splitwell/src/main/scala/org/lfdecentralizedtrust/splice/splitwell/metrics/SplitwellAppMetrics.scala b/apps/splitwell/src/main/scala/org/lfdecentralizedtrust/splice/splitwell/metrics/SplitwellAppMetrics.scala
@@ -4,6 +4,7 @@
 package org.lfdecentralizedtrust.splice.splitwell.metrics
 
 import com.daml.metrics.api.MetricHandle.LabeledMetricsFactory
+import com.digitalasset.canton.logging.NamedLoggerFactory
 import org.lfdecentralizedtrust.splice.BaseSpliceMetrics
 import com.digitalasset.canton.metrics.DbStorageHistograms
 
@@ -14,4 +15,5 @@ import com.digitalasset.canton.metrics.DbStorageHistograms
 class SplitwellAppMetrics(
     metricsFactory: LabeledMetricsFactory,
     storageHistograms: DbStorageHistograms,
-) extends BaseSpliceMetrics("splitwell", metricsFactory, storageHistograms) {}
+    loggerFactory: NamedLoggerFactory,
+) extends BaseSpliceMetrics("splitwell", metricsFactory, storageHistograms, loggerFactory) {}
diff --git a/apps/sv/src/main/scala/org/lfdecentralizedtrust/splice/sv/SvApp.scala b/apps/sv/src/main/scala/org/lfdecentralizedtrust/splice/sv/SvApp.scala
@@ -634,7 +634,7 @@ class SvApp(
             val errorHandler = new HttpErrorHandler(loggerFactory)
             def buildOperation(service: String, operation: String) = {
               metrics.httpServerMetrics
-                .withMetrics(service)(operation)
+                .withMetrics(service)(operation)(traceContext)
                 .tflatMap(_ => {
                   httpRateLimiter.withRateLimit(service)(operation).tflatMap { _ =>
                     config.parameters.customTimeouts.get(operation) match {
diff --git a/apps/sv/src/main/scala/org/lfdecentralizedtrust/splice/sv/metrics/SvAppMetrics.scala b/apps/sv/src/main/scala/org/lfdecentralizedtrust/splice/sv/metrics/SvAppMetrics.scala
@@ -4,6 +4,7 @@
 package org.lfdecentralizedtrust.splice.sv.metrics
 
 import com.daml.metrics.api.MetricHandle.LabeledMetricsFactory
+import com.digitalasset.canton.logging.NamedLoggerFactory
 import org.lfdecentralizedtrust.splice.BaseSpliceMetrics
 import com.digitalasset.canton.metrics.DbStorageHistograms
 
@@ -14,4 +15,5 @@ import com.digitalasset.canton.metrics.DbStorageHistograms
 class SvAppMetrics(
     metricsFactory: LabeledMetricsFactory,
     storageHistograms: DbStorageHistograms,
-) extends BaseSpliceMetrics("sv", metricsFactory, storageHistograms) {}
+    loggerFactory: NamedLoggerFactory,
+) extends BaseSpliceMetrics("sv", metricsFactory, storageHistograms, loggerFactory) {}
diff --git a/apps/validator/src/main/scala/org/lfdecentralizedtrust/splice/validator/metrics/ValidatorAppMetrics.scala b/apps/validator/src/main/scala/org/lfdecentralizedtrust/splice/validator/metrics/ValidatorAppMetrics.scala
@@ -4,6 +4,7 @@
 package org.lfdecentralizedtrust.splice.validator.metrics
 
 import com.daml.metrics.api.MetricHandle.LabeledMetricsFactory
+import com.digitalasset.canton.logging.NamedLoggerFactory
 import com.digitalasset.canton.metrics.DbStorageHistograms
 import org.lfdecentralizedtrust.splice.BaseSpliceMetrics
 
@@ -12,4 +13,5 @@ import org.lfdecentralizedtrust.splice.BaseSpliceMetrics
 class ValidatorAppMetrics(
     metricsFactory: LabeledMetricsFactory,
     storageHistograms: DbStorageHistograms,
-) extends BaseSpliceMetrics("validator", metricsFactory, storageHistograms) {}
+    loggerFactory: NamedLoggerFactory,
+) extends BaseSpliceMetrics("validator", metricsFactory, storageHistograms, loggerFactory) {}
diff --git a/cluster/expected/infra/expected.json b/cluster/expected/infra/expected.json
diff --git a/cluster/pulumi/infra/grafana-dashboards/platform/http.json b/cluster/pulumi/infra/grafana-dashboards/platform/http.json

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ case class SpliceMetricsFactory(`
`33`	`33`	`new ValidatorAppMetrics(`
`34`	`34`	`metricsFactoryProvider.generateMetricsFactory(metricsContext),`
`35`	`35`	`storageHistograms,`
	`36`	`+ loggerFactory,`
`36`	`37`	`)`
`37`	`38`	`},`
`38`	`39`	`)`
`@@ -45,6 +46,7 @@ case class SpliceMetricsFactory(`
`45`	`46`	`new SvAppMetrics(`
`46`	`47`	`metricsFactoryProvider.generateMetricsFactory(metricsContext),`
`47`	`48`	`storageHistograms,`
	`49`	`+ loggerFactory,`
`48`	`50`	`)`
`49`	`51`	`},`
`50`	`52`	`)`
`@@ -71,9 +73,9 @@ case class SpliceMetricsFactory(`
`71`	`73`	`new SplitwellAppMetrics(`
`72`	`74`	`metricsFactoryProvider.generateMetricsFactory(metricsContext),`
`73`	`75`	`storageHistograms,`
	`76`	`+ loggerFactory,`
`74`	`77`	`)`
`75`	`78`	`},`
`76`	`79`	`)`
`77`	`80`	`}`
`78`		`-`
`79`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class ScanAppMetrics(`
`19`	`19`	`storageHistograms: DbStorageHistograms,`
`20`	`20`	`loggerFactory: NamedLoggerFactory,`
`21`	`21`	`timeouts: ProcessingTimeout,`
`22`		`-) extends BaseSpliceMetrics("scan", metricsFactory, storageHistograms) {`
	`22`	`+) extends BaseSpliceMetrics("scan", metricsFactory, storageHistograms, loggerFactory) {`
`23`	`23`	`val dbScanStore = new DbScanStoreMetrics(metricsFactory, loggerFactory, timeouts)`
`24`	`24`	`val verdictIngestion = new ScanMediatorVerdictIngestionMetrics(metricsFactory)`
`25`	`25`	`}`