Add endpoint method and path to metrics name.

Signed-off-by: Jakub Dardzinski <kuba0221@gmail.com>

Author: JDarDagran

api/src/main/java/marquez/MarquezApp.java

@@ -36,6 +36,7 @@
 import marquez.db.DbMigration;
 import marquez.jobs.DbRetentionJob;
 import marquez.logging.LoggingMdcFilter;
+import marquez.logging.SmarterNameStrategy;
 import marquez.tracing.SentryConfig;
 import marquez.tracing.TracingContainerResponseFilter;
 import marquez.tracing.TracingSQLLogger;
@@ -162,7 +163,7 @@ private Jdbi newJdbi(
             .installPlugin(new SqlObjectPlugin())
             .installPlugin(new PostgresPlugin())
             .installPlugin(new Jackson2Plugin());
-    SqlLogger sqlLogger = new InstrumentedSqlLogger(env.metrics());
+    SqlLogger sqlLogger = new InstrumentedSqlLogger(env.metrics(), new SmarterNameStrategy());
     if (isSentryEnabled(config)) {
       sqlLogger = new TracingSQLLogger(sqlLogger);
     }

api/src/main/java/marquez/logging/EndpointNameStrategy.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2018-2023 contributors to the Marquez project
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package marquez.logging;
+
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.jdbi3.strategies.StatementNameStrategy;
+import org.jdbi.v3.core.extension.ExtensionMethod;
+import org.jdbi.v3.core.statement.StatementContext;
+import org.slf4j.MDC;
+
+public class EndpointNameStrategy implements StatementNameStrategy {
+
+  @Override
+  public String getStatementName(StatementContext statementContext) {
+    ExtensionMethod extensionMethod = statementContext.getExtensionMethod();
+    if (extensionMethod != null) {
+      if (MDC.get("method") != null && MDC.get("pathWithParams") != null) {
+        StringBuilder builder =
+            new StringBuilder()
+                .append(extensionMethod.getMethod().getName())
+                .append(".")
+                .append(MDC.get("method"))
+                .append(".")
+                .append(MDC.get("pathWithParams"));
+        return MetricRegistry.name(extensionMethod.getType(), builder.toString());
+      }
+    }
+    return null;
+  }
+}

api/src/main/java/marquez/logging/LoggingMdcFilter.java

@@ -6,14 +6,18 @@
 package marquez.logging;
 
 import java.io.IOException;
+import java.util.List;
 import java.util.UUID;
 import javax.ws.rs.container.CompletionCallback;
 import javax.ws.rs.container.ContainerRequestContext;
 import javax.ws.rs.container.ContainerRequestFilter;
 import javax.ws.rs.container.ContainerResponseContext;
 import javax.ws.rs.container.ContainerResponseFilter;
+import javax.ws.rs.core.Context;
 import javax.ws.rs.core.Response;
 import lombok.extern.slf4j.Slf4j;
+import org.glassfish.jersey.server.ExtendedUriInfo;
+import org.glassfish.jersey.uri.UriTemplate;
 import org.slf4j.MDC;
 
 /**
@@ -28,19 +32,30 @@ public class LoggingMdcFilter
   private static final String REQUEST_ID = "requestID";
   private static final String METHOD = "method";
   private static final String PATH = "path";
+  private static final String PATH_WITH_PARAMETERS = "pathWithParams";
+
+  @Context private ExtendedUriInfo uriInfo;
 
   @Override
   public void onComplete(Throwable throwable) {
     MDC.remove(REQUEST_ID);
     MDC.remove(METHOD);
     MDC.remove(PATH);
+    MDC.remove(PATH_WITH_PARAMETERS);
   }
 
   @Override
   public void filter(ContainerRequestContext requestContext) throws IOException {
     MDC.put(REQUEST_ID, UUID.randomUUID().toString());
     MDC.put(METHOD, requestContext.getMethod());
     MDC.put(PATH, requestContext.getUriInfo().getPath());
+    StringBuilder pathWithPlaceholders = new StringBuilder();
+
+    List<UriTemplate> matchedTemplates = uriInfo.getMatchedTemplates();
+    for (int i = matchedTemplates.size() - 1; i >= 0; i--) {
+      pathWithPlaceholders.append(matchedTemplates.get(i).getTemplate());
+    }
+    MDC.put(PATH_WITH_PARAMETERS, pathWithPlaceholders.toString());
   }
 
   @Override

api/src/main/java/marquez/logging/SmarterNameStrategy.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-2023 contributors to the Marquez project
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package marquez.logging;
+
+import com.codahale.metrics.jdbi3.strategies.DefaultNameStrategy;
+import com.codahale.metrics.jdbi3.strategies.DelegatingStatementNameStrategy;
+
+public class SmarterNameStrategy extends DelegatingStatementNameStrategy {
+
+  public SmarterNameStrategy() {
+    super(
+        DefaultNameStrategy.CHECK_EMPTY,
+        new EndpointNameStrategy(),
+        DefaultNameStrategy.SQL_OBJECT,
+        DefaultNameStrategy.CONSTANT_SQL_RAW);
+  }
+}