Skip to content

Commit c2b8856

Browse files
Deprecate Wavefront Reporter and its test support
Closes gh-1148
1 parent 9ef140d commit c2b8856

File tree

12 files changed

+42
-2
lines changed

12 files changed

+42
-2
lines changed

docs/modules/ROOT/pages/reporters.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Micrometer Tracing supports directly the following Reporters.
55
* https://tanzu.vmware.com/observability[*Tanzu Observability by Wavefront*]
66
* https://zipkin.io[*OpenZipkin Zipkin*]
77
8+
CAUTION: The Wavefront Reporter has been deprecated because https://support.broadcom.com/web/ecx/support-content-notification/-/external/content/release-announcements/0/25153[Wavefront's End of Life Announcement].
9+
810
== Installing
911

1012
The following example shows the required dependency in Gradle (assuming that Micrometer Tracing BOM has been added):

docs/modules/ROOT/pages/testing.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ It:
1515
** Sets it up with OpenZipkin Zipkin Exporter
1616
* Runs all the combinations above against the user code and running infrastructure
1717
18+
CAUTION: The Wavefront Reporter and its test support have been deprecated because https://support.broadcom.com/web/ecx/support-content-notification/-/external/content/release-announcements/0/25153[Wavefront's End of Life Announcement].
19+
1820
== Installing
1921

2022
The following example shows the required dependency in Gradle (assuming that Micrometer Tracing BOM has been added):

micrometer-tracing-reporters/micrometer-tracing-reporter-wavefront/build.gradle

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ plugins {
22
id 'idea'
33
}
44

