Rename SpanContext to SpanReference. #1075

carlosalberto · 2020-10-08T16:49:59Z

Renamed SpanContext to SpanReference. This is done in order to prevent the overuse of the Context term.

Inspired by the discussion happening in #1033 - see #1033 (comment)

spec-compliance-matrix.md

anuraaga · 2020-10-09T09:13:09Z

specification/context/api-propagators.md

@@ -76,7 +76,7 @@ Injects the value into a carrier. For example, into the headers of an HTTP reque
 Required arguments:

 - A `Context`. The Propagator MUST retrieve the appropriate value from the `Context` first, such as
-`SpanContext`, `Baggage` or another cross-cutting concern context.
+`SpanReference`, `Baggage` or another cross-cutting concern context.


Since we only put Span in Context, should we use Span for this and the next few files?

@Oberon00 Perhaps this is appropriate for #1079?

I think this would more be a follow-up of #994. I suggested related changes right in this PR as it neatly highlights all usages, but I think you are right that this could be in a separate PR. I don't think it belongs into #1079 though.

specification/metrics/api.md

specification/overview.md

Oberon00 · 2020-10-09T09:12:06Z

specification/overview.md


-### SpanContext
+### SpanReference

 Represents all the information that identifies **Span** in the **Trace** and


Just a suggestion:

Suggested change

Represents all the information that identifies **Span** in the **Trace** and

Represents all the information that is required to reference a **Span** in the **Trace** unambiguously and efficiently and

E.g. in Dynatrace we could reference the span with just span+trace ID but require some routing info in the trace state to do so efficiently. Not sure if this is generally applicable enough.

Definitely something that can be done in a another PR, specially because this was not even touched in this PR.

I think this one is more related to that PR, as the name change reflects a change in the understanding of that type. But I'm fine with doing this in a follow-up too (I already approved)

Oberon00 · 2020-10-09T09:12:34Z

specification/overview.md


 Represents all the information that identifies **Span** in the **Trace** and
 MUST be propagated to child Spans and across process boundaries. A
-**SpanContext** contains the tracing identifiers and the options that are
+**SpanReference** contains the tracing identifiers and the options that are


Suggested change

**SpanReference** contains the tracing identifiers and the options that are

**SpanReference** contains the tracing identifiers, tracestate and the options that are

Same, the lack of trace state is not related to this PR.

specification/overview.md

Oberon00

Generally I'm in favor of this change.

specification/metrics/api.md

arminru

I'm also in favor of this change. Thanks @carlosalberto.

spec-compliance-matrix.md

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

carlosalberto · 2020-10-11T00:50:18Z

Applied some feedback - but please, let's avoid scope creep and do a few things in follow ups (for example, the tracetstate missing part). I applied the SpanContext -> Span (Propagated Span) suggestions to speed up things, but that should have been a different PR.

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

carlosalberto · 2020-10-14T15:39:15Z

@open-telemetry/specs-approvers I will merge this PR by EOD - we have enough approvals, and was already discussed, but want to give some extra time for further reviews ;)

bogdandrutu · 2020-10-14T15:40:14Z

@carlosalberto I think we are good, 5 approvals more than enough

jmacd · 2020-10-21T00:02:18Z

This was discussed in the Spec SIG (APAC edition) today, and there is a will to revert this change to the specification. AI: @carlosalberto ?

tigrannajaryan · 2020-10-21T13:33:23Z

@jmacd it would be great to post a summary of the discussion with the reasoning. I am not against reverting but I am interested in knowing the reasons.

Oberon00 · 2020-10-21T13:44:35Z

I can live with both, but I think SpanContext has the real drawback that it is not the Context of a span.

* Rename SpanContext to SpanReference. * More updates. * Update CHANGELOG * Update specification/metrics/api.md Co-authored-by: Christian Neumüller <christian+github@neumueller.me> * Update specification/metrics/api.md Co-authored-by: Christian Neumüller <christian+github@neumueller.me> * Update specification/metrics/api.md Co-authored-by: Christian Neumüller <christian+github@neumueller.me> * Update specification/metrics/api.md Co-authored-by: Christian Neumüller <christian+github@neumueller.me> * Update specification/overview.md Co-authored-by: Christian Neumüller <christian+github@neumueller.me> * Update specification/overview.md Co-authored-by: Christian Neumüller <christian+github@neumueller.me> * Update specification/metrics/api.md Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com> * Add entry to the compliance matrix. * Update specification/overview.md Co-authored-by: Christian Neumüller <christian+github@neumueller.me> Co-authored-by: Christian Neumüller <christian+github@neumueller.me> Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

…pen-telemetry#1127)

Rename SpanContext to SpanReference.

809fb37

carlosalberto requested review from a team October 8, 2020 16:49

github-actions bot assigned tigrannajaryan Oct 8, 2020

carlosalberto added 2 commits October 8, 2020 18:53

More updates.

32d0d88

Update CHANGELOG

434fcde

carlosalberto requested a review from a team October 8, 2020 16:54

carlosalberto added area:api Cross language API specification issue spec:trace Related to the specification/trace directory labels Oct 8, 2020

Oberon00 reviewed Oct 8, 2020

View reviewed changes

spec-compliance-matrix.md Outdated Show resolved Hide resolved

Oberon00 mentioned this pull request Oct 9, 2020

