tracing

Documentation

Index

• Constants
• func NewPlugin(opts ...Option) gorm.Plugin
• func WithSkipSpan(ctx context.Context) context.Context
• type CounterSampler
  • func NewCounterSampler(percentage float64) *CounterSampler
  • func (cs *CounterSampler) Description() string
  • func (cs *CounterSampler) ShouldSample(params trace.SamplingParameters) trace.SamplingResult
• type CustomSampler
  • func NewCustomSampler(defaultSampler trace.Sampler, samplers map[string]trace.Sampler) *CustomSampler
  • func (cs *CustomSampler) Description() string
  • func (cs *CustomSampler) ShouldSample(params trace.SamplingParameters) trace.SamplingResult
• type Option
  • func WithAttributes(attrs ...attribute.KeyValue) Option
  • func WithDBName(name string) Option
  • func WithQueryFormatter(queryFormatter func(query string) string) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option
  • func WithoutMetrics() Option
  • func WithoutQueryVariables() Option
• type Tracer
  • func (tracer Tracer) Init() func()
  • func (tracer Tracer) Sample(name string, perc float64) Tracer

Constants

const TracePaused paused = "trace-paused"

Functions

func NewPlugin

func NewPlugin(opts ...Option) gorm.Plugin

func WithSkipSpan

func WithSkipSpan(ctx context.Context) context.Context

Types

type CounterSampler

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

CounterSampler samples spans based on a counter, ensuring a percentage of spans are sampled.

func NewCounterSampler

func NewCounterSampler(percentage float64) *CounterSampler

NewCounterSampler creates a new CounterSampler. `percentage` should be a value between 0 and 100, representing the percentage of spans to sample.

func (*CounterSampler) Description

func (cs *CounterSampler) Description() string

Description returns the description of the sampler.

func (*CounterSampler) ShouldSample

func (cs *CounterSampler) ShouldSample(params trace.SamplingParameters) trace.SamplingResult

ShouldSample decides whether a span should be sampled based on a counter.

type CustomSampler

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

CustomSampler struct holds different samplers.

func NewCustomSampler

func NewCustomSampler(defaultSampler trace.Sampler, samplers map[string]trace.Sampler) *CustomSampler

NewCustomSampler creates a new instance of CustomSampler. `defaultSampler` is used when no specific sampler is found for a span name. `samplers` is a map where keys are span names and values are the specific samplers for those span names.

func (*CustomSampler) Description

func (cs *CustomSampler) Description() string

Description returns a description of the sampler.

func (*CustomSampler) ShouldSample

func (cs *CustomSampler) ShouldSample(params trace.SamplingParameters) trace.SamplingResult

ShouldSample implements the Sampler interface. It delegates the decision to a sampler based on the span name.

type Option

type Option func(p *otelPlugin)

func WithAttributes

func WithAttributes(attrs ...attribute.KeyValue) Option

WithAttributes configures attributes that are used to create a span.

func WithDBName

func WithDBName(name string) Option

WithDBName configures a db.name attribute.

func WithQueryFormatter

func WithQueryFormatter(queryFormatter func(query string) string) Option

WithQueryFormatter configures a query formatter

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider configures a tracer provider that is used to create a tracer.

func WithoutMetrics

func WithoutMetrics() Option

WithoutMetrics prevents DBStats metrics from being reported.

func WithoutQueryVariables

func WithoutQueryVariables() Option

WithoutQueryVariables configures the db.statement attribute to exclude query variables

type Tracer

type Tracer struct {
	ServiceName  string
	CollectorURL string
	Insecure     bool
	Samplers     map[string]trace.Sampler
}

func (Tracer) Init

func (tracer Tracer) Init() func()

func (Tracer) Sample

func (tracer Tracer) Sample(name string, perc float64) Tracer