SONARJAVA-5673 Create a proxy class for accessing telemetry API. (#5248)

Author: tomasz-tylenda-sonarsource

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

@@ -0,0 +1,26 @@
+/*
+ * 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;
+
+/**
+ * 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);
+}

java-frontend/src/main/java/org/sonar/java/TelemetryKey.java

@@ -0,0 +1,34 @@
+/*
+ * 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 keys used by the Java analyzer.
+ */
+public enum TelemetryKey {
+  JAVA_LANGUAGE_VERSION("java.language.version");
+
+  private final String key;
+
+  TelemetryKey(String key) {
+    this.key = key;
+  }
+
+  public String key() {
+    return key;
+  }
+}

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

@@ -0,0 +1,27 @@
+/*
+ * 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;
+
+import org.junit.jupiter.api.Test;
+import static org.assertj.core.api.Assertions.assertThat;
+
+class TelemetryKeyTest {
+  @Test
+  void test() {
+    assertThat(TelemetryKey.JAVA_LANGUAGE_VERSION.key()).isEqualTo("java.language.version");
+  }
+}

sonar-java-plugin/src/main/java/org/sonar/plugins/java/JavaSensor.java

@@ -41,6 +41,7 @@
 import org.sonar.java.JavaFrontend;
 import org.sonar.java.Measurer;
 import org.sonar.java.SonarComponents;
+import org.sonar.java.Telemetry;
 import org.sonar.java.filters.PostAnalysisIssueFilter;
 import org.sonar.java.jsp.Jasper;
 import org.sonar.java.model.GeneratedFile;
@@ -51,6 +52,7 @@
 import org.sonarsource.performance.measure.PerformanceMeasure;
 
 import static org.sonar.api.rules.RuleAnnotationUtils.getRuleKey;
+import static org.sonar.java.TelemetryKey.JAVA_LANGUAGE_VERSION;
 
 @Phase(name = Phase.Name.PRE)
 @DependedUpon("org.sonar.plugins.java.JavaSensor")
@@ -103,9 +105,10 @@ public void execute(SensorContext context) {
     sonarComponents.setCheckFilter(createCheckFilter(sonarComponents.isAutoScanCheckFiltering()));
 
     Measurer measurer = new Measurer(context, noSonarFilter);
+    Telemetry telemetry = new SensorTelemetry(context);
 
     JavaVersion javaVersion = getJavaVersion();
-    context.addTelemetryProperty("java.language.version", javaVersion.toString());
+    telemetry.addMetric(JAVA_LANGUAGE_VERSION, javaVersion.toString());
 
     JavaFrontend frontend = new JavaFrontend(javaVersion, sonarComponents, measurer, javaResourceLocator, postAnalysisIssueFilter,
       sonarComponents.mainChecks().toArray(new JavaCheck[0]));

sonar-java-plugin/src/main/java/org/sonar/plugins/java/SensorTelemetry.java

@@ -0,0 +1,37 @@
+/*
+ * 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.plugins.java;
+
+import org.sonar.api.batch.sensor.SensorContext;
+import org.sonar.java.Telemetry;
+import org.sonar.java.TelemetryKey;
+
+/**
+ * Wraps up {@link SensorContext} to allow passing it around without exposing other APIs.
+ */
+public class SensorTelemetry implements Telemetry {
+  private final SensorContext context;
+
+  public SensorTelemetry(SensorContext context) {
+    this.context = context;
+  }
+
+  @Override
+  public void addMetric(TelemetryKey key, String value) {
+    this.context.addTelemetryProperty(key.key(), value);
+  }
+}