Skip to content

Commit

Permalink
Deprecates tracing support for dependencies not released in 2+ years (#…
Browse files Browse the repository at this point in the history
…1392)

This deprecates for removal the following, as they have not been updated
in a long time. The exception to this rule is log4j context, which is
widely used even if not updated recently.

* context/rxjava2 - last released Feb 2021
  * replaced by RxJava3, but unlikely this module will be ported as it
    wasn't used widely.
* instrumentation/dubbo-rpc - (alibaba) last released Dec 2021
  * replaced by Apache Dubbo instrumentation/dubbo
* instrumentation/p6spy - last released July 2020
  * project dormant
* instrumentation/sparkjava - last released July 2022
  * project dormant

These will be removed in Brave 6 and can be re-introduced if something
changes.

Signed-off-by: Adrian Cole <adrian@tetrate.io>
  • Loading branch information
codefromthecrypt committed Jan 6, 2024
1 parent 06306a3 commit f037afd
Show file tree
Hide file tree
Showing 57 changed files with 113 additions and 59 deletions.
2 changes: 1 addition & 1 deletion brave-bom/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<groupId>io.zipkin.brave</groupId>
<artifactId>brave-bom</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
<name>Brave BOM</name>
<description>Bill Of Materials POM for all Brave artifacts</description>
<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion brave-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion brave/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>

<artifactId>brave</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion context/jfr/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-context-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion context/log4j12/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-context-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion context/log4j2/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-context-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion context/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>

<artifactId>brave-context-parent</artifactId>
Expand Down
8 changes: 8 additions & 0 deletions context/rxjava2/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# brave-context-rxjava2

## Deprecated

RxJava 2 hasn't been released since Feb 2021. Tracing support will be removed
in Brave v6.

## Overview

