use self-monitoring prefix for views

Author: EddeCCC

src/main/java/rocks/inspectit/ocelot/eum/server/configuration/model/selfmonitoring/SelfMonitoringSettings.java

@@ -8,7 +8,10 @@
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.NotNull;
+import rocks.inspectit.ocelot.eum.server.configuration.model.metrics.definition.view.ViewDefinitionSettings;
+
 import java.util.Collections;
+import java.util.LinkedHashMap;
 import java.util.Map;
 
 /**
@@ -33,4 +36,31 @@ public class SelfMonitoringSettings {
      * The prefix used for the self-monitoring metrics.
      */
     private String metricPrefix;
+
+    /**
+     * Marker to tell if the {@link #metricPrefix} has been applied to views
+     */
+    private boolean prefixNotApplied = true;
+
+    /**
+     * Adds the {@link #metricPrefix} for all view names. The prefix to the metrics has to be added manually.
+     *
+     * @return the metrics with prefixed views
+     */
+    public Map<String, MetricDefinitionSettings> getMetricsWithPrefixedViews() {
+        if (prefixNotApplied) {
+            metrics.forEach((metricName, metricDefinition) -> {
+
+                Map<String, ViewDefinitionSettings> prefixedViews = new LinkedHashMap<>();
+                metricDefinition.getViews()
+                        .forEach((viewName, viewDefinition) ->
+                                prefixedViews.put(metricPrefix + viewName, viewDefinition)
+                        );
+                metricDefinition.setViews(prefixedViews);
+
+            });
+            prefixNotApplied = false;
+        }
+        return metrics;
+    }
 }

src/main/java/rocks/inspectit/ocelot/eum/server/metrics/SelfMonitoringMetricManager.java