Update compliance matrix for removal of SpanContext or Span as parent (#510) #1079

Merged

anuraaga reviewed Oct 9, 2020

View reviewed changes

Oberon00 reviewed Oct 9, 2020

View reviewed changes

Oberon00 approved these changes Oct 9, 2020

View reviewed changes

arminru reviewed Oct 9, 2020

View reviewed changes

specification/metrics/api.md Outdated Show resolved Hide resolved

arminru approved these changes Oct 9, 2020

View reviewed changes

spec-compliance-matrix.md Show resolved Hide resolved

carlosalberto and others added 7 commits October 11, 2020 02:46

Update specification/metrics/api.md

674815d

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

Update specification/metrics/api.md

8fcf58c

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

Update specification/metrics/api.md

b411406

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

Update specification/metrics/api.md

a5c2d6b

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

Update specification/overview.md

7c5a93c

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

Update specification/overview.md

e23cc28

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

Update specification/metrics/api.md

1d1be11

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

anuraaga approved these changes Oct 11, 2020

View reviewed changes

carlosalberto and others added 3 commits October 13, 2020 16:44

Merge branch 'master' into rename_spancontext_spanreference

9b267aa

Add entry to the compliance matrix.

3e894df

Update specification/overview.md

01f145b

Co-authored-by: Christian Neumüller <christian+github@neumueller.me>

jmacd approved these changes Oct 13, 2020

View reviewed changes

bogdandrutu approved these changes Oct 14, 2020

View reviewed changes

bogdandrutu merged commit 6647ba3 into open-telemetry:master Oct 14, 2020

jtescher mentioned this pull request Oct 14, 2020

Rename SpanContext to SpanReference open-telemetry/opentelemetry-rust#267

Closed

MrAlias mentioned this pull request Oct 14, 2020

Rename SpanContext to SpanReference open-telemetry/opentelemetry-go#1256

Closed

carlosalberto mentioned this pull request Oct 14, 2020

Make SpanContext optional #999

Closed

ThomsonTan mentioned this pull request Oct 14, 2020

Rename SpanContext to SpanReference open-telemetry/opentelemetry-cpp#362

Closed

jkwatson mentioned this pull request Oct 14, 2020

Rename SpanContext to SpanReference open-telemetry/opentelemetry-java#1801

Closed

fbogsany mentioned this pull request Oct 16, 2020

fix!: rename SpanContext to SpanReference open-telemetry/opentelemetry-ruby#440

Closed

cijothomas mentioned this pull request Oct 21, 2020

SpanContext to SpanReference in API open-telemetry/opentelemetry-dotnet#1377

Closed

carlosalberto added a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 21, 2020

Revert "Rename SpanContext to SpanReference. (open-telemetry#1075)"

77d83d8

carlosalberto mentioned this pull request Oct 21, 2020

Rename SpanReference to SpanContext (revert #1075) #1126

Closed

carlosalberto added a commit that referenced this pull request Oct 23, 2020

Revert "Rename SpanContext to SpanReference. (#1075)" (#1127)

323cd1d

carlosalberto added a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024

Revert "Rename SpanContext to SpanReference. (open-telemetry#1075)" (o…

99c257d

…pen-telemetry#1127)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename SpanContext to SpanReference. #1075

Rename SpanContext to SpanReference. #1075

carlosalberto commented Oct 8, 2020

anuraaga Oct 9, 2020

anuraaga Oct 9, 2020

Oberon00 Oct 9, 2020 •

edited

Loading

Oberon00 Oct 9, 2020

carlosalberto Oct 11, 2020

Oberon00 Oct 14, 2020

Oberon00 Oct 9, 2020

carlosalberto Oct 11, 2020

Oberon00 left a comment

arminru left a comment

carlosalberto commented Oct 11, 2020 •

edited

Loading

carlosalberto commented Oct 14, 2020

bogdandrutu commented Oct 14, 2020

jmacd commented Oct 21, 2020

tigrannajaryan commented Oct 21, 2020

Oberon00 commented Oct 21, 2020

	Represents all the information that identifies Span in the Trace and
	Represents all the information that is required to reference a Span in the Trace unambiguously and efficiently and

	SpanReference contains the tracing identifiers and the options that are
	SpanReference contains the tracing identifiers, tracestate and the options that are

Rename SpanContext to SpanReference. #1075

Rename SpanContext to SpanReference. #1075

Conversation

carlosalberto commented Oct 8, 2020

anuraaga Oct 9, 2020

Choose a reason for hiding this comment

anuraaga Oct 9, 2020

Choose a reason for hiding this comment

Oberon00 Oct 9, 2020 • edited Loading

Choose a reason for hiding this comment

Oberon00 Oct 9, 2020

Choose a reason for hiding this comment

carlosalberto Oct 11, 2020

Choose a reason for hiding this comment

Oberon00 Oct 14, 2020

Choose a reason for hiding this comment

Oberon00 Oct 9, 2020

Choose a reason for hiding this comment

carlosalberto Oct 11, 2020

Choose a reason for hiding this comment

Oberon00 left a comment

Choose a reason for hiding this comment

arminru left a comment

Choose a reason for hiding this comment

carlosalberto commented Oct 11, 2020 • edited Loading

carlosalberto commented Oct 14, 2020

bogdandrutu commented Oct 14, 2020

jmacd commented Oct 21, 2020

tigrannajaryan commented Oct 21, 2020

Oberon00 commented Oct 21, 2020

Oberon00 Oct 9, 2020 •

edited

Loading

carlosalberto commented Oct 11, 2020 •

edited

Loading