contract

Documentation

Index

• type Collector
• type Logger
• type Span
• type StateMachine
• type Tracer

Types

type Collector

type Collector interface {
	Configure() error // Configure initializes the tracer with the necessary settings.

	WithBucketBoundaries(bounds []float64) Collector

	IntCounter(
		ctx context.Context,
		name string,
		count int,
		description string,
		attrs ...map[string]interface{},
	) error
	IntUpDownCounter(
		ctx context.Context,
		name string,
		count int,
		description string,
		attrs ...map[string]interface{},
	) error
	IntGauge(
		ctx context.Context,
		name string,
		count int,
		description string,
		attrs ...map[string]interface{},
	) error
	IntHistogram(
		ctx context.Context,
		name string,
		count int,
		description string,
		attrs ...map[string]interface{},
	) error

	FloatCounter(
		ctx context.Context,
		name string,
		count float64,
		description string,
		attrs ...map[string]interface{},
	) error
	FloatUpDownCounter(
		ctx context.Context,
		name string,
		count float64,
		description string,
		attrs ...map[string]interface{},
	) error
	FloatGauge(
		ctx context.Context,
		name string,
		count float64,
		description string,
		attrs ...map[string]interface{},
	) error
	FloatHistogram(
		ctx context.Context,
		name string,
		count float64,
		description string,
		attrs ...map[string]interface{},
	) error

	AsyncIntCounter(
		name string,
		count int,
		description string,
		attrs ...map[string]interface{},
	) error
	AsyncIntUpDownCounter(
		name string,
		count int,
		description string,
		attrs ...map[string]interface{},
	) error
	AsyncIntGauge(
		name string,
		count int,
		description string,
		attrs ...map[string]interface{},
	) error
	AsyncFloatCounter(
		name string,
		count float64,
		description string,
		attrs ...map[string]interface{},
	) error
	AsyncFloatUpDownCounter(
		name string,
		count float64,
		description string,
		attrs ...map[string]interface{},
	) error
	AsyncFloatGauge(
		name string,
		count float64,
		description string,
		attrs ...map[string]interface{},
	) error

	Shutdown(ctx context.Context) error // Shutdown gracefully shuts down the tracer provider and flushes spans.
}

type Logger

type Logger interface {
	Info(args ...interface{})
	Infof(msg string, args ...interface{})
	Infow(msg string, keysAndValues ...interface{})
	Debug(args ...interface{})
	Debugf(msg string, args ...interface{})
	Debugw(msg string, keysAndValues ...interface{})
	Warn(args ...interface{})
	Warnf(msg string, args ...interface{})
	Warnw(msg string, keysAndValues ...interface{})
	Error(args ...interface{})
	Errorf(msg string, args ...interface{})
	Errorw(msg string, keysAndValues ...interface{})
	DPanic(args ...interface{})
	DPanicf(msg string, args ...interface{})
	Fatal(args ...interface{})
	Fatalf(msg string, args ...interface{})
}

type Span

type Span interface {
	End(enableStackTrace ...bool)
	SetAttributes(attrs map[string]interface{})
	SetAttribute(key, value string)
	AddEvent(name string, attrs ...map[string]interface{})
	SetName(name string)
	SetStatus(code uint32, description string)
	RecordError(err error, attrs ...map[string]interface{})
}

type StateMachine

type StateMachine interface {
	ApplyEvent(event entity.EventFSM) error
	GetCurrentState() entity.StateFSM
}

type Tracer

type Tracer interface {
	// Configure initializes the tracer with the necessary settings.
	Configure() error

	// Span creates and starts a new span with the given name and attributes.
	Span(ctx context.Context, name string) (context.Context, Span)

	// Shutdown gracefully shuts down the tracer provider and flushes spans.
	Shutdown(ctx context.Context) error
}

Tracer defines the methods required for tracing operations.