Merge pull request #9663 from lassewesth/metricssocalledfacade

clean up Metrics

Author: lassewesth

cypher-aggregation/src/integrationTest/java/org/neo4j/gds/projection/ProductGraphAggregatorTest.java

@@ -28,7 +28,7 @@
 import org.neo4j.gds.core.loading.GraphStoreCatalog;
 import org.neo4j.gds.core.utils.progress.EmptyTaskStore;
 import org.neo4j.gds.logging.Log;
-import org.neo4j.gds.metrics.MetricsFacade;
+import org.neo4j.gds.metrics.projections.ProjectionMetricsService;
 import org.neo4j.values.storable.NoValue;
 import org.neo4j.values.storable.Values;
 import org.neo4j.values.virtual.MapValue;
@@ -52,7 +52,7 @@ void shouldImportHighNodeIds() {
             WriteMode.LOCAL,
             QueryEstimator.empty(),
             ExecutingQueryProvider.empty(),
-            MetricsFacade.PASSTHROUGH_METRICS_FACADE.projectionMetrics(),
+            ProjectionMetricsService.DISABLED,
             EmptyTaskStore.INSTANCE,
             Log.noOpLog()
         );
@@ -91,7 +91,7 @@ void shouldFailOnEmptyGraphName(String emptyGraphName, String description) {
             WriteMode.LOCAL,
             QueryEstimator.empty(),
             ExecutingQueryProvider.empty(),
-            MetricsFacade.PASSTHROUGH_METRICS_FACADE.projectionMetrics(),
+            ProjectionMetricsService.DISABLED,
             EmptyTaskStore.INSTANCE,
             Log.noOpLog()
         );

cypher-aggregation/src/main/java/org/neo4j/gds/projection/AlphaCypherAggregation.java

@@ -25,7 +25,7 @@
 import org.neo4j.gds.compat.Neo4jProxy;
 import org.neo4j.gds.compat.UserFunctionSignatureBuilder;
 import org.neo4j.gds.core.loading.Capabilities.WriteMode;
-import org.neo4j.gds.metrics.MetricsFacade;
+import org.neo4j.gds.metrics.Metrics;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 import org.neo4j.internal.kernel.api.procs.Neo4jTypes;
 import org.neo4j.internal.kernel.api.procs.QualifiedName;
@@ -87,7 +87,7 @@ public AggregationResult procedureSyntax(
     @Override
     public UserAggregationReducer createReducer(Context ctx) throws ProcedureException {
         var databaseService = ctx.graphDatabaseAPI();
-        var metricsFacade = Neo4jProxy.lookupComponentProvider(ctx, MetricsFacade.class, true);
+        var metrics = Neo4jProxy.lookupComponentProvider(ctx, Metrics.class, true);
         var username = ctx.kernelTransaction().securityContext().subject().executingUser();
         var transaction = ctx.transaction();
         var ktxs = GraphDatabaseApiProxy.resolveDependency(databaseService, KernelTransactions.class);
@@ -109,7 +109,7 @@ public UserAggregationReducer createReducer(Context ctx) throws ProcedureExcepti
             writeMode,
             queryProvider,
             QueryEstimator.empty(),
-            metricsFacade.projectionMetrics()
+            metrics.projectionMetrics()
         );
     }
 }

cypher-aggregation/src/main/java/org/neo4j/gds/projection/CypherAggregation.java

@@ -27,7 +27,7 @@
 import org.neo4j.gds.core.loading.Capabilities.WriteMode;
 import org.neo4j.gds.core.utils.progress.TaskStore;
 import org.neo4j.gds.logging.LogAdapter;
-import org.neo4j.gds.metrics.MetricsFacade;
+import org.neo4j.gds.metrics.Metrics;
 import org.neo4j.gds.transaction.DatabaseTransactionContext;
 import org.neo4j.internal.kernel.api.exceptions.ProcedureException;
 import org.neo4j.internal.kernel.api.procs.Neo4jTypes;
