# README
lightstep-tracer-go
The LightStep distributed tracing library for Go.
Installation
$ go get 'github.com/lightstep/lightstep-tracer-go'
Getting started
To initialize the LightStep library in particular, either retain a reference to
the LightStep opentracing.Tracer
implementation and/or set the global
Tracer
like so:
import (
"github.com/opentracing/opentracing-go"
"github.com/lightstep/lightstep-tracer-go"
)
func main() {
// Initialize the LightStep Tracer; see lightstep.Options for tuning, etc.
lightstepTracer := lightstep.NewTracer(lightstep.Options{
AccessToken: "YourAccessToken",
})
// Optionally set the opentracing global Tracer to the above
opentracing.SetGlobalTracer(lightstepTracer)
...
}
For instrumentation documentation, see the opentracing-go godocs.
# Packages
No description provided by the author
Package collectorpb is a generated protocol buffer package.
No description provided by the author
No description provided by the author
Code generated by counterfeiter.
Package lightstep is a generated protocol buffer package.
No description provided by the author
# Functions
CloseTracer synchronously flushes the tracer, then terminates it.
FlushLightStepTracer forces a synchronous Flush.
GetLightStepAccessToken returns the currently configured AccessToken.
NewTracer creates and starts a new Lightstep Tracer.
# Constants
BinaryCarrier is used as the format parameter in inject/extract for lighstep binary propogation.
Tag and Tracer Attribute keys.
Tag and Tracer Attribute keys.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
Default Option values.
<- runtime guid, not span guid.
Tag and Tracer Attribute keys.
ParentSpanGUIDKey is the tag key used to record the relationship between child and parent spans.
Tag and Tracer Attribute keys.
Tag and Tracer Attribute keys.
Tag and Tracer Attribute keys.
Note: TracerVersionValue is generated from ./VERSION.
No description provided by the author
# Structs
Endpoint describes a collector or web API host/port and whether or not to use plaintext communication.
Options control how the LightStep Tracer behaves.
RawSpan encapsulates all state associated with a (finished) LightStep Span.
SpanContext holds lightstep-specific Span metadata.
# Interfaces
Connection describes a closable connection.
A SpanRecorder handles all of the `RawSpan` data generated via an associated `Tracer` instance.
Tracer extends the opentracing.Tracer interface with methods to probe implementation state, for use by basictracer consumers.
# Type aliases
ConnectorFactory is for testing purposes.
SetParentSpanID is an opentracing.StartSpanOption that sets an explicit parent SpanID.
SetSpanID is a opentracing.StartSpanOption that sets an explicit SpanID.
SetTraceID is an opentracing.StartSpanOption that sets an explicit TraceID.