SONARJAVA-5689 Aggregate telemetry measures at project level (#5252)

Author: alban-auzeill

its/plugin/tests/src/test/java/com/sonar/it/java/suite/JavaTutorialTest.java

@@ -69,7 +69,10 @@ private void executeAndAssertBuild(MavenBuild build, String projectKey) {
     assertThat(issuesForRule(issues, "mycompany-java:SecurityAnnotationMandatory")).hasSize(2);
     assertThat(issuesForRule(issues, "mycompany-java:SpringControllerRequestMappingEntity")).hasSize(1);
 
-    assertThat(buildResult.getLogs()).containsOnlyOnce("java.scanner_app=ScannerMaven");
+    assertThat(buildResult.getLogs())
+      .containsOnlyOnce("Telemetry java.language.version: 17")
+      .containsOnlyOnce("Telemetry java.module_count: 1")
+      .containsOnlyOnce("Telemetry java.scanner_app: ScannerMaven");
   }
 
   private static Stream<String> issuesForRule(List<Issue> issues, String key) {

java-frontend/src/main/java/org/sonar/java/telemetry/AlphaNumericComparator.java

@@ -0,0 +1,68 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java.telemetry;
+
+import java.math.BigInteger;
+import java.util.Comparator;
+import java.util.regex.Pattern;
+import javax.annotation.Nullable;
+
+/**
+ * Comparator for alphanumeric strings that compares numbers as integers and other parts as strings.
+ * For example: "elem1,elem2,elem12" instead of "elem1,elem12,elem2".
+ */
+class AlphaNumericComparator implements Comparator<String> {
+
+  // Splits a string into parts where each part is either a sequence of digits or a sequence of non-digits.
+  private static final Pattern DIGITS_SEPARATOR = Pattern.compile("(?<=\\D)(?=\\d)|(?<=\\d)(?=\\D)");
+
+  @Override
+  public int compare(@Nullable String o1, @Nullable String o2) {
+    if (o1 == null || o2 == null) {
+      if (o1 != null) {
+        return 1;
+      }
+      return o2 != null ? -1 : 0;
+    }
+    if (o1.equals(o2)) {
+      return 0;
+    }
+    String[] arr1 = DIGITS_SEPARATOR.split(o1, -1);
+    String[] arr2 = DIGITS_SEPARATOR.split(o2, -1);
+    int len = Math.min(arr1.length, arr2.length);
+    for (int i = 0; i < len; i++) {
+      int comp = compareStringOrNumber(arr1[i], arr2[i]);
+      if (comp != 0) {
+        return comp;
+      }
+    }
+    return Integer.compare(arr1.length, arr2.length);
+  }
+
+  private static int compareStringOrNumber(String str1, String str2) {
+    if (startWithDigit(str1) && startWithDigit(str2)) {
+      return new BigInteger(str1).compareTo(new BigInteger(str2));
+    } else {
+      return str1.compareTo(str2);
+    }
+  }
+
+  private static boolean startWithDigit(String str) {
+    return !str.isEmpty() && str.charAt(0) >= '0' && str.charAt(0) <= '9';
+  }
+
+}

java-frontend/src/main/java/org/sonar/java/telemetry/DefaultTelemetry.java

@@ -0,0 +1,50 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java.telemetry;
+
+import java.util.EnumMap;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeMap;
+import java.util.TreeSet;
+
+public class DefaultTelemetry implements Telemetry {
+
+  private static final AlphaNumericComparator ALPHA_NUMERIC_COMPARATOR = new AlphaNumericComparator();
+
+  private final Map<TelemetryKey, Set<String>> sets = new EnumMap<>(TelemetryKey.class);
+  private final Map<TelemetryKey, Long> counters = new EnumMap<>(TelemetryKey.class);
+
+  @Override
+  public void aggregateAsSortedSet(TelemetryKey key, String value) {
+    sets.computeIfAbsent(key, k -> new TreeSet<>(ALPHA_NUMERIC_COMPARATOR)).add(value);
+  }
+
+  @Override
+  public void aggregateAsCounter(TelemetryKey key, long value) {
+    counters.merge(key, value, Long::sum);
+  }
+
+  @Override
+  public Map<String, String> toMap() {
+    Map<String, String> map = new TreeMap<>(ALPHA_NUMERIC_COMPARATOR);
+    sets.forEach((key, value) -> map.put(key.key(), String.join(",", value)));
+    counters.forEach((key, value) -> map.put(key.key(), String.valueOf(value)));
+    return map;
+  }
+
+}

sonar-java-plugin/src/main/java/org/sonar/plugins/java/SensorTelemetry.java renamed to java-frontend/src/main/java/org/sonar/java/telemetry/NoOpTelemetry.java

@@ -14,29 +14,28 @@
  * You should have received a copy of the Sonar Source-Available License
  * along with this program; if not, see https://sonarsource.com/license/ssal/
  */
-package org.sonar.plugins.java;
+package org.sonar.java.telemetry;
 
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.sonar.api.batch.sensor.SensorContext;
-import org.sonar.java.Telemetry;
-import org.sonar.java.TelemetryKey;
+import java.util.Map;
 
 /**
- * Wraps up {@link SensorContext} to allow passing it around without exposing other APIs.
+ * Placeholder for {@link Telemetry} that ignores all calls. Its main use is to satisfy a dependency in SonarQube for IDE, which does not send telemetry.
  */
-public class SensorTelemetry implements Telemetry {
-  private static final Logger LOG = LoggerFactory.getLogger(SensorTelemetry.class);
+public class NoOpTelemetry implements Telemetry {
 
-  private final SensorContext context;
+  @Override
+  public void aggregateAsSortedSet(TelemetryKey key, String value) {
+    // no operation
+  }
 
-  public SensorTelemetry(SensorContext context) {
-    this.context = context;
+  @Override
+  public void aggregateAsCounter(TelemetryKey key, long value) {
+    // no operation
   }
 
   @Override
-  public void addMetric(TelemetryKey key, String value) {
-    LOG.debug("{}={}", key.key(), value);
-    this.context.addTelemetryProperty(key.key(), value);
+  public Map<String, String> toMap() {
+    return Map.of();
   }
+
 }

java-frontend/src/main/java/org/sonar/java/telemetry/Telemetry.java

@@ -0,0 +1,48 @@
+/*
+ * SonarQube Java
+ * Copyright (C) 2012-2025 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.java.telemetry;
+
+import java.util.Map;
+import org.sonar.api.ExtensionPoint;
+import org.sonar.api.scanner.ScannerSide;
+import org.sonarsource.api.sonarlint.SonarLintSide;
+
+/**
+ * Provides access to the APIs for reporting telemetry.
+ */
+@ScannerSide
+@SonarLintSide
+@ExtensionPoint
+public interface Telemetry {
+
+  /**
+   * Aggregates all the given values as a sorted set for the given key.
+   * The final map will contain the key and a comma-separated list of sorted values.
+   */
+  void aggregateAsSortedSet(TelemetryKey key, String value);
+
+  /**
+   * Aggregates all the given values as a sum for the given key.
+   */
+  void aggregateAsCounter(TelemetryKey key, long value);
+
+  /**
+   * @return convert all the different kind of key / value pairs type into a string / string map.
+   */
+  Map<String, String> toMap();
+
+}

java-frontend/src/main/java/org/sonar/java/TelemetryKey.java renamed to java-frontend/src/main/java/org/sonar/java/telemetry/TelemetryKey.java

@@ -14,14 +14,15 @@
  * You should have received a copy of the Sonar Source-Available License
  * along with this program; if not, see https://sonarsource.com/license/ssal/
  */
-package org.sonar.java;
+package org.sonar.java.telemetry;
 
 /**
  * Telemetry keys used by the Java analyzer.
  */
 public enum TelemetryKey {
   JAVA_LANGUAGE_VERSION("java.language.version"),
-  JAVA_SCANNER_APP("java.scanner_app");
+  JAVA_SCANNER_APP("java.scanner_app"),
+  JAVA_MODULE_COUNT("java.module_count");
 
   private final String key;
 

java-frontend/src/main/java/org/sonar/java/Telemetry.java renamed to java-frontend/src/main/java/org/sonar/java/telemetry/package-info.java

@@ -14,13 +14,7 @@
  * You should have received a copy of the Sonar Source-Available License
  * along with this program; if not, see https://sonarsource.com/license/ssal/
  */
-package org.sonar.java;
+@ParametersAreNonnullByDefault
+package org.sonar.java.telemetry;
 
-/**
- * Provides access to the APIs for reporting telemetry.
- */
-public interface Telemetry {
-  // `addMetric` will forward the call to `addTelemetryProperty`.
-  // We chose a different name to make textual search for the real thing easier.
-  void addMetric(TelemetryKey key, String value);
-}
+import javax.annotation.ParametersAreNonnullByDefault;

java-frontend/src/test/java/org/sonar/java/SonarComponentsTest.java

@@ -140,7 +140,7 @@ class SonarComponentsTest {
   private SensorContext context;
 
   @RegisterExtension
-  public ThreadLocalLogTester logTester = new ThreadLocalLogTester().setLevel(Level.DEBUG);
+  public ThreadLocalLogTester logTester = new ThreadLocalLogTester();
 
   @BeforeEach
   void setUp() {
@@ -980,6 +980,7 @@ private static Stream<Arguments> fileCanBeSkipped_only_logs_on_first_call_input(
   @ParameterizedTest
   @MethodSource("fileCanBeSkipped_only_logs_on_first_call_input")
   void fileCanBeSkipped_only_logs_on_the_first_call(SonarComponents sonarComponents, InputFile inputFile, String logMessage) throws IOException {
+    logTester.setLevel(Level.INFO);
     assertThat(logTester.logs(Level.INFO)).isEmpty();
 
     SensorContext contextMock = mock(SensorContext.class);
@@ -1087,6 +1088,7 @@ void beforeEach() {
 
     @Test
     void log_only_50_undefined_types() {
+      logTester.setLevel(Level.DEBUG);
       String source = generateSource(26);
 
       // artificially populated the semantic errors with 26 unknown types and 52 errors
@@ -1131,6 +1133,7 @@ void remove_info_and_warning_from_log_related_to_undefined_types() {
 
     @Test
     void log_all_undefined_types_if_less_than_threshold() {
+      logTester.setLevel(Level.DEBUG);
       String source = generateSource(1);
 
       // artificially populated the semantic errors with 1 unknown types and 2 errors
@@ -1155,6 +1158,7 @@ void log_all_undefined_types_if_less_than_threshold() {
 
     @Test
     void suspicious_empty_libraries_should_be_logged() {
+      logTester.setLevel(Level.INFO);
       logUndefinedTypesWithOneMainAndOneTest();
 
       assertThat(logTester.logs(Level.WARN))
@@ -1166,6 +1170,7 @@ void suspicious_empty_libraries_should_be_logged() {
 
     @Test
     void suspicious_empty_libraries_should_not_be_logged_in_autoscan() {
+      logTester.setLevel(Level.INFO);
       // Enable autoscan with a property
       context.setSettings(new MapSettings().setProperty(SonarComponents.SONAR_AUTOSCAN, true));
 
@@ -1180,6 +1185,7 @@ void suspicious_empty_libraries_should_not_be_logged_in_autoscan() {
 
     @Test
     void log_problems_with_list_of_paths_of_files_affected() {
+      logTester.setLevel(Level.DEBUG);
       String source = generateSource(1);
 
       // Add one test and one main file