observability

Documentation

Index

• func GetContextWithTraceId(ctx context.Context, traceId string) context.Context
• type ErrorReporter
  • func NewErrorReporter(logger *zerolog.Logger) ErrorReporter
• type ErrorReporterOptions
• type Instrumentor
  • func NewInstrumentor() Instrumentor
• type NoopSpan
  • func NewNoopSpan(ctx context.Context, operation string, txName string, started bool, ...) *NoopSpan
  • func (n *NoopSpan) Context() context.Context
  • func (n *NoopSpan) Finish()
  • func (n *NoopSpan) GetDurationMs() int64
  • func (n *NoopSpan) GetOperation() string
  • func (n *NoopSpan) GetTraceId() string
  • func (n *NoopSpan) GetTxName() string
  • func (n *NoopSpan) SetTransactionName(txName string)
  • func (n *NoopSpan) StartSpan(ctx context.Context)
• type Span
• type SpanRecorder
• type TraceIdContextKey

Functions

func GetContextWithTraceId

func GetContextWithTraceId(ctx context.Context, traceId string) context.Context

GetContextWithTraceId Returns a child context with "trace_id" set to the given traceId

Types

type ErrorReporter

type ErrorReporter interface {
	FlushErrorReporting()
	CaptureError(err error, options ErrorReporterOptions) bool
}

func NewErrorReporter

func NewErrorReporter(logger *zerolog.Logger) ErrorReporter

type ErrorReporterOptions

type ErrorReporterOptions struct {
	ErrorDiagnosticPath string
}

type Instrumentor

type Instrumentor interface {
	StartSpan(ctx context.Context, operation string) Span
	NewTransaction(
		ctx context.Context,
		txName string,
		operation string,
	) Span
	Finish(span Span)
}

Instrumentor exposes functions used for adding instrumentation context to functions.

func NewInstrumentor

func NewInstrumentor() Instrumentor

type NoopSpan

type NoopSpan struct {
	Operation string
	TxName    string
	Started   bool
	Finished  bool

	StartTime  int64
	FinishTime int64
	// contains filtered or unexported fields
}

func NewNoopSpan

func NewNoopSpan(ctx context.Context, operation string, txName string, started bool, finished bool) *NoopSpan

func (*NoopSpan) Context

func (n *NoopSpan) Context() context.Context

func (*NoopSpan) Finish

func (n *NoopSpan) Finish()

func (*NoopSpan) GetDurationMs

func (n *NoopSpan) GetDurationMs() int64

func (*NoopSpan) GetOperation

func (n *NoopSpan) GetOperation() string

func (*NoopSpan) GetTraceId

func (n *NoopSpan) GetTraceId() string

func (*NoopSpan) GetTxName

func (n *NoopSpan) GetTxName() string

func (*NoopSpan) SetTransactionName

func (n *NoopSpan) SetTransactionName(txName string)

func (*NoopSpan) StartSpan

func (n *NoopSpan) StartSpan(ctx context.Context)

type Span

type Span interface {
	SetTransactionName(name string)
	StartSpan(ctx context.Context)
	Finish()
	GetOperation() string
	GetTxName() string

	// GetTraceId Returns UUID of the trace
	GetTraceId() string
	Context() context.Context

	GetDurationMs() int64
}

Span exposes functions that have context about functions.

type SpanRecorder

type SpanRecorder interface {
	Record(span Span)
	Spans() []Span
	ClearSpans()
	Finish(span Span)
}

type TraceIdContextKey

type TraceIdContextKey string