Allow custom key names instead of fixed 'type' key name

dbmdz · Jul 10, 2018 · 5d042b8 · 5d042b8
1 parent ae95d7d
commit 5d042b8
Show file tree

Hide file tree

Showing 17 changed files with 49 additions and 28 deletions.
diff --git a/dc-commons-feign/pom.xml b/dc-commons-feign/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons REST Feign</name>

diff --git a/dc-commons-jdbi/pom.xml b/dc-commons-jdbi/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons JDBI</name>

diff --git a/dc-commons-prosemirror/dc-commons-prosemirror-model-jackson/pom.xml b/dc-commons-prosemirror/dc-commons-prosemirror-model-jackson/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons-prosemirror</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons ProseMirror Model Jackson</name>

diff --git a/dc-commons-prosemirror/dc-commons-prosemirror-model/pom.xml b/dc-commons-prosemirror/dc-commons-prosemirror-model/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons-prosemirror</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons ProseMirror Model</name>

diff --git a/dc-commons-prosemirror/pom.xml b/dc-commons-prosemirror/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons ProseMirror (Parent)</name>

diff --git a/dc-commons-server/pom.xml b/dc-commons-server/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons Server</name>

diff --git a/dc-commons-springaop/pom.xml b/dc-commons-springaop/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons Spring AOP</name>

diff --git a/dc-commons-springboot/pom.xml b/dc-commons-springboot/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons Spring Boot (Spring Boot 2)</name>

