metric-schema includes the java version by default as a javaVersion…

… tag (#832) metric-schema includes the java version by default as a `javaVersion` tag, for example `javaVersion:17.0.3`
palantir · Aug 2, 2022 · d460ee1 · d460ee1
1 parent db8f073
commit d460ee1
Show file tree

Hide file tree

Showing 10 changed files with 232 additions and 10 deletions.
diff --git a/changelog/@unreleased/pr-832.v2.yml b/changelog/@unreleased/pr-832.v2.yml
@@ -0,0 +1,6 @@
+type: improvement
+improvement:
+  description: metric-schema includes the java version by default as a `javaVersion`
+    tag, for example `javaVersion:17.0.3`
+  links:
+  - https://github.com/palantir/metric-schema/pull/832
diff --git a/metric-schema-java/src/integrationInput/java/com/palantir/test/MonitorsMetrics.java b/metric-schema-java/src/integrationInput/java/com/palantir/test/MonitorsMetrics.java
diff --git a/metric-schema-java/src/integrationInput/java/com/palantir/test/MyNamespaceMetrics.java b/metric-schema-java/src/integrationInput/java/com/palantir/test/MyNamespaceMetrics.java
diff --git a/metric-schema-java/src/integrationInput/java/com/palantir/test/ReservedConflictMetrics.java b/metric-schema-java/src/integrationInput/java/com/palantir/test/ReservedConflictMetrics.java
diff --git a/metric-schema-java/src/integrationInput/java/com/palantir/test/ServerMetrics.java b/metric-schema-java/src/integrationInput/java/com/palantir/test/ServerMetrics.java
diff --git a/metric-schema-java/src/integrationInput/java/com/palantir/test/VisibilityMetrics.java b/metric-schema-java/src/integrationInput/java/com/palantir/test/VisibilityMetrics.java
diff --git a/metric-schema-java/src/main/java/com/palantir/metric/schema/ReservedNames.java b/metric-schema-java/src/main/java/com/palantir/metric/schema/ReservedNames.java
@@ -23,14 +23,18 @@
 /** Field and parameter names used by this generator. */
 final class ReservedNames {
 
-    static final String LIBRARY_NAME = "LIBRARY_NAME";
-    static final String LIBRARY_VERSION = "LIBRARY_VERSION";
+    static final String LIBRARY_NAME_FIELD = "LIBRARY_NAME";
+    static final String LIBRARY_NAME_TAG = "libraryName";
+    static final String LIBRARY_VERSION_FIELD = "LIBRARY_VERSION";
+    static final String LIBRARY_VERSION_TAG = "libraryVersion";
+    static final String JAVA_VERSION_FIELD = "JAVA_VERSION";
+    static final String JAVA_VERSION_TAG = "javaVersion";
     static final String FACTORY_METHOD = "of";
     static final String GAUGE_NAME = "gauge";
     static final String REGISTRY_NAME = "registry";
 
-    private static final ImmutableSet<String> RESERVED_NAMES =
-            ImmutableSet.of(FACTORY_METHOD, GAUGE_NAME, REGISTRY_NAME, LIBRARY_NAME, LIBRARY_VERSION);
+    private static final ImmutableSet<String> RESERVED_NAMES = ImmutableSet.of(
+            FACTORY_METHOD, GAUGE_NAME, JAVA_VERSION_FIELD, LIBRARY_NAME_FIELD, LIBRARY_VERSION_FIELD, REGISTRY_NAME);
 
     /** Returns true if the input string cannot be used. */
     static boolean isValid(String input) {

diff --git a/metric-schema-java/src/main/java/com/palantir/metric/schema/UtilityGenerator.java b/metric-schema-java/src/main/java/com/palantir/metric/schema/UtilityGenerator.java
@@ -18,6 +18,7 @@
 
 import com.codahale.metrics.Gauge;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSortedSet;
 import com.google.common.collect.Iterables;
 import com.google.errorprone.annotations.CheckReturnValue;
 import com.palantir.logsafe.Preconditions;
@@ -60,15 +61,27 @@ static JavaFile generateUtilityClass(
                                 Preconditions.class)
                         .returns(className)
                         .build())
-                .addField(TaggedMetricRegistry.class, ReservedNames.REGISTRY_NAME, Modifier.PRIVATE, Modifier.FINAL);
+                .addField(TaggedMetricRegistry.class, ReservedNames.REGISTRY_NAME, Modifier.PRIVATE, Modifier.FINAL)
+                .addField(FieldSpec.builder(
+                                String.class,
+                                ReservedNames.JAVA_VERSION_FIELD,
+                                Modifier.PRIVATE,
+                                Modifier.STATIC,
+                                Modifier.FINAL)
+                        .initializer("$T.getProperty($S, $S)", System.class, "java.version", "unknown")
+                        .build());
         if (libraryName.isPresent()) {
             builder.addField(FieldSpec.builder(
-                            String.class, ReservedNames.LIBRARY_NAME, Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL)
+                            String.class,
+                            ReservedNames.LIBRARY_NAME_FIELD,
+                            Modifier.PRIVATE,
+                            Modifier.STATIC,
+                            Modifier.FINAL)
                     .initializer("$S", libraryName.get())
                     .build());
             builder.addField(FieldSpec.builder(
                             String.class,
-                            ReservedNames.LIBRARY_VERSION,
+                            ReservedNames.LIBRARY_VERSION_FIELD,
                             Modifier.PRIVATE,
                             Modifier.STATIC,
                             Modifier.FINAL)
@@ -158,13 +171,28 @@ private static CodeBlock metricName(
                         ".putSafeTags($S, $L.getValue())", tagDef.getName(), Custodian.sanitizeName(tagDef.getName()));
             }
         });
+        ImmutableSortedSet<String> insensitiveTags = insensitiveTags(definition);
         if (libraryName.isPresent()) {
-            builder.add(".putSafeTags(\"libraryName\", $L)", ReservedNames.LIBRARY_NAME);
-            builder.add(".putSafeTags(\"libraryVersion\", $L)", ReservedNames.LIBRARY_VERSION);
+            if (!insensitiveTags.contains(ReservedNames.LIBRARY_NAME_TAG)) {
+                builder.add(".putSafeTags($S, $L)", ReservedNames.LIBRARY_NAME_TAG, ReservedNames.LIBRARY_NAME_FIELD);
+            }
+            if (!insensitiveTags.contains(ReservedNames.LIBRARY_VERSION_TAG)) {
+                builder.add(
+                        ".putSafeTags($S, $L)", ReservedNames.LIBRARY_VERSION_TAG, ReservedNames.LIBRARY_VERSION_FIELD);
+            }
+        }
+        if (!insensitiveTags.contains(ReservedNames.JAVA_VERSION_TAG)) {
+            builder.add(".putSafeTags($S, $L)", ReservedNames.JAVA_VERSION_TAG, ReservedNames.JAVA_VERSION_FIELD);
         }
         return builder.add(".build()").build();
     }
 
+    private static ImmutableSortedSet<String> insensitiveTags(MetricDefinition definition) {
+        return definition.getTagDefinitions().stream()
+                .map(TagDefinition::getName)
+                .collect(ImmutableSortedSet.toImmutableSortedSet(String.CASE_INSENSITIVE_ORDER));
+    }
+
     private static MethodSpec generateToString(ClassName className) {
         return MethodSpec.methodBuilder("toString")
                 .addModifiers(Modifier.PUBLIC)