@@ -87,7 +87,7 @@ public AggregationResult procedureSyntax(
     @Override
     public UserAggregationReducer createReducer(Context ctx) throws ProcedureException {
         var databaseService = ctx.graphDatabaseAPI();
-        var metricsFacade = Neo4jProxy.lookupComponentProvider(ctx, MetricsFacade.class, true);
+        var metrics = Neo4jProxy.lookupComponentProvider(ctx, Metrics.class, true);
         var taskStore = Neo4jProxy.lookupComponentProvider(ctx, TaskStore.class, true);
         var log = Neo4jProxy.lookupComponentProvider(ctx, Log.class, true);
         var username = ctx.kernelTransaction().securityContext().subject().executingUser();
@@ -121,7 +121,7 @@ public UserAggregationReducer createReducer(Context ctx) throws ProcedureExcepti
             writeMode,
             queryEstimator,
             queryProvider,
-            metricsFacade.projectionMetrics(),
+            metrics.projectionMetrics(),
             taskStore,
             new LogAdapter(log)
         );

executor/src/integrationTest/java/org/neo4j/gds/executor/MemoryEstimationExecutorTest.java

@@ -40,7 +40,7 @@
 import org.neo4j.gds.core.utils.warnings.EmptyUserLogRegistryFactory;
 import org.neo4j.gds.gdl.GdlGraphs;
 import org.neo4j.gds.logging.Log;
-import org.neo4j.gds.metrics.MetricsFacade;
+import org.neo4j.gds.metrics.Metrics;
 import org.neo4j.gds.projection.GraphProjectFromStoreConfig;
 import org.neo4j.gds.termination.TerminationMonitor;
 import org.neo4j.gds.test.TestAlgorithm;
@@ -84,7 +84,7 @@ void setup() throws Exception {
             .nodeLookup(NodeLookup.EMPTY)
             .modelCatalog(ModelCatalog.EMPTY)
             .isGdsAdmin(false)
-            .metricsFacade(MetricsFacade.PASSTHROUGH_METRICS_FACADE)
+            .metrics(Metrics.DISABLED)
             .build();
 
         memoryEstimationExecutor = new MemoryEstimationExecutor<>(

executor/src/integrationTest/java/org/neo4j/gds/executor/ProcedureExecutorTest.java

@@ -40,7 +40,7 @@
 import org.neo4j.gds.extension.GdlGraph;
 import org.neo4j.gds.extension.Inject;
 import org.neo4j.gds.logging.Log;
-import org.neo4j.gds.metrics.MetricsFacade;
+import org.neo4j.gds.metrics.Metrics;
 import org.neo4j.gds.termination.TerminationMonitor;
 import org.neo4j.gds.utils.StringJoining;
 
@@ -153,7 +153,7 @@ public boolean containsDependency(Class<?> type) {
             .closeableResourceRegistry(CloseableResourceRegistry.EMPTY)
             .nodeLookup(NodeLookup.EMPTY)
             .userLogRegistryFactory(EmptyUserLogRegistryFactory.INSTANCE)
-            .metricsFacade(MetricsFacade.PASSTHROUGH_METRICS_FACADE)
+            .metrics(Metrics.DISABLED)
             .build();
     }
 

executor/src/main/java/org/neo4j/gds/executor/ExecutionContext.java

@@ -34,7 +34,7 @@
 import org.neo4j.gds.core.write.NodePropertyExporterBuilder;
 import org.neo4j.gds.core.write.RelationshipExporterBuilder;
 import org.neo4j.gds.logging.Log;
-import org.neo4j.gds.metrics.MetricsFacade;
+import org.neo4j.gds.metrics.Metrics;
 import org.neo4j.gds.procedures.algorithms.AlgorithmsProcedureFacade;
 import org.neo4j.gds.termination.TerminationMonitor;
 
@@ -66,7 +66,7 @@ public interface ExecutionContext {
 
     boolean isGdsAdmin();
 
-    MetricsFacade metricsFacade();
+    Metrics metrics();
 
     @Nullable
     AlgorithmsProcedureFacade algorithmsProcedureFacade();
@@ -169,8 +169,8 @@ public boolean isGdsAdmin() {
         }
 
         @Override
-        public MetricsFacade metricsFacade() {
-            return MetricsFacade.PASSTHROUGH_METRICS_FACADE;
+        public Metrics metrics() {
+            return Metrics.DISABLED;
         }
 
         @Override

executor/src/main/java/org/neo4j/gds/executor/ProcedureExecutor.java

@@ -116,7 +116,7 @@ public RESULT compute(
         algo.getProgressTracker().setEstimatedResourceFootprint(memoryEstimationInBytes, config.concurrency());
 
 
-        ALGO_RESULT result = executeAlgorithm(builder, algo, executionContext.metricsFacade().algorithmMetrics());
+        ALGO_RESULT result = executeAlgorithm(builder, algo, executionContext.metrics().algorithmMetrics());
 
         var computationResult = builder
             .graph(graph)

metrics-api/src/main/java/org/neo4j/gds/metrics/ExecutionMetric.java

@@ -20,6 +20,22 @@
 package org.neo4j.gds.metrics;
 
 public abstract class ExecutionMetric implements AutoCloseable {
+    static final ExecutionMetric DISABLED = new ExecutionMetric("disabled") {
+        @Override
+        public void start() {
+            // do nothing
+        }
+
+        @Override
+        public void failed(Exception e) {
+            // do nothing
+        }
+
+        @Override
+        public void close() {
+            // do nothing
+        }
+    };
 
     protected final String operation;
 

metrics-api/src/main/java/org/neo4j/gds/metrics/ExecutionMetricRegistrar.java

@@ -20,7 +20,7 @@
 package org.neo4j.gds.metrics;
 
 public interface ExecutionMetricRegistrar {
+    ExecutionMetricRegistrar DISABLED = __ -> ExecutionMetric.DISABLED;
 
     ExecutionMetric create(String algorithm);
-
 }

metrics-api/src/main/java/org/neo4j/gds/metrics/MetricsFacade.java renamed to metrics-api/src/main/java/org/neo4j/gds/metrics/Metrics.java

@@ -23,19 +23,21 @@
 import org.neo4j.gds.metrics.procedures.DeprecatedProceduresMetricService;
 import org.neo4j.gds.metrics.projections.ProjectionMetricsService;
 
-public class MetricsFacade {
-
-    public static final MetricsFacade PASSTHROUGH_METRICS_FACADE = new MetricsFacade(
-        new AlgorithmMetricsService(new PassthroughExecutionMetricRegistrar()),
-        new ProjectionMetricsService(new PassthroughExecutionMetricRegistrar()),
-        DeprecatedProceduresMetricService.PASSTHROUGH
+/**
+ * This is a <a href="https://refactoring.com/catalog/introduceParameterObject.html">parameter object</a> for all things metrics.
+ */
+public class Metrics {
+    public static final Metrics DISABLED = new Metrics(
+        AlgorithmMetricsService.DISABLED,
+        ProjectionMetricsService.DISABLED,
+        DeprecatedProceduresMetricService.DISABLED
     );
 
     private final AlgorithmMetricsService algorithmMetricsService;
     private final ProjectionMetricsService projectionMetricsService;
     private final DeprecatedProceduresMetricService deprecatedProceduresMetricService;
 
-    public MetricsFacade(
+    public Metrics(
         AlgorithmMetricsService algorithmMetricsService,
         ProjectionMetricsService projectionMetricsService,
         DeprecatedProceduresMetricService deprecatedProceduresMetricService

metrics-api/src/main/java/org/neo4j/gds/metrics/PassthroughExecutionMetric.java

@@ -19,10 +19,11 @@
  */
 package org.neo4j.gds.metrics.algorithms;
 
-import org.neo4j.gds.metrics.ExecutionMetricRegistrar;
 import org.neo4j.gds.metrics.ExecutionMetric;
+import org.neo4j.gds.metrics.ExecutionMetricRegistrar;
 
 public class AlgorithmMetricsService {
+    public static final AlgorithmMetricsService DISABLED = new AlgorithmMetricsService(ExecutionMetricRegistrar.DISABLED);
 
     private final ExecutionMetricRegistrar metricRegistrar;
 

metrics-api/src/main/java/org/neo4j/gds/metrics/PassthroughExecutionMetricRegistrar.java

@@ -20,6 +20,7 @@
 package org.neo4j.gds.metrics.procedures;
 
 public interface DeprecatedProceduresMetricRegistrar {
+    DeprecatedProceduresMetricRegistrar DISABLED = __ -> {};
 
     void called(String deprecatedProcedure);
 }

metrics-api/src/main/java/org/neo4j/gds/metrics/algorithms/AlgorithmMetricsService.java

@@ -20,8 +20,7 @@
 package org.neo4j.gds.metrics.procedures;
 
 public final class DeprecatedProceduresMetricService {
-
-    public static final DeprecatedProceduresMetricService PASSTHROUGH = new DeprecatedProceduresMetricService(new PassthroughDeprecatedProceduresMetricRegistrar());
+    public static final DeprecatedProceduresMetricService DISABLED = new DeprecatedProceduresMetricService(DeprecatedProceduresMetricRegistrar.DISABLED);
 
     private final DeprecatedProceduresMetricRegistrar registrar;
 
@@ -32,5 +31,4 @@ public DeprecatedProceduresMetricService(DeprecatedProceduresMetricRegistrar reg
     public void called(String deprecatedProcedure) {
         registrar.called(deprecatedProcedure);
     }
-
 }

metrics-api/src/main/java/org/neo4j/gds/metrics/procedures/DeprecatedProceduresMetricRegistrar.java

@@ -23,6 +23,7 @@
 import org.neo4j.gds.metrics.ExecutionMetricRegistrar;
 
 public class ProjectionMetricsService {
+    public static final ProjectionMetricsService DISABLED = new ProjectionMetricsService(ExecutionMetricRegistrar.DISABLED);
 
     private final ExecutionMetricRegistrar metricRegistrar;
 
@@ -49,5 +50,4 @@ public ExecutionMetric createSubGraph() {
     public ExecutionMetric createRandomWakSampling(String type) {
         return metricRegistrar.create(type);
     }
-
 }