Deprecate SignalFX Registry in favor of OTLP Registry (#5813)

shakuzen · web-flow · commit 1a9c7fbf51d0 · 2025-01-21T11:50:13.000-08:00
Resolves gh-5807
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -32,7 +32,7 @@
 ** xref:implementations/new-relic.adoc[New Relic]
 ** xref:implementations/otlp.adoc[OpenTelemetry Protocol (OTLP)]
 ** xref:implementations/prometheus.adoc[Prometheus]
-** xref:implementations/signalFx.adoc[SignalFx]
+** xref:implementations/signalFx.adoc[SignalFx] (deprecated)
 ** xref:implementations/stackdriver.adoc[Stackdriver]
 ** xref:implementations/statsD.adoc[statsD]
 ** xref:implementations/wavefront.adoc[Wavefront]
diff --git a/docs/modules/ROOT/pages/implementations/signalFx.adoc b/docs/modules/ROOT/pages/implementations/signalFx.adoc
@@ -2,6 +2,8 @@
 :sectnums:
 :system: signalfx
 
+CAUTION: This module has been deprecated in favor of the xref:implementations/otlp.adoc[OTLP Registry] because the https://github.com/signalfx/signalfx-java[SignalFX Java client library] that this module depends on has been deprecated.
+
 SignalFx is a dimensional monitoring system SaaS with a full UI that operates on a push model. It has a rich set of alert "`detectors`".
 
 include::_install.adoc[]
diff --git a/implementations/micrometer-registry-signalfx/build.gradle b/implementations/micrometer-registry-signalfx/build.gradle
@@ -1,3 +1,5 @@
+description = 'MeterRegistry implementation for sending metrics to SignalFX. This module is deprecated in favor of the micrometer-registry-otlp module.'
+
 dependencies {
     api project(':micrometer-core')
 
diff --git a/implementations/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxConfig.java b/implementations/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxConfig.java
@@ -30,7 +30,9 @@
  * Configuration for {@link SignalFxMeterRegistry}.
  *
  * @author Jon Schneider
+ * @deprecated this whole module is deprecated in favor of micrometer-registry-otlp
  */
+@Deprecated
 public interface SignalFxConfig extends StepRegistryConfig {
 
     @Override
diff --git a/implementations/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxMeterRegistry.java b/implementations/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxMeterRegistry.java
@@ -52,7 +52,9 @@
  * @author Jon Schneider
  * @author Johnny Lim
  * @since 1.0.0
+ * @deprecated this whole module is deprecated in favor of micrometer-registry-otlp
  */
+@Deprecated
 public class SignalFxMeterRegistry extends StepMeterRegistry {
 
     private static final ThreadFactory DEFAULT_THREAD_FACTORY = new NamedThreadFactory("signalfx-metrics-publisher");
diff --git a/implementations/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxNamingConvention.java b/implementations/micrometer-registry-signalfx/src/main/java/io/micrometer/signalfx/SignalFxNamingConvention.java
@@ -32,7 +32,9 @@
  * conventions for metrics and dimensions</a>
  * @author Jon Schneider
  * @author Johnny Lim
+ * @deprecated this whole module is deprecated in favor of micrometer-registry-otlp
  */
+@Deprecated
 public class SignalFxNamingConvention implements NamingConvention {
 
     private static final WarnThenDebugLogger logger = new WarnThenDebugLogger(SignalFxNamingConvention.class);
diff --git a/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxConfigTest.java b/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxConfigTest.java
@@ -23,6 +23,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+@SuppressWarnings("deprecation")
 class SignalFxConfigTest {
 
     private final Map<String, String> props = new HashMap<>();
diff --git a/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxMeterRegistryCompatibilityTest.java b/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxMeterRegistryCompatibilityTest.java
@@ -22,6 +22,7 @@
 
 import java.time.Duration;
 
+@SuppressWarnings("deprecation")
 class SignalFxMeterRegistryCompatibilityTest extends MeterRegistryCompatibilityKit {
 
     private final SignalFxConfig config = new SignalFxConfig() {
diff --git a/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxMeterRegistryTest.java b/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxMeterRegistryTest.java
@@ -52,6 +52,7 @@
  *
  * @author Johnny Lim
  */
+@SuppressWarnings("deprecation")
 class SignalFxMeterRegistryTest {
 
     private final SignalFxConfig config = new SignalFxConfig() {
diff --git a/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxNamingConventionTest.java b/implementations/micrometer-registry-signalfx/src/test/java/io/micrometer/signalfx/SignalFxNamingConventionTest.java
@@ -27,6 +27,7 @@
  * @author Jon Schneider
  * @author Johnny Lim
  */
+@SuppressWarnings("deprecation")
 class SignalFxNamingConventionTest {
 
     private final SignalFxNamingConvention convention = new SignalFxNamingConvention();
diff --git a/samples/micrometer-samples-core/src/main/java/io/micrometer/core/samples/utils/SampleRegistries.java b/samples/micrometer-samples-core/src/main/java/io/micrometer/core/samples/utils/SampleRegistries.java
@@ -52,8 +52,6 @@
 import io.micrometer.newrelic.NewRelicMeterRegistry;
 import io.micrometer.prometheusmetrics.PrometheusConfig;
 import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
-import io.micrometer.signalfx.SignalFxConfig;
-import io.micrometer.signalfx.SignalFxMeterRegistry;
 import io.micrometer.stackdriver.StackdriverConfig;
 import io.micrometer.stackdriver.StackdriverMeterRegistry;
 import io.micrometer.statsd.StatsdConfig;
@@ -364,26 +362,6 @@ public String get(String k) {
         }, Clock.SYSTEM);
     }
 
-    public static SignalFxMeterRegistry signalFx(String accessToken) {
-        return new SignalFxMeterRegistry(new SignalFxConfig() {
-            @Override
-            public String accessToken() {
-                return accessToken;
-            }
-
-            @Override
-            public Duration step() {
-                return Duration.ofSeconds(10);
-            }
-
-            @Override
-            @Nullable
-            public String get(String k) {
-                return null;
-            }
-        }, Clock.SYSTEM);
-    }
-
     public static WavefrontMeterRegistry wavefront() {
         return new WavefrontMeterRegistry(WavefrontConfig.DEFAULT_PROXY, Clock.SYSTEM);
     }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+description = 'MeterRegistry implementation for sending metrics to SignalFX. This module is deprecated in favor of the micrometer-registry-otlp module.'`
	`2`	`+`
`1`	`3`	`dependencies {`
`2`	`4`	`api project(':micrometer-core')`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,9 @@`
`30`	`30`	`* Configuration for {@link SignalFxMeterRegistry}.`
`31`	`31`	`*`
`32`	`32`	`* @author Jon Schneider`
	`33`	`+ * @deprecated this whole module is deprecated in favor of micrometer-registry-otlp`
`33`	`34`	`*/`
	`35`	`+@Deprecated`
`34`	`36`	`public interface SignalFxConfig extends StepRegistryConfig {`
`35`	`37`
`36`	`38`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@`
`52`	`52`	`*`
`53`	`53`	`* @author Johnny Lim`
`54`	`54`	`*/`
	`55`	`+@SuppressWarnings("deprecation")`
`55`	`56`	`class SignalFxMeterRegistryTest {`
`56`	`57`
`57`	`58`	`private final SignalFxConfig config = new SignalFxConfig() {`