From d0ccb4a278f06d4d3c27c7eeed13e3db382b4c49 Mon Sep 17 00:00:00 2001 From: Carlos Alberto Cortez Date: Wed, 13 Mar 2019 03:53:36 +0100 Subject: [PATCH 1/3] Add a deprecation note for AutoFinishScopeManager/AutoFinishScope. --- .../src/main/java/io/opentracing/util/AutoFinishScope.java | 7 +++++++ .../java/io/opentracing/util/AutoFinishScopeManager.java | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java index 2a6270ec..32e3979d 100644 --- a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java +++ b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java @@ -19,6 +19,13 @@ import java.util.concurrent.atomic.AtomicInteger; +/** + * {@link AutoFinishScope} is a {@link Scope} implementation that uses ref-counting + * to automatically finish the wrapped {@link Span}. + * + * @see AutoFinishScopeManager + */ +@Deprecated public class AutoFinishScope implements Scope { final AutoFinishScopeManager manager; final AtomicInteger refCount; diff --git a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java index d186cf00..10b59c92 100644 --- a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java +++ b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java @@ -18,6 +18,13 @@ import java.util.concurrent.atomic.AtomicInteger; +/** + * @deprecated use {@link ThreadLocalScopeManager} instead. + * A {@link ScopeManager} implementation that uses ref-counting to automatically finish {@link Span}s. + * + * @see AutoFinishScope + */ +@Deprecated public class AutoFinishScopeManager implements ScopeManager { final ThreadLocal tlsScope = new ThreadLocal(); From 473a45a9eb94934bacc357c95e0b20d0430fa667 Mon Sep 17 00:00:00 2001 From: Carlos Alberto Cortez Date: Wed, 13 Mar 2019 17:23:51 +0100 Subject: [PATCH 2/3] Add a clarification on why we are deprecating this. --- .../src/main/java/io/opentracing/util/AutoFinishScope.java | 4 ++++ .../main/java/io/opentracing/util/AutoFinishScopeManager.java | 3 +++ 2 files changed, 7 insertions(+) diff --git a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java index 32e3979d..f5301eba 100644 --- a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java +++ b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScope.java @@ -20,6 +20,10 @@ import java.util.concurrent.atomic.AtomicInteger; /** + * @deprecated use {@link ThreadLocalScope} instead. + * The operation mode of this class contrasts with the 0.32 + * deprecation of auto finishing {@link Span}s upon {@link Scope#close()}. + * {@link AutoFinishScope} is a {@link Scope} implementation that uses ref-counting * to automatically finish the wrapped {@link Span}. * diff --git a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java index 10b59c92..4f79dd8f 100644 --- a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java +++ b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java @@ -20,6 +20,9 @@ /** * @deprecated use {@link ThreadLocalScopeManager} instead. + * The operation mode of this class contrasts with the 0.32 + * deprecation of auto finishing {@link Span}s upon {@link Scope#close()}. + * * A {@link ScopeManager} implementation that uses ref-counting to automatically finish {@link Span}s. * * @see AutoFinishScope From 9ccbc1c0f6d5bb674d046fd26cfd3785557afc69 Mon Sep 17 00:00:00 2001 From: Carlos Alberto Cortez Date: Wed, 13 Mar 2019 21:32:10 +0100 Subject: [PATCH 3/3] Mention the Issue that lead to deprecating auto finish. --- .../main/java/io/opentracing/util/AutoFinishScopeManager.java | 1 + 1 file changed, 1 insertion(+) diff --git a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java index 4f79dd8f..fcb7455f 100644 --- a/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java +++ b/opentracing-util/src/main/java/io/opentracing/util/AutoFinishScopeManager.java @@ -22,6 +22,7 @@ * @deprecated use {@link ThreadLocalScopeManager} instead. * The operation mode of this class contrasts with the 0.32 * deprecation of auto finishing {@link Span}s upon {@link Scope#close()}. + * See https://github.com/opentracing/opentracing-java/issues/291 * * A {@link ScopeManager} implementation that uses ref-counting to automatically finish {@link Span}s. *