tracing

type Detail struct {
	// At is the real world time when the event is recorded.
	At time.Time

	// SimAt is the simulated time tick when the event is recorded.
	SimAt int64

	// CallersName is the short name of the function that triggered the creation
	// of this Detail instance.
	CallersName string

	// StackTrace contains the formatted stack trace at the time this Detail
	// is created.
	StackTrace string

	// Severity is the type of detail created: e.g. informational, warning, or
	// error.
	Severity pbl.Severity

	// Text is the description of the detail event.
	Text string

	// Action is type of detail that is being recorded: a trace event, or the
	// marking of a child trace span creation.
	Action pbl.Action

	// ChildId holds the trace span ID of the child trace span.  It is ignored
	// unless the Action is for a trace span creation.
	ChildId uuid.UUID

	SimEvent SimEvent
}

type EndOption func(*SpanData)

type Forwarder interface {
	// Close the forwarder.  This flushes any in-flight export operations, and
	// terminates the communications with the target trace export instance.
	Close()

	// Export is a function that forwards a trace span's data fields to the
	// trace span exporter.  Processing may be deferred until the exporter is
	// formally opened.
	Export(data *SpanData)
}

type Forwarders []Forwarder

type NoopSpan struct{}

type ReplacementRule struct {
	// contains filtered or unexported fields
}

type Replacements interface {
	Add(rule *ReplacementRule)
	Remove(rule *ReplacementRule)
	Process(text string) string
}

type SimEvent int

type SpanContext struct {
	TraceId uuid.UUID
	Id      uuid.UUID
}

type SpanData struct {
	// ParentId, Id, and TraceId define the unique position of this trace span
	// in a tree of related events.
	ParentId uuid.UUID
	Id       uuid.UUID
	TraceId  uuid.UUID

	// Remote is a flag that is true if the initiator of this trace span did so
	// via some form of remote or asynchronous call.
	Remote bool

	// Name defines a summary string for this instance.
	Name string

	// Reason expands on the summary by supplying user-friendly explanatory text
	// for why the trace span actions happen.
	Reason string

	// StackTrace contains the formatted stack trace at the time the trace span
	// is created.
	StackTrace string

	// SimEvent signals whether this trace span is part of the simulation, or
	// part of the simulator machinery, or indeterminate.  The Infrastructure
	// flag is an about to be obsoleted earlier form of this.
	SimEvent SimEvent

	// impact statement
	Impacts []string

	// Details [set of events]
	Details []*Detail

	// simulated start and end times
	SimStart int64
	SimEnd   int64

	// real world start and end times
	WallStart time.Time
	WallEnd   time.Time
	// contains filtered or unexported fields
}

type SpanEx interface {
	// Modify updates the span data using the same WithXxx functions that are
	// used for starting a span.
	Modify(ctx context.Context, options ...StartSpanOption) context.Context

	// End terminates an open span, with the option for setting final attributes.
	End(opts ...EndOption)

	// SetReason sets the friendly description string on this span to a
	// formatted string using the supplied arguments.
	SetReason(a ...interface{})

	// SetName replaces the current span name string with the formatted string
	// provided.
	SetName(a ...interface{})

	// AddDetail adds the new event detail to this span
	AddDetail(detail *Detail)

	// AddImpact adds an impact claim to this span.
	AddImpact(level string, module string)

	// SetStatus sets a completion status attribute for this span.
	SetStatus(sev pbl.Severity, message string)

	// Closed returns true if this span has already ended; false, otherwise.
	Closed() bool

	// SimEvent returns the in/out/maybe simulation designator for the span.
	SimEvent() SimEvent

	// SetSimEvent updates the in/out/maybe simulation designator for the span.
	SetSimEvent(event SimEvent)

	// SpanContext returns the current trace and span UUIDs, or the empty UUID
	// for the values, if no span is currently active.
	SpanContext() SpanContext
}

type SpanImpl struct {
	// contains filtered or unexported fields
}

type StartSpanOption func(*SpanData)

type TraceAnnotation func(cfg *TraceDetail)

type TraceDetail struct {
	// contains filtered or unexported fields
}

type Tracer struct {
	// contains filtered or unexported fields
}