DRAFT: SWATCH-1924: Support querying prometheus/rhelemeter when "product" label has engIds

src/main/java/org/candlepin/subscriptions/metering/MeteringEventFactory.java

@@ -75,7 +75,8 @@ public static Event createMetricEvent(
       MetricId measuredMetric,
       Double measuredValue,
       String productTag,
-      UUID meteringBatchId) {
+      UUID meteringBatchId,
+      List<String> productIds) {
     Event event = new Event();
     updateMetricEvent(
         event,
@@ -93,7 +94,8 @@ public static Event createMetricEvent(
         measuredMetric,
         measuredValue,
         productTag,
-        meteringBatchId);
+        meteringBatchId,
+        productIds);
     return event;
   }
 
@@ -143,7 +145,8 @@ public static void updateMetricEvent(
       MetricId measuredMetric,
       Double measuredValue,
       String productTag,
-      UUID meteringBatchId) {
+      UUID meteringBatchId,
+      List<String> productIds) {
     toUpdate
         .withServiceType(serviceType)
         .withTimestamp(measuredTime)
@@ -160,7 +163,8 @@ public static void updateMetricEvent(
         .withEventType(MeteringEventFactory.getEventType(measuredMetric.getValue(), productTag))
         .withOrgId(orgId)
         .withInstanceId(instanceId)
-        .withMeteringBatchId(meteringBatchId);
+        .withMeteringBatchId(meteringBatchId)
+        .withProductIds(productIds);
   }
 
   public static String getEventType(String metricId, String productTag) {

src/main/java/org/candlepin/subscriptions/metering/service/prometheus/PrometheusMeteringController.java

@@ -26,9 +26,12 @@
 import com.redhat.swatch.configuration.registry.MetricId;
 import com.redhat.swatch.configuration.registry.SubscriptionDefinition;
 import io.micrometer.core.annotation.Timed;
+import jakarta.validation.constraints.NotNull;
 import jakarta.ws.rs.BadRequestException;
 import java.math.BigDecimal;
 import java.time.OffsetDateTime;
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
@@ -197,11 +200,15 @@ private void sendEventFromData(
     String product = labels.get("product");
     String resourceName = labels.get("resource_name");
 
+    // TODO update this note
     // NOTE: Role comes from the product label despite its name. The values set
     // here are NOT engineering or swatch product IDs. They map to the roles in
     // the swatch-product-configuration library. For openshift, the values will
     // be 'ocp' or 'osd'.
     String role = product == null ? resourceName : product;
+
+    List<String> productIds = extractProductIdsFromProductLabel(product);
+
     String billingProvider = labels.get("billing_marketplace");
     String billingAccountId = labels.get("billing_marketplace_account");
 
@@ -221,7 +228,7 @@ private void sendEventFromData(
       Event event =
           createOrUpdateEvent(
               orgId,
-              tagMetric.getId(),
+              productIds,
               clusterId,
               sla,
               usage,
@@ -243,6 +250,41 @@ private void sendEventFromData(
     }
   }
 
+  @NotNull
+  protected List<String> extractProductIdsFromProductLabel(String product) {
+    List<String> productIds = new ArrayList<>();
+
+    /*
+      The regular expression pattern matches a sequence of numbers separated by commas with optional spaces in between.
+
+      Explanation:
+      ^          : Asserts the start of the line.
+      \d+        : Matches one or more digits (0-9).
+      (          : Starts a group that contains the following sequence:
+        ,        : Matches a comma.
+        \s*      : Matches zero or more whitespace characters.
+        \d+      : Matches one or more digits (0-9).
+      )*+        : The whole group can repeat zero or more times (including the comma followed by digits),
+                   and the possessive quantifier (*+) prevents excessive backtracking.
+
+      Example:
+      - 123,456,789: Matches a sequence of numbers separated by commas and optional spaces: 123, 456, 789.
+      - 1,23,4:     Matches a sequence of numbers separated by commas and optional spaces: 1, 23, 4.
+      - 100:        Matches a single number: 100.
+
+      Note: This pattern may lead to catastrophic backtracking for extremely large inputs due to its repetitive nature.
+    */
+
+    String pattern = "^\\d+(,\\s*\\d+)*+";
+
+    boolean isEngIdList = product != null && product.matches(pattern);
+
+    if (isEngIdList) {
+      productIds = Arrays.asList(product.split(","));
+    }
+    return productIds;
+  }
+
   private void sendCleanUpEvent(
       String productTag,
       String orgId,
@@ -263,7 +305,7 @@ private void sendCleanUpEvent(
   @SuppressWarnings("java:S107")
   private Event createOrUpdateEvent(
       String orgId,
-      String metricId,
+      List<String> productIds,
       String instanceId,
       String sla,
       String usage,
@@ -294,7 +336,8 @@ private Event createOrUpdateEvent(
         metric,
         value.doubleValue(),
         productTag,
-        meteringBatchId);
+        meteringBatchId,
+        productIds);
     return event;
   }
 

src/main/java/org/candlepin/subscriptions/tally/MetricUsageCollector.java

@@ -476,6 +476,8 @@ private Set<String> getProductIds(Event event) {
           .ifPresent(productIds::add);
     }
 
+    // TODO bookmark
+
     var engIds = Optional.ofNullable(event.getProductIds()).orElse(Collections.emptyList());
     for (String engId : engIds) {
       productIds.addAll(

src/main/resources/application-metrics-rhel.yaml

@@ -11,7 +11,7 @@ rhsm-subscriptions:
           default: >-
             max(#{metric.prometheus.queryParams[metric]}) by (#{metric.prometheus.queryParams[instanceKey]})
             * on(#{metric.prometheus.queryParams[instanceKey]}) group_right
-            min_over_time(#{metric.prometheus.queryParams[metadataMetric]}{product="#{metric.prometheus.queryParams[product]}", external_organization="#{runtime[orgId]}", billing_model="marketplace", support=~"Premium|Standard|Self-Support|None"}[1h])
+            min_over_time(#{metric.prometheus.queryParams[metadataMetric]}{product=~"#{metric.prometheus.queryParams[product]}", external_organization="#{runtime[orgId]}", billing_model="marketplace", support=~"Premium|Standard|Self-Support|None"}[1h])
           addonSamples: >-
             max(#{metric.prometheus.queryParams[metric]}) by (#{metric.prometheus.queryParams[instanceKey]})
             * on(#{metric.prometheus.queryParams[instanceKey]}) group_right

src/main/resources/application-openshift-metering-worker.yaml

@@ -12,7 +12,7 @@ rhsm-subscriptions:
           default: >-
             max(#{metric.prometheus.queryParams[metric]}) by (#{metric.prometheus.queryParams[instanceKey]})
             * on(#{metric.prometheus.queryParams[instanceKey]}) group_right
-            min_over_time(#{metric.prometheus.queryParams[metadataMetric]}{product="#{metric.prometheus.queryParams[product]}", external_organization="#{runtime[orgId]}", billing_model="marketplace", support=~"Premium|Standard|Self-Support|None"}[1h])
+            min_over_time(#{metric.prometheus.queryParams[metadataMetric]}{product=~"#{metric.prometheus.queryParams[product]}", external_organization="#{runtime[orgId]}", billing_model="marketplace", support=~"Premium|Standard|Self-Support|None"}[1h])
           addonSamples: >-
             max(#{metric.prometheus.queryParams[metric]}) by (#{metric.prometheus.queryParams[instanceKey]})
             * on(#{metric.prometheus.queryParams[instanceKey]}) group_right

src/main/resources/application.yaml

@@ -51,7 +51,7 @@ rhsm-subscriptions:
       metric:
         accountQueryTemplates:
           default: >-
-            ${OPENSHIFT_ENABLED_ACCOUNT_PROMQL:group(min_over_time(#{metric.prometheus.queryParams[metadataMetric]}{product='#{metric.prometheus.queryParams[product]}', external_organization != '', billing_model='marketplace'}[1h]))
+            ${OPENSHIFT_ENABLED_ACCOUNT_PROMQL:group(min_over_time(#{metric.prometheus.queryParams[metadataMetric]}{product=~'#{metric.prometheus.queryParams[product]}', external_organization != '', billing_model='marketplace'}[1h]))
             by (external_organization)}
           addonSamples: >-
             ${OPENSHIFT_ENABLED_ACCOUNT_PROMQL:group(min_over_time(#{metric.prometheus.queryParams[metadataMetric]}{resource_type="addon", resource_name='#{metric.prometheus.queryParams[resourceName]}', external_organization != '', billing_model='marketplace'}[1h]))

src/test/java/org/candlepin/subscriptions/metering/MeteringEventFactoryTest.java

@@ -27,6 +27,7 @@
 import com.redhat.swatch.configuration.registry.MetricId;
 import com.redhat.swatch.configuration.util.MetricIdUtils;
 import java.time.OffsetDateTime;
+import java.util.List;
 import java.util.Optional;
 import java.util.UUID;
 import org.candlepin.subscriptions.json.Event;
@@ -73,7 +74,8 @@ void testOpenShiftClusterCoresEventCreation() {
             uom,
             measuredValue,
             productTag,
-            meteringBatchId);
+            meteringBatchId,
+            List.of());
 
     assertEquals(orgId, event.getOrgId());
     assertEquals(measuredTime, event.getTimestamp());
@@ -111,7 +113,8 @@ void testOpenShiftClusterCoresHandlesNullServiceLevel() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertNull(event.getSla());
   }
 
@@ -133,7 +136,8 @@ void testOpenShiftClusterCoresSlaSetToEmptyForSlaValueNone() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertEquals(Sla.__EMPTY__, event.getSla());
   }
 
@@ -155,7 +159,8 @@ void testOpenShiftClusterCoresInvalidSlaWillNotBeSetOnEvent() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertNull(event.getSla());
   }
 
@@ -177,7 +182,8 @@ void testOpenShiftClusterCoresInvalidUsageSetsNullValue() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertNull(event.getUsage());
   }
 
@@ -199,7 +205,8 @@ void testOpenShiftClusterCoresHandlesNullUsage() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertNull(event.getUsage());
   }
 
@@ -221,7 +228,8 @@ void testOpenShiftClusterCoresInvalidRoleSetsNullValue() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertNull(event.getRole());
   }
 
@@ -243,7 +251,8 @@ void testOpenShiftClusterCoresHandlesNullRole() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertNull(event.getRole());
   }
 
@@ -265,7 +274,8 @@ void testHandlesValidBillingData() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertEquals(BillingProvider.AWS, event.getBillingProvider());
     assertTrue(event.getBillingAccountId().isPresent());
     assertEquals("aws_account_123", event.getBillingAccountId().get());
@@ -289,7 +299,8 @@ void testHandlesNullBillingData() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertEquals(BillingProvider.RED_HAT, event.getBillingProvider());
     assertTrue(event.getBillingAccountId().isEmpty());
   }
@@ -312,7 +323,8 @@ void testBillingProviderEmptyForBillingProviderValueNoneToDefaultRedHat() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertEquals(BillingProvider.RED_HAT, event.getBillingProvider());
   }
 
@@ -334,7 +346,8 @@ void testInvalidBillingProviderWillNotBeSetOnEvent() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertNull(event.getBillingProvider());
   }
 
@@ -356,7 +369,8 @@ void testEventTypeGeneratedOnEventCreation() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertEquals("snapshot_openshift-dedicated-metrics_cores", event.getEventType());
   }
 
@@ -386,7 +400,8 @@ void testRhmNormalizedToRedHat() {
             MetricIdUtils.getCores(),
             12.5,
             productTag,
-            UUID.randomUUID());
+            UUID.randomUUID(),
+            List.of());
     assertEquals(BillingProvider.RED_HAT, event.getBillingProvider());
   }
 }