`CurrentTraceContextAssemblyTracking` prevents traces from breaking
during RxJava operations by scoping trace context that existed
at assembly time around callbacks or computation of new values.
Expand Down
2 changes: 1 addition & 1 deletion context/rxjava2/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-context-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2019 The OpenZipkin Authors
* Copyright 2013-2024 The OpenZipkin Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
Expand Down Expand Up @@ -34,7 +34,11 @@
*
* <p>The design of this library borrows heavily from https://github.com/akaita/RxJava2Debug and
* https://github.com/akarnokd/RxJava2Extensions
*
* @deprecated RxJava 2 hasn't been released since Feb 2021. Tracing support will be removed in
* Brave v6.
*/
@Deprecated
public final class CurrentTraceContextAssemblyTracking {
public interface SavedHooks {

Expand Down
2 changes: 1 addition & 1 deletion context/slf4j/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-context-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/benchmarks/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>

<artifactId>brave-instrumentation-benchmarks</artifactId>
Expand Down
9 changes: 9 additions & 0 deletions instrumentation/dubbo-rpc/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# brave-instrumentation-dubbo-rpc

## Deprecated

Please use [brave-instrumentation-dubbo](../brave-instrumentation-dubbo) with
Apache Dubbo, as Alibaba Dubbo is no longer maintained. This module will be
removed in Brave v6.

## Overview

This is a tracing filter for RPC providers and consumers in [Dubbo 2.6+](http://dubbo.apache.org/en-us/docs/dev/impls/filter.html)

When used on a consumer, `TracingFilter` adds trace state as attachments
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/dubbo-rpc/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2023 The OpenZipkin Authors
* Copyright 2013-2024 The OpenZipkin Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
Expand Down Expand Up @@ -43,6 +43,11 @@

import static brave.internal.Throwables.propagateIfFatal;

/**
* @deprecated please use io.zipkin.brave:brave-instrumentation-dubbo with Apache Dubbo, as Alibaba
* Dubbo is no longer maintained. Tracing support for Alibaba Dubbo will be removed in Brave v6.
*/
@Deprecated
@Activate(group = {Constants.PROVIDER, Constants.CONSUMER}, value = "tracing")
// http://dubbo.apache.org/en-us/docs/dev/impls/filter.html
// public constructor permitted to allow dubbo to instantiate this
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2023 The OpenZipkin Authors
* Copyright 2013-2024 The OpenZipkin Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
Expand All @@ -13,6 +13,7 @@
*/
package brave.dubbo.rpc;

import brave.rpc.RpcTracing;
import brave.test.ITRemote;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
import com.alibaba.dubbo.config.ReferenceConfig;
Expand All @@ -32,7 +33,7 @@ public abstract class ITTracingFilter extends ITRemote {
TracingFilter init() {
TracingFilter filter = (TracingFilter) ExtensionLoader.getExtensionLoader(Filter.class)
.getExtension("tracing");
filter.setTracing(tracing);
filter.setRpcTracing(RpcTracing.create(tracing));
return filter;
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2023 The OpenZipkin Authors
* Copyright 2013-2024 The OpenZipkin Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
Expand Down Expand Up @@ -205,7 +205,7 @@ class ITTracingFilter_Consumer extends ITTracingFilter {
MutableSpan span =
testSpanHandler.takeRemoteSpanWithErrorMessage(CLIENT, ".*Not found exported service.*");
assertThat(span.tags())
.containsEntry("dubbo.error_code", "1");
.containsEntry("rpc.error_code", "NETWORK_EXCEPTION");
}

/** Shows if you aren't using RpcTracing, the old "dubbo.error_code" works */
Expand Down
4 changes: 2 additions & 2 deletions instrumentation/dubbo/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand All @@ -30,7 +30,7 @@

<main.basedir>${project.basedir}/../..</main.basedir>

<dubbo.version>3.2.9</dubbo.version>
<dubbo.version>3.3.0-beta.1</dubbo.version>
<!-- add opens to avoid below in JRE 21:
com.alibaba.com.caucho.hessian.io.JavaSerializer -->
<maven-failsafe-plugin.argLine>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2023 The OpenZipkin Authors
* Copyright 2013-2024 The OpenZipkin Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
Expand All @@ -13,6 +13,7 @@
*/
package brave.dubbo;

import brave.rpc.RpcTracing;
import brave.test.ITRemote;
import org.apache.dubbo.common.extension.ExtensionLoader;
import org.apache.dubbo.config.ApplicationConfig;
Expand Down Expand Up @@ -44,7 +45,7 @@ static ApplicationConfig getApplicationConfig() {
TracingFilter init() {
TracingFilter filter = (TracingFilter) ExtensionLoader.getExtensionLoader(Filter.class)
.getExtension("tracing");
filter.setTracing(tracing);
filter.setRpcTracing(RpcTracing.create(tracing));
return filter;
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2013-2023 The OpenZipkin Authors
* Copyright 2013-2024 The OpenZipkin Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
Expand Down Expand Up @@ -236,7 +236,7 @@ class ITTracingFilter_Consumer extends ITTracingFilter {
testSpanHandler.takeRemoteSpanWithErrorMessage(CLIENT, ".*Fail to decode request.*");

assertThat(span.tags())
.containsEntry("dubbo.error_code", "1");
.containsEntry("rpc.error_code", "NETWORK_EXCEPTION");
}

/** Shows if you aren't using RpcTracing, the old "dubbo.error_code" works */
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/grpc/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/http-tests-jakarta/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/http-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/http/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/httpasyncclient/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/httpclient/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/httpclient5/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>

<artifactId>brave-instrumentation-httpclient5</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/jakarta-jms/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/jaxrs2/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/jersey-server/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/jms-jakarta/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/jms/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/kafka-clients/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>

<artifactId>brave-instrumentation-kafka-clients</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/kafka-streams/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
2 changes: 1 addition & 1 deletion instrumentation/messaging/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<parent>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-parent</artifactId>
<version>5.17.2-SNAPSHOT</version>
<version>5.18.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

Expand Down
Loading

0 comments on commit f037afd

Please sign in to comment.