add default views

EddeCCC · EddeCCC · commit 4f2b5a90e74f · 2025-09-30T14:52:17.000+02:00
diff --git a/src/main/java/rocks/inspectit/ocelot/eum/server/configuration/model/metrics/definition/MetricDefinitionSettings.java b/src/main/java/rocks/inspectit/ocelot/eum/server/configuration/model/metrics/definition/MetricDefinitionSettings.java
@@ -8,9 +8,10 @@
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
 import org.springframework.util.CollectionUtils;
+import rocks.inspectit.ocelot.eum.server.configuration.model.metrics.definition.view.AggregationType;
 import rocks.inspectit.ocelot.eum.server.configuration.model.metrics.definition.view.ViewDefinitionSettings;
 
-import java.time.Duration;
+import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -39,7 +40,7 @@ public class MetricDefinitionSettings {
 
     @NotNull
     @Builder.Default
-    private InstrumentValueType valueType = InstrumentValueType.DOUBLE;
+    private InstrumentValueType valueType = InstrumentValueType.LONG;
 
     /**
      * The description of the metric.
@@ -49,7 +50,6 @@ public class MetricDefinitionSettings {
 
     /**
      * Maps view names to their definitions for the metric defined by this {@link MetricDefinitionSettings}.
-     * If this map is null, OpenTelemetry will create a default view automatically.
      */
     @Singular
     private Map<@NotBlank String, @Valid @NotNull ViewDefinitionSettings> views;
@@ -68,6 +68,32 @@ public MetricDefinitionSettings getCopyWithDefaultsPopulated(String metricName)
         if(!CollectionUtils.isEmpty(views)) {
             views.forEach((name, def) -> result.view(name, def.getCopyWithDefaultsPopulated(resultDescription, unit)));
         }
+        else {
+            /*
+                If there are no views specified, we will create a default view which only sets the default
+                OpenTelemetry aggregation for the particular instrument type.
+                Otherwise, we would not know about this view and could not set a proper AttributesProcessor
+                in the ViewManager to regulate, which attributes are allowed for the metric
+             */
+            Map<String, ViewDefinitionSettings> defaultView = new HashMap<>();
+            val builder =  ViewDefinitionSettings.builder();
+            switch (instrumentType) {
+                case GAUGE:
+                    ViewDefinitionSettings gaugeView = builder.aggregation(AggregationType.LAST_VALUE).build();
+                    defaultView.put(metricName, gaugeView);
+                    break;
+                case COUNTER:
+                case UP_DOWN_COUNTER:
+                    ViewDefinitionSettings counterView = builder.aggregation(AggregationType.SUM).build();
+                    defaultView.put(metricName, counterView);
+                    break;
+                case HISTOGRAM:
+                    ViewDefinitionSettings histogramView = builder.aggregation(AggregationType.HISTOGRAM).build();
+                    defaultView.put(metricName, histogramView);
+                    break;
+            }
+            result.views(defaultView);
+        }
 
         return result.build();
     }
diff --git a/src/main/java/rocks/inspectit/ocelot/eum/server/metrics/InstrumentManager.java b/src/main/java/rocks/inspectit/ocelot/eum/server/metrics/InstrumentManager.java
@@ -61,7 +61,7 @@ public void createInstrument(String metricName, MetricDefinitionSettings metricD
             }
 
             val views = populatedMetricDefinition.getViews();
-            if(!CollectionUtils.isEmpty(views)) {
+            if (!CollectionUtils.isEmpty(views)) {
                 views.values().forEach(view -> attributesRegistry.processAttributeKeysForView(view));
             }
         }
diff --git a/src/main/java/rocks/inspectit/ocelot/eum/server/metrics/timewindow/worker/TimeWindowMetricProducer.java b/src/main/java/rocks/inspectit/ocelot/eum/server/metrics/timewindow/worker/TimeWindowMetricProducer.java
@@ -4,7 +4,6 @@
 import io.opentelemetry.sdk.metrics.data.MetricData;
 import io.opentelemetry.sdk.metrics.export.MetricProducer;
 import io.opentelemetry.sdk.resources.Resource;
-import lombok.AllArgsConstructor;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 import rocks.inspectit.ocelot.eum.server.metrics.timewindow.TimeWindowViewManager;
@@ -23,7 +22,7 @@
  * Otherwise, e.g. spamming F5 on the prometheus endpoint could lead to an increased CPU usage.
  */
 @Component
