Add more fields to Bard logging

Author: samanehsan

src/main/java/bio/terra/app/usermetrics/BardEventProperties.java

@@ -6,5 +6,10 @@ private BardEventProperties() {}
   public static final String BILLING_PROFILE_ID_FIELD_NAME = "billingProfileId";
   public static final String METHOD_FIELD_NAME = "method";
   public static final String PATH_FIELD_NAME = "path";
+  public static final String SNAPSHOT_ID_FIELD_NAME = "snapshotId";
   public static final String SNAPSHOT_NAME_FIELD_NAME = "snapshotName";
+
+  public static final String DATASET_ID_FIELD_NAME = "datasetId";
+  public static final String DATASET_NAME_FIELD_NAME = "datasetName";
+  public static final String CLOUD_PLATFORM_FIELD_NAME = "cloudPlatform";
 }

src/main/java/bio/terra/app/usermetrics/UserLoggingMetrics.java

@@ -1,6 +1,7 @@
 package bio.terra.app.usermetrics;
 
 import java.util.HashMap;
+import org.apache.arrow.util.VisibleForTesting;
 import org.springframework.stereotype.Component;
 
 /**
@@ -45,4 +46,9 @@ public void setAll(HashMap<String, Object> value) {
     properties.putAll(value);
     metrics.set(properties);
   }
+
+  @VisibleForTesting
+  public void reset() {
+    metrics.get().clear();
+  }
 }

src/main/java/bio/terra/service/filedata/DrsService.java

@@ -491,10 +491,16 @@ private DRSAccessURL getAccessURL(
 
     BillingProfileModel billingProfileModel = cachedSnapshot.datasetBillingProfileModel;
 
+    loggingMetrics.set(BardEventProperties.DATASET_ID_FIELD_NAME, cachedSnapshot.getDatasetId());
+    loggingMetrics.set(
+        BardEventProperties.DATASET_NAME_FIELD_NAME, cachedSnapshot.getDatasetName());
+    loggingMetrics.set(BardEventProperties.SNAPSHOT_ID_FIELD_NAME, snapshotId);
     loggingMetrics.set(BardEventProperties.SNAPSHOT_NAME_FIELD_NAME, cachedSnapshot.getName());
     loggingMetrics.set(
         BardEventProperties.BILLING_PROFILE_ID_FIELD_NAME,
         cachedSnapshot.getSnapshotBillingProfileId());
+    loggingMetrics.set(
+        BardEventProperties.CLOUD_PLATFORM_FIELD_NAME, cachedSnapshot.getCloudPlatform());
 
     assertAccessMethodMatchingAccessId(accessId, drsObject);
 
@@ -1002,6 +1008,8 @@ static class SnapshotCacheResult {
     private final CloudPlatform cloudPlatform;
     private final String googleProjectId;
     private final String datasetProjectId;
+    private final UUID datasetId;
+    private final String datasetName;
     private final boolean globalFileIds;
 
     public SnapshotCacheResult(Snapshot snapshot) {
@@ -1025,6 +1033,8 @@ public SnapshotCacheResult(Snapshot snapshot) {
       } else {
         this.datasetProjectId = null;
       }
+      this.datasetId = snapshot.getSourceDataset().getId();
+      this.datasetName = snapshot.getSourceDataset().getName();
     }
 
     public UUID getId() {
@@ -1035,8 +1045,20 @@ public String getName() {
       return this.name;
     }
 
+    public UUID getDatasetId() {
+      return this.datasetId;
+    }
+
+    public String getDatasetName() {
+      return this.datasetName;
+    }
+
     public UUID getSnapshotBillingProfileId() {
       return snapshotBillingProfileId;
     }
+
+    public CloudPlatform getCloudPlatform() {
+      return this.cloudPlatform;
+    }
   }
 }

src/test/java/bio/terra/app/usermetrics/UserMetricsInterceptorTest.java

@@ -15,6 +15,7 @@
 import bio.terra.common.fixtures.AuthenticationFixtures;
 import bio.terra.common.iam.AuthenticatedUserRequest;
 import bio.terra.common.iam.AuthenticatedUserRequestFactory;
+import bio.terra.model.CloudPlatform;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import java.util.List;
@@ -69,6 +70,7 @@ class UserMetricsInterceptorTest {
 
   @BeforeEach
   void setUp() {
+    eventProperties.reset();
     when(metricsConfig.ignorePaths()).thenReturn(List.of());
     when(metricsConfig.appId()).thenReturn(APP_ID);
     when(metricsConfig.bardBasePath()).thenReturn(BARD_BASE_PATH);
@@ -126,10 +128,19 @@ void testSendEvent() throws Exception {
 
   @Test
   void testSendEventWithAdditionalProperties() throws Exception {
+    UUID datasetId = UUID.randomUUID();
+    String datasetName = "datasetName";
+    UUID snapshotId = UUID.randomUUID();
     String snapshotName = "snapshotName";
     String billingProfileId = UUID.randomUUID().toString();
-    eventProperties.set(BardEventProperties.BILLING_PROFILE_ID_FIELD_NAME, billingProfileId);
+    CloudPlatform cloudPlatform = CloudPlatform.GCP;
+
+    eventProperties.set(BardEventProperties.DATASET_ID_FIELD_NAME, datasetId);
+    eventProperties.set(BardEventProperties.DATASET_NAME_FIELD_NAME, datasetName);
+    eventProperties.set(BardEventProperties.SNAPSHOT_ID_FIELD_NAME, snapshotId);
     eventProperties.set(BardEventProperties.SNAPSHOT_NAME_FIELD_NAME, snapshotName);
+    eventProperties.set(BardEventProperties.BILLING_PROFILE_ID_FIELD_NAME, billingProfileId);
+    eventProperties.set(BardEventProperties.CLOUD_PLATFORM_FIELD_NAME, cloudPlatform);
 
     mockRequestAuth(request);
 
@@ -144,8 +155,12 @@ void testSendEventWithAdditionalProperties() throws Exception {
                     Map.of(
                         BardEventProperties.METHOD_FIELD_NAME, METHOD.toUpperCase(),
                         BardEventProperties.PATH_FIELD_NAME, REQUEST_URI,
+                        BardEventProperties.DATASET_ID_FIELD_NAME, datasetId,
+                        BardEventProperties.DATASET_NAME_FIELD_NAME, datasetName,
+                        BardEventProperties.SNAPSHOT_ID_FIELD_NAME, snapshotId,
+                        BardEventProperties.SNAPSHOT_NAME_FIELD_NAME, snapshotName,
                         BardEventProperties.BILLING_PROFILE_ID_FIELD_NAME, billingProfileId,
-                        BardEventProperties.SNAPSHOT_NAME_FIELD_NAME, snapshotName),
+                        BardEventProperties.CLOUD_PLATFORM_FIELD_NAME, cloudPlatform),
                     APP_ID,
                     DNS_NAME)));