Deprecate methods to complete spans with metadata (#347)

* Deprecate methods to complete spans with metadata

* Add generated changelog entries

* Comments

Co-authored-by: Carter Kozak <[email protected]>

Co-authored-by: Carter Kozak <[email protected]>

Author: pkoenig10

changelog/@unreleased/pr-347.v2.yml

@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Methods to complete spans with metadata are now deprecated.
+  links:
+  - https://github.com/palantir/tracing-java/pull/347

tracing/src/main/java/com/palantir/tracing/Tracer.java

@@ -455,7 +455,12 @@ public static void fastCompleteSpan() {
         fastCompleteSpan(Collections.emptyMap());
     }
 
-    /** Like {@link #fastCompleteSpan()}, but adds {@code metadata} to the current span being completed. */
+    /**
+     * Like {@link #fastCompleteSpan()}, but adds {@code metadata} to the current span being completed.
+     *
+     * @deprecated Use {@link #fastCompleteSpan()}
+     */
+    @Deprecated
     public static void fastCompleteSpan(Map<String, String> metadata) {
         Trace trace = currentTrace.get();
         if (trace != null) {
@@ -483,10 +488,13 @@ public static Optional<Span> completeSpan() {
     }
 
     /**
-     * Like {@link #completeSpan()}, but adds {@code metadata} to the current span being completed. If the return value
-     * is not used, prefer {@link Tracer#fastCompleteSpan(Map)}.
+     * Like {@link #completeSpan()}, but adds {@code metadata} to the current span being completed.
+     * If the return value is not used, prefer {@link Tracer#fastCompleteSpan(Map)}.
+     *
+     * @deprecated Use {@link #fastCompleteSpan()}
      */
     @CheckReturnValue
+    @Deprecated
     public static Optional<Span> completeSpan(Map<String, String> metadata) {
         Trace trace = currentTrace.get();
         if (trace == null) {

tracing/src/test/java/com/palantir/tracing/TracerTest.java

@@ -249,6 +249,7 @@ public void testCompletedSpanHasCorrectSpanType() throws Exception {
     }
 
     @Test
+    @SuppressWarnings("deprecation")
     public void testCompleteSpanWithMetadataIncludesMetadata() {
         Map<String, String> metadata = ImmutableMap.of(
                 "key1", "value1",
@@ -275,6 +276,7 @@ public void testFastCompleteSpan() {
     }
 
     @Test
+    @SuppressWarnings("deprecation")
     public void testFastCompleteSpanWithMetadata() {
         Tracer.subscribe("1", observer1);
         Map<String, String> metadata = ImmutableMap.of("key", "value");