Add metric for variant build (#683)

Author: Tristan-WorkGH

src/main/java/org/gridsuite/modification/server/service/BuildWorkerService.java

@@ -7,14 +7,13 @@
 package org.gridsuite.modification.server.service;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.google.common.collect.Sets;
 import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
 import org.gridsuite.modification.server.BuildException;
 import org.gridsuite.modification.server.dto.BuildInfos;
 import org.gridsuite.modification.server.dto.NetworkModificationResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.messaging.Message;
 import org.springframework.stereotype.Service;
@@ -34,42 +33,28 @@
  * @author Franck Lecuyer <franck.lecuyer at rte-france.com>
  */
 @Service
+@RequiredArgsConstructor
 public class BuildWorkerService {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(BuildWorkerService.class);
 
     public static final String CANCEL_MESSAGE = "Build was canceled";
     public static final String FAIL_MESSAGE = "Build has failed";
 
-    private final NetworkModificationService networkModificationService;
-
-    private final NetworkModificationObserver networkModificationObserver;
-
-    private final ObjectMapper objectMapper;
-
-    private final BuildStoppedPublisherService stoppedPublisherService;
+    @NonNull private final NetworkModificationService networkModificationService;
+    @NonNull private final NetworkModificationObserver networkModificationObserver;
+    @NonNull private final ObjectMapper objectMapper;
+    @NonNull private final BuildStoppedPublisherService stoppedPublisherService;
+    @NonNull private NotificationService notificationService;
 
     private final Map<String, CompletableFuture<NetworkModificationResult>> futures = new ConcurrentHashMap<>();
 
     private final Map<String, BuildCancelContext> cancelBuildRequests = new ConcurrentHashMap<>();
 
-    private final Set<String> buildRequests = Sets.newConcurrentHashSet();
+    private final Set<String> buildRequests = ConcurrentHashMap.newKeySet();
 
     private final Lock lockRunAndCancel = new ReentrantLock();
 
-    @Autowired
-    private NotificationService notificationService;
-
-    public BuildWorkerService(@NonNull NetworkModificationService networkModificationService,
-                              @NonNull NetworkModificationObserver networkModificationObserver,
-                              @NonNull ObjectMapper objectMapper,
-                              @NonNull BuildStoppedPublisherService stoppedPublisherService) {
-        this.networkModificationService = networkModificationService;
-        this.networkModificationObserver = networkModificationObserver;
-        this.objectMapper = objectMapper;
-        this.stoppedPublisherService = stoppedPublisherService;
-    }
-
     private CompletableFuture<NetworkModificationResult> execBuildVariant(BuildExecContext execContext, BuildInfos buildInfos) {
         lockRunAndCancel.lock();
         try {
@@ -83,10 +68,9 @@ private CompletableFuture<NetworkModificationResult> execBuildVariant(BuildExecC
             buildRequests.add(execContext.getReceiver()); // receiver is the node uuid to build
 
             CompletableFuture<NetworkModificationResult> future = CompletableFuture.supplyAsync(() -> {
-                    LOGGER.info("Starting build on variant : {}", buildInfos.getDestinationVariantId());
-                    return networkModificationService.buildVariant(networkUuid, buildInfos);
-                }
-            );
+                LOGGER.info("Starting build on variant : {}", buildInfos.getDestinationVariantId());
+                return networkModificationObserver.observeBuild(execContext, () -> networkModificationService.buildVariant(networkUuid, buildInfos));
+            });
 
             futures.put(receiver, future);
 
@@ -98,7 +82,7 @@ private CompletableFuture<NetworkModificationResult> execBuildVariant(BuildExecC
 
     @Bean
     public Consumer<Message<String>> consumeBuild() {
-        return message -> networkModificationObserver.observeBuild(() -> {
+        return message -> networkModificationObserver.observeFullBuild(() -> {
             BuildExecContext execContext;
             try {
                 execContext = BuildExecContext.fromMessage(message, objectMapper);
@@ -117,7 +101,7 @@ private void startBuild(BuildExecContext execContext) {
             if (future != null && (result = future.join()) != null) {  // result available
                 notificationService.emitBuildResultMessage(result, execContext.getReceiver(), execContext.getWorkflowType(), execContext.getWorkflowInfos());
                 LOGGER.info("Build complete on node '{}'", execContext.getReceiver());
-            } else {  // result not available : stop build request
+            } else {  // result not available: stop build request
                 if (cancelBuildRequests.get(execContext.getReceiver()) != null) {
                     stoppedPublisherService.publishCancel(execContext.getReceiver(), CANCEL_MESSAGE, execContext.getWorkflowType(), execContext.getWorkflowInfos());
                 }

src/main/java/org/gridsuite/modification/server/service/NetworkModificationObserver.java

@@ -3,14 +3,18 @@
 import io.micrometer.core.instrument.Gauge;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.observation.Observation;
+import io.micrometer.observation.Observation.CheckedCallable;
+import io.micrometer.observation.Observation.CheckedRunnable;
 import io.micrometer.observation.ObservationRegistry;
 import lombok.NonNull;
+import lombok.RequiredArgsConstructor;
 import org.gridsuite.modification.ModificationType;
 import org.springframework.stereotype.Service;
 
 import java.util.concurrent.ThreadPoolExecutor;
 
 @Service
+@RequiredArgsConstructor
 public class NetworkModificationObserver {
     private static final String OBSERVATION_PREFIX = "app.network-modification.";
     private static final String MODIFICATION_TYPE_TAG_NAME = "modification_type";
@@ -20,20 +24,28 @@ public class NetworkModificationObserver {
     private static final String TASK_TYPE_TAG_VALUE_PENDING = "pending";
     private static final String TASK_POOL_METER_NAME_PREFIX = OBSERVATION_PREFIX + "tasks.pool.";
 
-    private final ObservationRegistry observationRegistry;
-    private final MeterRegistry meterRegistry;
+    @NonNull private final ObservationRegistry observationRegistry;
+    @NonNull private final MeterRegistry meterRegistry;
 
-    public NetworkModificationObserver(@NonNull ObservationRegistry observationRegistry, @NonNull MeterRegistry meterRegistry) {
-        this.observationRegistry = observationRegistry;
-        this.meterRegistry = meterRegistry;
+    public <E extends Throwable> void observeApply(final ModificationType modificationType, final CheckedRunnable<E> runnable) throws E {
+        this.createObservation("apply", modificationType).observeChecked(runnable);
     }
 
-    public <E extends Throwable> void observeApply(ModificationType modificationType, Observation.CheckedRunnable<E> runnable) throws E {
-        createObservation("apply", modificationType).observeChecked(runnable);
+    public <E extends Throwable> void observeFullBuild(final CheckedRunnable<E> runnable) throws E {
+        this.createObservation("consume_build_message").observeChecked(runnable);
     }
 
-    public <E extends Throwable> void observeBuild(Observation.CheckedRunnable<E> runnable) throws E {
-        createObservation("build").observeChecked(runnable);
+    public <R, E extends Throwable> R observeBuild(final BuildExecContext execContext, final CheckedCallable<R, E> callable) throws E {
+        Observation observation = this.createObservation("build")
+            .highCardinalityKeyValue("network_uuid", execContext.getNetworkUuid().toString());
+        //.highCardinalityKeyValue("receiver", execContext.getReceiver())
+        if (execContext.getBuildInfos().getOriginVariantId() != null) {
+            observation = observation.highCardinalityKeyValue("variant_origin", execContext.getBuildInfos().getOriginVariantId());
+        }
+        if (execContext.getBuildInfos().getDestinationVariantId() != null) {
+            observation = observation.highCardinalityKeyValue("variant_destination", execContext.getBuildInfos().getDestinationVariantId());
+        }
+        return observation.observeChecked(callable);
     }
 
     private Observation createObservation(String name, ModificationType modificationType) {