Adds getParentSpanContext to ReadableSpan interface (open-telemetry#3454)

HaloFour · web-flow · commit b5f56ccac747 · 2021-08-08T11:17:40.000+09:00
* Adds getParentSpanContext to ReadableSpan

* Unit tests
diff --git a/docs/apidiffs/current_vs_latest/opentelemetry-sdk-trace.txt b/docs/apidiffs/current_vs_latest/opentelemetry-sdk-trace.txt
@@ -1,4 +1,7 @@
 Comparing source compatibility of  against 
+**** MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.trace.ReadableSpan  (not serializable)
+	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
+	+++* NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.api.trace.SpanContext getParentSpanContext()
 ***! MODIFIED INTERFACE: PUBLIC ABSTRACT io.opentelemetry.sdk.trace.samplers.SamplingResult  (not serializable)
 	===  CLASS FILE FORMAT VERSION: 52.0 <- 52.0
 	+++! NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.sdk.trace.samplers.SamplingResult drop()
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/ReadableSpan.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/ReadableSpan.java
@@ -23,6 +23,14 @@ public interface ReadableSpan {
    */
   SpanContext getSpanContext();
 
+  /**
+   * Returns the parent {@link SpanContext} of the {@link Span}, or {@link SpanContext#getInvalid()}
+   * if this is a root span.
+   *
+   * @return the parent {@link SpanContext} of the {@link Span}
+   */
+  SpanContext getParentSpanContext();
+
   /**
    * Returns the name of the {@code Span}.
    *
diff --git a/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/RecordEventsReadableSpan.java b/sdk/trace/src/main/java/io/opentelemetry/sdk/trace/RecordEventsReadableSpan.java
@@ -202,6 +202,11 @@ public SpanContext getSpanContext() {
     return context;
   }
 
+  @Override
+  public SpanContext getParentSpanContext() {
+    return parentSpanContext;
+  }
+
   /**
    * Returns the name of the {@code Span}.
    *
@@ -451,10 +456,6 @@ private StatusData getSpanDataStatus() {
     }
   }
 
-  SpanContext getParentSpanContext() {
-    return parentSpanContext;
-  }
-
   Resource getResource() {
     return resource;
   }
diff --git a/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/RecordEventsReadableSpanTest.java b/sdk/trace/src/test/java/io/opentelemetry/sdk/trace/RecordEventsReadableSpanTest.java
@@ -214,10 +214,26 @@ void toSpanData_RootSpan() {
     } finally {
       span.end();
     }
+    assertThat(span.getParentSpanContext().isValid()).isFalse();
     SpanData spanData = span.toSpanData();
     assertThat(SpanId.isValid(spanData.getParentSpanId())).isFalse();
   }
 
+  @Test
+  void toSpanData_ChildSpan() {
+    RecordEventsReadableSpan span = createTestSpan(SpanKind.INTERNAL);
+    try {
+      spanDoWork(span, null, null);
+    } finally {
+      span.end();
+    }
+    assertThat(span.getParentSpanContext().isValid()).isTrue();
+    assertThat(span.getParentSpanContext().getTraceId()).isEqualTo(traceId);
+    assertThat(span.getParentSpanContext().getSpanId()).isEqualTo(parentSpanId);
+    SpanData spanData = span.toSpanData();
+    assertThat(spanData.getParentSpanId()).isEqualTo(parentSpanId);
+  }
+
   @Test
   void toSpanData_WithInitialAttributes() {
     RecordEventsReadableSpan span = createTestSpanWithAttributes(attributes);

Original file line number	Diff line number	Diff line change
`@@ -202,6 +202,11 @@ public SpanContext getSpanContext() {`
`202`	`202`	`return context;`
`203`	`203`	`}`
`204`	`204`
	`205`	`+ @Override`
	`206`	`+ public SpanContext getParentSpanContext() {`
	`207`	`+ return parentSpanContext;`
	`208`	`+ }`
	`209`	`+`
`205`	`210`	`/**`
`206`	`211`	`* Returns the name of the {@code Span}.`
`207`	`212`	`*`
`@@ -451,10 +456,6 @@ private StatusData getSpanDataStatus() {`
`451`	`456`	`}`
`452`	`457`	`}`
`453`	`458`
`454`		`- SpanContext getParentSpanContext() {`
`455`		`- return parentSpanContext;`
`456`		`- }`
`457`		`-`
`458`	`459`	`Resource getResource() {`
`459`	`460`	`return resource;`
`460`	`461`	`}`