-public class CachingMetricProducer implements MetricProducer {
+public class TimeWindowMetricProducer implements MetricProducer {
 
     @Autowired
     private TimeWindowViewManager viewManager;
diff --git a/src/main/java/rocks/inspectit/ocelot/eum/server/opentelemetry/metrics/ViewManager.java b/src/main/java/rocks/inspectit/ocelot/eum/server/opentelemetry/metrics/ViewManager.java
@@ -10,12 +10,18 @@
 import rocks.inspectit.ocelot.eum.server.configuration.model.metrics.definition.MetricDefinitionSettings;
 import rocks.inspectit.ocelot.eum.server.configuration.model.metrics.definition.view.AggregationType;
 import rocks.inspectit.ocelot.eum.server.configuration.model.metrics.definition.view.ViewDefinitionSettings;
+import rocks.inspectit.ocelot.eum.server.metrics.InstrumentManager;
 import rocks.inspectit.ocelot.eum.server.metrics.timewindow.TimeWindowViewManager;
 
 import java.util.*;
 
 /**
- * Registers all user-specified metric views.
+ * Stores all active OpenTelemetry metric views.
+ * <br>
+ * Note that if we do not register any view for an instrument (see {@link InstrumentManager}),
+ * OpenTelemetry would use a default view automatically to record data.
+ * However, this default view would not filter any attributes and thus would use every attribute,
+ * which was passed during recording. To prevent this, we should register at least one view for every metric by ourselves.
  */
 @Component
 public class ViewManager {
@@ -126,13 +132,17 @@ private View createView(String viewName, ViewDefinitionSettings settings) {
                 .setDescription(settings.getDescription())
                 .setAggregation(aggregation)
                 .setCardinalityLimit(settings.getCardinalityLimit());
+        boolean withCommonAttributes = settings.isWithCommonAttributes();
 
         if (!CollectionUtils.isEmpty(settings.getAttributes())) {
             builder.setAttributeFilter((attribute) -> filterAttribute(settings, attribute));
         }
-        else {
+        else if (withCommonAttributes){
             builder.setAttributeFilter(this::isDefinedAsGlobal);
         }
+        else {
+            builder.setAttributeFilter((attr) -> false); // reject all attributes
+        }
 
         return builder.build();
     }
diff --git a/src/test/java/rocks/inspectit/ocelot/eum/server/metrics/InstrumentManagerTest.java b/src/test/java/rocks/inspectit/ocelot/eum/server/metrics/InstrumentManagerTest.java
@@ -45,13 +45,13 @@ void shouldCreateInstrumentAndProcessAttributes() {
     }
 
     @Test
-    void shouldCreateInstrumentAndNotProcessAttributesWhenNoViews() {
+    void shouldCreateInstrumentAndProcessAttributesWhenNoViews() {
         MetricDefinitionSettings metric = new MetricDefinitionSettings();
 
         manager.createInstrument(metricName, metric);
 
         verify(factory).createInstrument(anyString(), any(MetricDefinitionSettings.class));
-        verifyNoInteractions(registry);
+        verify(registry).processAttributeKeysForView(any(ViewDefinitionSettings.class));
     }
 
     @Test
diff --git a/src/test/java/rocks/inspectit/ocelot/eum/server/metrics/timewindow/worker/TimeWindowMetricProducerTest.java b/src/test/java/rocks/inspectit/ocelot/eum/server/metrics/timewindow/worker/TimeWindowMetricProducerTest.java
@@ -24,13 +24,13 @@
 import static rocks.inspectit.ocelot.eum.server.metrics.timewindow.utils.TimeWindowTestUtils.assertTotalSeriesCount;
 
 @ExtendWith(MockitoExtension.class)
-class CachingMetricProducerTest {
+class TimeWindowMetricProducerTest {
 
     @Mock
     TimeWindowViewManager viewManager;
 
     @InjectMocks
-    CachingMetricProducer producer;
+    TimeWindowMetricProducer producer;
 
     @InjectMocks
     TimeWindowRecorder recorder;

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public void createInstrument(String metricName, MetricDefinitionSettings metricD`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`val views = populatedMetricDefinition.getViews();`
`64`		`- if(!CollectionUtils.isEmpty(views)) {`
	`64`	`+ if (!CollectionUtils.isEmpty(views)) {`
`65`	`65`	`views.values().forEach(view -> attributesRegistry.processAttributeKeysForView(view));`
`66`	`66`	`}`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,13 +45,13 @@ void shouldCreateInstrumentAndProcessAttributes() {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Test`
`48`		`- void shouldCreateInstrumentAndNotProcessAttributesWhenNoViews() {`
	`48`	`+ void shouldCreateInstrumentAndProcessAttributesWhenNoViews() {`
`49`	`49`	`MetricDefinitionSettings metric = new MetricDefinitionSettings();`
`50`	`50`
`51`	`51`	`manager.createInstrument(metricName, metric);`
`52`	`52`
`53`	`53`	`verify(factory).createInstrument(anyString(), any(MetricDefinitionSettings.class));`
`54`		`- verifyNoInteractions(registry);`
	`54`	`+ verify(registry).processAttributeKeysForView(any(ViewDefinitionSettings.class));`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`@Test`