forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-08-20 10:52:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

swarm/tracing: Add comments

Browse source
This commit is contained in:
lash 2019-02-15 11:42:49 +01:00
parent bfd3346532
commit c9fbfac7d5
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
swarm/tracing/tracing.go
View file

@ -22,11 +22,13 @@ var (
store = spanStore{} store = spanStore{}
) )
// TracingEnabledFlag is the CLI flag name to use to enable trace collections.
const ( const (
// TracingEnabledFlag is the CLI flag name to use to enable trace collections.
TracingEnabledFlag = "tracing" TracingEnabledFlag = "tracing"
StoreLabelId = "span_save_id"
StoreLabelMeta = "span_save_meta" // StoreLabels are used to pass span information through context instances to the span store
StoreLabelId = "span_save_id"
StoreLabelMeta = "span_save_meta"
) )
var ( var (
@ -113,10 +115,14 @@ func initTracer(endpoint, svc string) (closer io.Closer) {
return closer return closer
} }
// spanStore holds saved spans
type spanStore struct { type spanStore struct {
spans sync.Map spans sync.Map
} }
// StartSaveSpan stores the span specified in the passed context for later retrieval
// The span object but be context value on the key StoreLabelId.
// It will be stored under the the following string key context.Value(StoreLabelId)|.|context.Value(StoreLabelMeta)
func StartSaveSpan(ctx context.Context) context.Context { func StartSaveSpan(ctx context.Context) context.Context {
if !Enabled { if !Enabled {
return ctx return ctx
@ -139,6 +145,8 @@ func StartSaveSpan(ctx context.Context) context.Context {
return ctx return ctx
} }
// ShiftSpanByKey retrieves the span stored under the key of the string given as argument
// The span is then deleted from the store
func ShiftSpanByKey(k string) opentracing.Span { func ShiftSpanByKey(k string) opentracing.Span {
if !Enabled { if !Enabled {
return nil return nil
@ -151,6 +159,8 @@ func ShiftSpanByKey(k string) opentracing.Span {
return span.(opentracing.Span) return span.(opentracing.Span)
} }
// FinishSpans calls `Finish()` on all stored spans
// It should be called on instance shutdown
func FinishSpans() { func FinishSpans() {
store.spans.Range(func(k, v interface{}) bool { store.spans.Range(func(k, v interface{}) bool {
v.(opentracing.Span).Finish() v.(opentracing.Span).Finish()