telemetry

Documentation

Index

• type Client
  • func New(ctx context.Context, options ...Option) *Client
  • func (c *Client) HasError() error
  • func (c *Client) NewRandomId() bool
  • func (c *Client) RecordError(span otrace.Span, err error, opts ...otrace.EventOption)
  • func (c *Client) Shutdown(ctx context.Context)
  • func (c *Client) Tracer() otrace.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

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) 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) RecordError

func (c *Client) RecordError(span otrace.Span, err error, opts ...otrace.EventOption)

RecordError should be called on a span to mark it as errored. Error values are not included unless debug mode is on.

func (*Client) Shutdown

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

func (*Client) Tracer

func (c *Client) Tracer() otrace.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