go/opentelemetry-go
go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-02-09 13:37:12 +02:00
Code Issues Releases Activity

Clean up SDK span field docs (#1312)

Browse Source 
Remove cruft about spanStore.

Update documentation about how span.mu is used (related to #1311).

Reformat to conform with idiomatic field documentation.
This commit is contained in:
Tyler Yahn 2020-11-09 10:40:02 -08:00 committed by GitHub
parent 1041adaf58
commit a354c026b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
sdk/trace/span.go
View File

@ -41,13 +41,15 @@ var emptySpanContext = trace.SpanContext{}
// span is an implementation of the OpenTelemetry Span API representing the // span is an implementation of the OpenTelemetry Span API representing the
// individual component of a trace. // individual component of a trace.
type span struct { type span struct {
// mu protects the contents of this span.
mu sync.Mutex
// data contains information recorded about the span. // data contains information recorded about the span.
// //
// It will be non-nil if we are exporting the span or recording events for it. // It will be non-nil if we are exporting the span or recording events for it.
// Otherwise, data is nil, and the span is simply a carrier for the // Otherwise, data is nil, and the span is simply a carrier for the
// SpanContext, so that the trace ID is propagated. // SpanContext, so that the trace ID is propagated.
data *export.SpanData data *export.SpanData
mu sync.Mutex // protects the contents of *data (but not the pointer value.)
spanContext trace.SpanContext spanContext trace.SpanContext
// attributes are capped at configured limit. When the capacity is reached an oldest entry // attributes are capped at configured limit. When the capacity is reached an oldest entry
@ -60,12 +62,14 @@ type span struct {
// links are stored in FIFO queue capped by configured limit. // links are stored in FIFO queue capped by configured limit.
links *evictedQueue links *evictedQueue
// spanStore is the spanStore this span belongs to, if any, otherwise it is nil. // endOnce ensures End is only called once.
//*spanStore
endOnce sync.Once endOnce sync.Once
executionTracerTaskEnd func() // ends the execution tracer span // executionTracerTaskEnd ends the execution tracer span.
tracer *tracer // tracer used to create span. executionTracerTaskEnd func()
// tracer is the SDK tracer that created this span.
tracer *tracer
} }
var _ trace.Span = &span{} var _ trace.Span = &span{}
@ -215,7 +219,6 @@ func (s *span) SetName(name string) {
ctx = trace.SpanContext{} ctx = trace.SpanContext{}
} else { } else {
// FIXME: Where do we get the parent context from? // FIXME: Where do we get the parent context from?
// From SpanStore?
ctx = s.data.SpanContext ctx = s.data.SpanContext
} }
data := samplingData{ data := samplingData{
@ -328,8 +331,6 @@ func startSpanInternal(tr *tracer, name string, parent trace.SpanContext, remote
} }
sampled := makeSamplingDecision(data) sampled := makeSamplingDecision(data)
// TODO: [rghetia] restore when spanstore is added.
// if !internal.LocalSpanStoreEnabled && !span.spanContext.IsSampled() && !o.Record {
if !span.spanContext.IsSampled() && !o.Record { if !span.spanContext.IsSampled() && !o.Record {
return span return span
} }
@ -356,14 +357,6 @@ func startSpanInternal(tr *tracer, name string, parent trace.SpanContext, remote
if !noParent { if !noParent {
span.data.ParentSpanID = parent.SpanID span.data.ParentSpanID = parent.SpanID
} }
// TODO: [rghetia] restore when spanstore is added.
//if internal.LocalSpanStoreEnabled {
// ss := spanStoreForNameCreateIfNew(name)
// if ss != nil {
// span.spanStore = ss
// ss.add(span)
// }
//}
return span return span
} }