Skip to content

Commit

Permalink
Deprecate SignalFX Registry in favor of OTLP Registry (#5813)
Browse files Browse the repository at this point in the history
Resolves gh-5807
  • Loading branch information
shakuzen authored Jan 21, 2025
1 parent 14d0cd8 commit 1a9c7fb
Show file tree
Hide file tree
Showing 11 changed files with 15 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 2 additions & 0 deletions docs/modules/ROOT/pages/implementations/signalFx.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
2 changes: 2 additions & 0 deletions implementations/micrometer-registry-signalfx/build.gradle
Original file line number Diff line number Diff line change
@@ -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')

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@

import static org.assertj.core.api.Assertions.assertThat;

@SuppressWarnings("deprecation")
class SignalFxConfigTest {

private final Map<String, String> props = new HashMap<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import java.time.Duration;

@SuppressWarnings("deprecation")
class SignalFxMeterRegistryCompatibilityTest extends MeterRegistryCompatibilityKit {

private final SignalFxConfig config = new SignalFxConfig() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
*
* @author Johnny Lim
*/
@SuppressWarnings("deprecation")
class SignalFxMeterRegistryTest {

private final SignalFxConfig config = new SignalFxConfig() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
* @author Jon Schneider
* @author Johnny Lim
*/
@SuppressWarnings("deprecation")
class SignalFxNamingConventionTest {

private final SignalFxNamingConvention convention = new SignalFxNamingConvention();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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);
}
Expand Down

0 comments on commit 1a9c7fb

Please sign in to comment.