5+
description = 'Reporter implementation for Wavefront. This module is deprecated because Wavefront\'s End of Life Announcement.'
6+
57
dependencies {
68
api project(':micrometer-tracing')
79
api platform(libs.micrometerBom)

micrometer-tracing-reporters/micrometer-tracing-reporter-wavefront/src/main/java/io/micrometer/tracing/reporter/wavefront/SpanMetrics.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@
2020
/**
2121
* Reports metrics from {@link WavefrontSpanHandler}.
2222
*
23+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
2324
* @author Moritz Halbritter
2425
* @since 1.0.0
2526
*/
27+
@Deprecated
2628
public interface SpanMetrics {
2729

2830
/**

micrometer-tracing-reporters/micrometer-tracing-reporter-wavefront/src/main/java/io/micrometer/tracing/reporter/wavefront/WavefrontBraveSpanHandler.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,22 @@
1515
*/
1616
package io.micrometer.tracing.reporter.wavefront;
1717

18-
import java.io.Closeable;
19-
2018
import brave.handler.MutableSpan;
2119
import brave.handler.SpanHandler;
2220
import brave.propagation.TraceContext;
2321
import io.micrometer.tracing.brave.bridge.BraveFinishedSpan;
2422
import io.micrometer.tracing.brave.bridge.BraveTraceContext;
2523

24+
import java.io.Closeable;
25+
2626
/**
2727
* A {@link SpanHandler} that sends spans to Wavefront.
2828
*
29+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
2930
* @author Marcin Grzejszczak
3031
* @since 1.0.0
3132
*/
33+
@Deprecated
3234
public class WavefrontBraveSpanHandler extends SpanHandler implements Runnable, Closeable {
3335

3436
private final WavefrontSpanHandler spanHandler;

micrometer-tracing-reporters/micrometer-tracing-reporter-wavefront/src/main/java/io/micrometer/tracing/reporter/wavefront/WavefrontOtelSpanExporter.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@
2626
/**
2727
* A {@link SpanExporter} that sends spans to Wavefront.
2828
*
29+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
2930
* @author Marcin Grzejszczak
3031
* @since 1.0.0
3132
*/
33+
@Deprecated
3234
public class WavefrontOtelSpanExporter implements SpanExporter {
3335

3436
private final WavefrontSpanHandler spanHandler;

micrometer-tracing-reporters/micrometer-tracing-reporter-wavefront/src/main/java/io/micrometer/tracing/reporter/wavefront/WavefrontSpanHandler.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,10 @@
6565
* don't call {@link UUID#timestamp()} on UUIDs converted here, or in other Wavefront
6666
* code, as it might throw an exception.
6767
*
68+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
6869
* @since 1.0.0
6970
*/
71+
@Deprecated
7072
public class WavefrontSpanHandler implements Runnable, Closeable {
7173

7274
private static final InternalLogger LOG = InternalLoggerFactory.getInstance(WavefrontSpanHandler.class);

micrometer-tracing-reporters/micrometer-tracing-reporter-wavefront/src/main/java/io/micrometer/tracing/reporter/wavefront/package-info.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@
1414
* limitations under the License.
1515
*/
1616

17+
/**
18+
* Deprecated since 1.6.0 because Wavefront's End of Life Announcement.
19+
*/
1720
@NullMarked
21+
@Deprecated
1822
package io.micrometer.tracing.reporter.wavefront;
1923

2024
import org.jspecify.annotations.NullMarked;

micrometer-tracing-tests/micrometer-tracing-integration-test/src/main/java/io/micrometer/tracing/test/SampleTestRunner.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,9 @@ void printTracingLink(SampleRunnerConfig sampleRunnerConfig, String traceId) {
345345

346346
/**
347347
* Wavefront Exporter with OTel Tracer.
348+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
348349
*/
350+
@Deprecated
349351
WAVEFRONT_OTEL {
350352
@Override
351353
void run(SampleRunnerConfig sampleRunnerConfig, ObservationRegistry observationRegistry,
@@ -380,7 +382,9 @@ void printTracingLink(SampleRunnerConfig sampleRunnerConfig, String traceId) {
380382

381383
/**
382384
* Wavefront Exporter with Brave Tracer.
385+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
383386
*/
387+
@Deprecated
384388
WAVEFRONT_BRAVE {
385389
@Override
386390
void run(SampleRunnerConfig sampleRunnerConfig, ObservationRegistry observationRegistry,
@@ -529,19 +533,23 @@ public static class Builder {
529533

530534
/**
531535
* Token required to connect to Tanzu Observability by Wavefront.
536+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
532537
* @param wavefrontToken wavefront token
533538
* @return this
534539
*/
540+
@Deprecated
535541
public Builder wavefrontToken(String wavefrontToken) {
536542
this.wavefrontToken = wavefrontToken;
537543
return this;
538544
}
539545

540546
/**
541547
* URL of your Tanzu Observability by Wavefront installation.
548+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
542549
* @param wavefrontUrl wavefront URL.
543550
* @return this
544551
*/
552+
@Deprecated
545553
public Builder wavefrontUrl(String wavefrontUrl) {
546554
this.wavefrontUrl = wavefrontUrl;
547555
return this;
@@ -559,29 +567,35 @@ public Builder zipkinUrl(String zipkinUrl) {
559567

560568
/**
561569
* Name of the application grouping in Tanzu Observability by Wavefront.
570+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
562571
* @param wavefrontApplicationName wavefront application name
563572
* @return this
564573
*/
574+
@Deprecated
565575
public Builder wavefrontApplicationName(String wavefrontApplicationName) {
566576
this.wavefrontApplicationName = wavefrontApplicationName;
567577
return this;
568578
}
569579

570580
/**
571581
* Name of this service in Tanzu Observability by Wavefront.
582+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
572583
* @param wavefrontServiceName wavefront service name
573584
* @return this
574585
*/
586+
@Deprecated
575587
public Builder wavefrontServiceName(String wavefrontServiceName) {
576588
this.wavefrontServiceName = wavefrontServiceName;
577589
return this;
578590
}
579591

580592
/**
581593
* Name of the source to be presented in Tanzu Observability by Wavefront.
594+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
582595
* @param wavefrontSource wavefront source
583596
* @return this
584597
*/
598+
@Deprecated
585599
public Builder wavefrontSource(String wavefrontSource) {
586600
this.wavefrontSource = wavefrontSource;
587601
return this;

micrometer-tracing-tests/micrometer-tracing-integration-test/src/main/java/io/micrometer/tracing/test/reporter/wavefront/WavefrontBraveSetup.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@
4747
/**
4848
* Provides Wavefront setup with Brave.
4949
*
50+
* @deprecated since 1.6.0 because Wavefront's End of Life Announcement
5051
* @author Marcin Grzejszczak
5152
* @since 1.0.0
5253
*/
54+
@Deprecated
5355
public final class WavefrontBraveSetup implements AutoCloseable {
5456

5557
// To be used in tests ONLY

0 commit comments

Comments
 (0)