diff --git a/...ngboot/src/main/java/de/digitalcollections/commons/springboot/metrics/MetricsService.java b/...ngboot/src/main/java/de/digitalcollections/commons/springboot/metrics/MetricsService.java
@@ -30,17 +30,29 @@ public MetricsService(MeterRegistry meterRegistry) {
    * @param value Value of the gauge
    */
   public void setGauge(String name, long value) {
-    handleCounter(name, null, null, value, null, false);
+    handleCounter(name, null,null, null, value, null, false);
   }
 
   /**
    * Sets the value of a gauge
    * @param name Name of the gauge, postfixed with <tt>.amount</tt>
-   * @param tag Name of the tag
+   * @param tag Name of the tag (key is <tt>type</tt>)
    * @param value Value of the gauge
    */
   public void setGauge(String name, String tag, long value) {
-    handleCounter(name, tag, null, value, null, false);
+    handleCounter(name, "type", tag, null, value, null, false);
+  }
+
+
+  /**
+   * Sets the value of a gauge
+   * @param name Name of the gauge, postfixed with <tt>.amount</tt>
+   * @param tagKey Name of the tag
+   * @param tagValue Value of the tag
+   * @param value Value of the gauge
+   */
+  public void setGauge(String name, String tagKey, String tagValue, long value) {
+    handleCounter(name, tagKey, tagValue, null, value, null, false);
   }
 
   /**
@@ -49,7 +61,7 @@ public void setGauge(String name, String tag, long value) {
    * @param tag Name of the tag
    */
   public void increaseCounter(String name, String tag) {
-    handleCounter(name, tag, 1L,  null, null, false);
+    handleCounter(name, "type", tag, 1L,  null, null, false);
   }
 
   /**
@@ -59,7 +71,7 @@ public void increaseCounter(String name, String tag) {
    * @param increment Increment value
    */
   public void increaseCounter(String name, String tag, long increment) {
-    handleCounter(name, tag, increment, null,null, false);
+    handleCounter(name, "type", tag, increment, null,null, false);
   }
 
   /**
@@ -69,7 +81,7 @@ public void increaseCounter(String name, String tag, long increment) {
    * @param durationMillis Duration in milliseconds
    */
   public void increaseCounterWithDuration(String name, String tag, Long durationMillis) {
-    handleCounter(name, tag, 1L, null, durationMillis, false);
+    handleCounter(name, "type", tag, 1L, null, durationMillis, false);
   }
 
   /**
@@ -79,11 +91,11 @@ public void increaseCounterWithDuration(String name, String tag, Long durationMi
    * @param durationMillis Duration in milliseconds
    */
   public void increaseCounterWithDurationAndPercentiles(String name, String tag, Long durationMillis) {
-    handleCounter(name, tag, 1L, null, durationMillis, true);
+    handleCounter(name, "type", tag, 1L, null, durationMillis, true);
   }
 
-  private void handleCounter(String name, String tag, Long increment, Long absoluteValue, Long durationMillis, Boolean publishPercentiles) {
-    String key = name + ( tag != null ? "." + tag : "");
+  private void handleCounter(String name, String tagKey, String tagValue, Long increment, Long absoluteValue, Long durationMillis, Boolean publishPercentiles) {
+    String key = name + ( ( tagKey != null && tagValue != null ) ? "." + tagValue : "");
 
     if ( increment != null ) {
       // Increase counter value
@@ -95,19 +107,19 @@ private void handleCounter(String name, String tag, Long increment, Long absolut
     // Register counter, if it doesn't exist yet
     if (counterTags.get(key) == null) {
       counterTags.put(key, new HashSet<>());
-      if ( tag != null ) {
-        counterTags.get(key).add(new ImmutableTag("type", tag));
+      if ( tagKey != null && tagValue != null ) {
+        counterTags.get(key).add(new ImmutableTag(tagKey, tagValue));
         meterRegistry.gauge(name + ".amount", counterTags.get(key), key, counters::get);
       } else {
         meterRegistry.gauge(name + ".amount", counters.get(key));
       }
     }
 
-    if (durationMillis != null && tag != null) {
+    if (durationMillis != null && tagKey != null && tagValue != null) {
       // Register Timer
       if (timers.get(key) == null) {
         Timer.Builder timerBuilder = Timer.builder(name + ".duration")
-                .tag("type", tag);
+                .tag(tagKey, tagValue);
 
         if ( publishPercentiles ) {
           timerBuilder = timerBuilder.publishPercentiles(0.5, 0.95)

diff --git a/...ot/src/test/java/de/digitalcollections/commons/springboot/metrics/MetricsServiceTest.java b/...ot/src/test/java/de/digitalcollections/commons/springboot/metrics/MetricsServiceTest.java
@@ -83,6 +83,15 @@ void multipleValuesOfAGauge() {
     assertThat(metricsService.getCounters().get("foo.bar")).isEqualTo(42);
   }
 
+  @Test
+  @DisplayName("Gauges with different tag keys")
+  void gaugesWithDifferentTagKeys() {
+    metricsService.setGauge("foo", "bar", "blub", 2);
+    assertThat(metricsService.getCounters().get("foo.blub")).isEqualTo(2);
+    metricsService.setGauge("foo", "two", 42);
+    assertThat(metricsService.getCounters().get("foo.two")).isEqualTo(42);
+  }
+
   @Test
   @DisplayName("Gauges without tag")
   void gaugeWithoutTag() {

diff --git a/dc-commons-springdata/pom.xml b/dc-commons-springdata/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons Spring Data</name>

diff --git a/dc-commons-springmvc/pom.xml b/dc-commons-springmvc/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons Spring MVC</name>

diff --git a/dc-commons-springsecurity/pom.xml b/dc-commons-springsecurity/pom.xml
@@ -6,7 +6,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons Spring Security (Spring Security 5)</name>

diff --git a/dc-commons-validation/pom.xml b/dc-commons-validation/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons Validation</name>

diff --git a/dc-commons-xml/pom.xml b/dc-commons-xml/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons XML</name>

diff --git a/dc-commons-yaml/pom.xml b/dc-commons-yaml/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>de.digitalcollections.commons</groupId>
     <artifactId>dc-commons</artifactId>
-    <version>1.4.0</version>
+    <version>1.4.1</version>
   </parent>
 
   <name>DigitalCollections: Commons YAML</name>

diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
   <groupId>de.digitalcollections.commons</groupId>
   <artifactId>dc-commons</artifactId>
-  <version>1.4.0</version>
+  <version>1.4.1</version>
   <packaging>pom</packaging>
 
   <modules>