telemetry

Documentation

Index

• Constants
• func ContextWithTracer(parent context.Context, tracer Tracer) context.Context
• func HashAttribute(value string) string
• func IsCI() bool
• func IsFaaS() bool
• func MapToAttributes(m map[string]int64) []attribute.KeyValue
• func RecordError(span trace.Span, err error, opts ...trace.EventOption) bool
• type Client
  • func New(ctx context.Context, options ...Option) *Client
  • func (c *Client) Enabled() bool
  • func (c *Client) HasError() error
  • func (c *Client) NewRandomId() bool
  • func (c *Client) RandomId() string
  • func (c *Client) Shutdown(ctx context.Context)
  • func (c *Client) Tracer(ctx context.Context) (context.Context, Tracer)
• type Option
  • func WithDebug() Option
  • func WithDisabled() Option
  • func WithEndpoint(endpoint string, insecure bool) Option
  • func WithExporter(w io.WriteCloser) Option
  • func WithFS(fs afero.Fs) Option
  • func WithLogger(logger hclog.Logger) Option
  • func WithResource(res *resource.Resource) Option
  • func WithVersionInfo(version, commit, buildDate string) Option
• type SpanCloser
  • func StartSpanFromContext(ctx context.Context, spanName string, opts ...otrace.SpanStartOption) (context.Context, SpanCloser)
• type Tracer
  • func TracerFromContext(ctx context.Context) Tracer

Constants

const CQTeamID = "12345678-0000-0000-0000-c1a0dbeef000"

Functions

func ContextWithTracer

func ContextWithTracer(parent context.Context, tracer Tracer) context.Context

ContextWithTracer returns a copy of given context with tracer set as the current Tracer.

func HashAttribute

func HashAttribute(value string) string

HashAttribute creates a one-way hash from an attribute

func IsCI

func IsCI() bool

IsCI determines if we're running under a CI env by checking CI-specific env vars

func IsFaaS

func IsFaaS() bool

IsFaaS determines if we're running under a Lambda env by checking Lambda-specific env vars

func MapToAttributes

func MapToAttributes(m map[string]int64) []attribute.KeyValue

func RecordError

func RecordError(span trace.Span, err error, opts ...trace.EventOption) bool

RecordError should be called on a span to mark it as errored. Returns true if err was recorded.

Types

type Client

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

Client is the telemetry client.

func New

func New(ctx context.Context, options ...Option) *Client

func (*Client) Enabled

func (c *Client) Enabled() bool

func (*Client) HasError

func (c *Client) HasError() error

func (*Client) NewRandomId

func (c *Client) NewRandomId() bool

NewRandomId returns true if we created a new random id in this session

func (*Client) RandomId

func (c *Client) RandomId() string

RandomId returns the generated ID

func (*Client) Shutdown

func (c *Client) Shutdown(ctx context.Context)

func (*Client) Tracer

func (c *Client) Tracer(ctx context.Context) (context.Context, Tracer)

type Option

type Option func(*Client)

func WithDebug

func WithDebug() Option

func WithDisabled

func WithDisabled() Option

func WithEndpoint

func WithEndpoint(endpoint string, insecure bool) Option

func WithExporter

func WithExporter(w io.WriteCloser) Option

func WithFS

func WithFS(fs afero.Fs) Option

func WithLogger

func WithLogger(logger hclog.Logger) Option

func WithResource

func WithResource(res *resource.Resource) Option

func WithVersionInfo

func WithVersionInfo(version, commit, buildDate string) Option

type SpanCloser

type SpanCloser func(error, ...otrace.SpanEndOption) bool

SpanCloser gets an error and options and ends the span its attached to

func StartSpanFromContext

func StartSpanFromContext(ctx context.Context, spanName string, opts ...otrace.SpanStartOption) (context.Context, SpanCloser)

StartSpanFromContext starts the span from a given context with the given options, and returns a new context with span attached, as well as a closer fn. Returned SpanCloser should be called when done with span. To catch panics, it should be used under a defer.

type Tracer

type Tracer interface {
	otrace.Tracer
}

func TracerFromContext

func TracerFromContext(ctx context.Context) Tracer

TracerFromContext returns the current Tracer from ctx.

If no Tracer is currently set in ctx, a noopTracer is returned.