@@ -29,34 +29,34 @@ public class SelfMonitoringMetricManager {
      */
     public void initMetrics() {
         SelfMonitoringSettings selfMonitoringSettings = configuration.getSelfMonitoring();
-        for (Map.Entry<String, MetricDefinitionSettings> metricEntry : selfMonitoringSettings.getMetrics().entrySet()) {
-            String measureName = metricEntry.getKey();
+        for (Map.Entry<String, MetricDefinitionSettings> metricEntry : selfMonitoringSettings.getMetricsWithPrefixedViews().entrySet()) {
+            String metricName = metricEntry.getKey();
             MetricDefinitionSettings metricDefinitionSettings = metricEntry.getValue();
 
-            String metricName = selfMonitoringSettings.getMetricPrefix() + measureName;
+            String fullMetricName = selfMonitoringSettings.getMetricPrefix() + metricName;
             log.info("Registering self-monitoring metric: {}", metricName);
 
-            instrumentManager.createInstrument(metricName, metricDefinitionSettings);
+            instrumentManager.createInstrument(fullMetricName, metricDefinitionSettings);
         }
     }
 
     /**
-     * Records a self-monitoring measurement with the common attributes.
-     * Only records a measurement if self monitoring is enabled.
+     * Records a self-monitoring metric with the common attributes.
+     * Only records a metric if self monitoring is enabled.
      *
-     * @param measureName the name of the measure, excluding the metrics prefix
-     * @param value       the actual value
-     * @param customAttributes  custom attributes
+     * @param metricName        the name of the metric, excluding the metrics prefix
+     * @param value             the value to record
+     * @param customAttributes  the custom attributes for the metric
      */
-    public void record(String measureName, Number value, Map<String, String> customAttributes) {
+    public void record(String metricName, Number value, Map<String, String> customAttributes) {
         SelfMonitoringSettings selfMonitoringSettings = configuration.getSelfMonitoring();
-        if (selfMonitoringSettings.isEnabled() && selfMonitoringSettings.getMetrics().containsKey(measureName)) {
-            MetricDefinitionSettings metricDefinitionSettings = selfMonitoringSettings.getMetrics().get(measureName);
+        if (selfMonitoringSettings.isEnabled() && selfMonitoringSettings.getMetrics().containsKey(metricName)) {
+            MetricDefinitionSettings metricDefinition = selfMonitoringSettings.getMetricsWithPrefixedViews().get(metricName);
 
-            String metricName = selfMonitoringSettings.getMetricPrefix() + measureName;
+            String fullMetricName = selfMonitoringSettings.getMetricPrefix() + metricName;
 
             try (Scope scope = instrumentManager.getBaggage(customAttributes).makeCurrent()) {
-                instrumentManager.recordMetric(metricName, metricDefinitionSettings, value);
+                instrumentManager.recordMetric(fullMetricName, metricDefinition, value);
             }
         }
     }

src/main/resources/application.yml

@@ -1,3 +1,4 @@
+# EUM-SERVER PROPERTIES
 inspectit-eum-server:
 
   definitions:
@@ -150,7 +151,7 @@ inspectit-eum-server:
 
     metrics:
       prometheus:
-        # Determines whether the prometheus exporter is enabled.
+        # determines whether the prometheus exporter is enabled.
         enabled: DISABLED
 
         # The host of the prometheus HTTP endpoint.
@@ -159,7 +160,7 @@ inspectit-eum-server:
         # The port of the prometheus HTTP endpoint.
         port: 8888
 
-      # settings for the OtlpGrpcMetricExporter used in OtlpGrpcMetricExporterService
+      # settings for the OTLP metrics exporter
       otlp:
         # Determines whether the otlp metrics exporter is enabled.
         enabled: IF_CONFIGURED
@@ -179,9 +180,10 @@ inspectit-eum-server:
         timeout: 10s
 
     tracing:
-      # Specifies whether client IP addresses which are added to spans should be masked.
+      # specifies whether client IP addresses which are added to spans should be masked.
       mask-span-ip-addresses: true
 
+      # settings for the OTLP trace exporter
       otlp:
         # If OTLP exporter for the OT received spans is enabled.
         enabled: IF_CONFIGURED
@@ -197,26 +199,27 @@ inspectit-eum-server:
         timeout: 10s
 
     beacons:
+
       http:
-        # Whether beacons should be exported via HTTP.
+        # whether beacons should be exported via HTTP
         enabled: DISABLED
 
-        # The endpoint to which the beacons are to be sent.
+        # the endpoint to which the beacons are to be sent
         endpoint-url: http://localhost:8080
 
-        # The max. amount of threads exporting beacons (min. 1).
+        # the max. amount of threads exporting beacons (min. 1)
         worker-threads: 2
 
-        # The maximum number of beacons to be exported using a single HTTP request (min. 1).
+        # the maximum number of beacons to be exported using a single HTTP request (min. 1)
         max-batch-size: 100
 
-        # The flush interval to export beacons in case the 'max-batch-size' has not been reached (min. 1 second).
+        # the flush interval to export beacons in case the 'max-batch-size' has not been reached (min. 1 second)
         flush-interval: 5s
 
-        # When specified, the request will be using this username for Basic authentication.
+        # when specified, the request will be using this username for Basic authentication
         # username:
 
-        # The password used for Basic authentication.
+        # the password used for Basic authentication
         # password:
 
   # settings for the EUM server's self-monitoring
@@ -225,7 +228,7 @@ inspectit-eum-server:
     # whether self-monitoring is enabled
     enabled: true
 
-    # the prefix used for the self-monitoring metrics
+    # the prefix used for the self-monitoring metrics and views
     metricPrefix: "inspectit_eum_self_"
 
     # definitions of the self-monitoring metrics
@@ -236,7 +239,7 @@ inspectit-eum-server:
         value-type: LONG
         unit: amount
         views:
-          inspectit_eum_self_beacons_received:
+          beacons_received:
             aggregation: SUM
             attributes:
               is_error: true
@@ -246,7 +249,7 @@ inspectit-eum-server:
         value-type: LONG
         unit: amount
         views:
-          inspectit_eum_self_beacons_export:
+          beacons_export:
             aggregation: HISTOGRAM
             attributes:
               exporter: true
@@ -258,7 +261,7 @@ inspectit-eum-server:
         unit: amount
         views:
           # the amount of elements in a single export execution
-          inspectit_eum_self_beacons_export_batch:
+          beacons_export_batch:
             aggregation: SUM
             attributes:
               exporter: true
@@ -269,7 +272,7 @@ inspectit-eum-server:
         value-type: LONG
         unit: amount
         views:
-          inspectit_eum_self_beacons_processor:
+          beacons_processor:
             aggregation: HISTOGRAM
             attributes:
               beacon_processor: true
@@ -280,7 +283,7 @@ inspectit-eum-server:
         value-type: LONG
         unit: amount
         views:
-          inspectit_eum_self_traces_received:
+          traces_received:
             aggregation: HISTOGRAM
             attributes:
               is_error: true
@@ -290,7 +293,7 @@ inspectit-eum-server:
         value-type: LONG
         unit: amount
         views:
-          inspectit_eum_self_traces_span_size:
+          traces_span_size:
             aggregation: SUM
             attributes:
               is_error: true
@@ -306,21 +309,22 @@ inspectit-eum-server:
       - "/boomerang/**"
     auth-provider:
       simple:
-        # Enable/Disable Provider
+        # enable/disable provider
         enabled: false
-        # Flag indicates if the directory should be watched for changes and tokens reloaded
+        # flag indicates if the directory should be watched for changes and tokens reloaded
         watch: true
-        # How often directory should be watched for changes
+        # how often directory should be watched for changes
         frequency: 60s
-        # The directory where token files are stored. Empty by default to force users to provide one
+        # the directory where token files are stored. Empty by default to force users to provide one
         token-directory: ""
-        # The name of the initial token file. If a name is provided file will be created with an initial token
+        # the name of the initial token file. If a name is provided file will be created with an initial token
         default-file-name: "default-token-file.yaml"
 
 
-# SERVER properties
-# Avoid exposing internals to outside via error page
+# SERVER PROPERTIES
 server:
+  port: 8080
+  # avoid exposing internals to outside via error page
   error:
     include-stacktrace: never
     include-binding-errors: never
@@ -330,15 +334,15 @@ server:
 
 # ACTUATOR PROPERTIES
 management:
-  # Whether to enable or disable all endpoints by default.
+  # whether to enable or disable all endpoints by default
   endpoints.enabled-by-default: false
   endpoint:
-    # Whether to enable the health endpoint.
+    # whether to enable the health endpoint.
     health.enabled: true
 
 spring:
   autoconfigure:
-    # Disable ErrorMvcAutoConfiguration to avoid nasty exceptions if whitelabel error page is disabled
+    # disable ErrorMvcAutoConfiguration to avoid nasty exceptions if whitelabel error page is disabled
     # https://github.com/spring-projects/spring-boot/issues/2001
     exclude: org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration
 

src/test/java/rocks/inspectit/ocelot/eum/server/metrics/SelfMonitoringMetricManagerTest.java

@@ -1,5 +1,6 @@
 package rocks.inspectit.ocelot.eum.server.metrics;
 
+import io.opentelemetry.api.baggage.Baggage;
 import io.opentelemetry.sdk.metrics.InstrumentType;
 import io.opentelemetry.sdk.metrics.InstrumentValueType;
 import org.junit.jupiter.api.BeforeEach;
@@ -49,7 +50,7 @@ void setupConfiguration() {
                     .attribute("TAG_1", true)
                     .build();
             Map<String, ViewDefinitionSettings> views = new HashMap<>();
-            views.put("inspectit-eum/self/beacons_received", view);
+            views.put("beacons_received", view);
 
             MetricDefinitionSettings dummyMetricDefinition = MetricDefinitionSettings.builder()
                     .description("Dummy description")
@@ -64,7 +65,7 @@ void setupConfiguration() {
             definitionMap.put("beacons_received", dummyMetricDefinition);
             selfMonitoringSettings.setEnabled(true);
             selfMonitoringSettings.setMetrics(definitionMap);
-            selfMonitoringSettings.setMetricPrefix("inspectit-eum/self/");
+            selfMonitoringSettings.setMetricPrefix("inspectit_eum_self_");
         }
 
         @Test
@@ -93,10 +94,24 @@ void verifySelfMonitoringMetricManagerIsCalled() {
             selfMonitoringMetricManager.initMetrics();
 
             ArgumentCaptor<MetricDefinitionSettings> mdsCaptor = ArgumentCaptor.forClass(MetricDefinitionSettings.class);
-            verify(instrumentManager).createInstrument(eq("inspectit-eum/self/beacons_received"), mdsCaptor.capture());
+            verify(instrumentManager).createInstrument(eq("inspectit_eum_self_beacons_received"), mdsCaptor.capture());
             verifyNoMoreInteractions(instrumentManager);
 
-            assertThat(mdsCaptor.getValue().getViews().keySet()).containsExactly("inspectit-eum/self/beacons_received");
+            assertThat(mdsCaptor.getValue().getViews().keySet()).containsExactly("inspectit_eum_self_beacons_received");
+        }
+
+        @Test
+        void verifyViewIsRecorded() {
+            when(configuration.getSelfMonitoring()).thenReturn(selfMonitoringSettings);
+            when(instrumentManager.getBaggage(any())).thenReturn(Baggage.empty());
+
+            selfMonitoringMetricManager.record("beacons_received", 1);
+
+            ArgumentCaptor<MetricDefinitionSettings> mdsCaptor = ArgumentCaptor.forClass(MetricDefinitionSettings.class);
+            verify(instrumentManager).recordMetric(eq("inspectit_eum_self_beacons_received"), mdsCaptor.capture(), any(Number.class));
+            verifyNoMoreInteractions(instrumentManager);
+
+            assertThat(mdsCaptor.getValue().getViews().keySet()).containsExactly("inspectit_eum_self_beacons_received");
         }
     }
 }