querytracer

Documentation

Index

• type Tracer
  • func New(enabled bool, format string, args ...any) *Tracer
  • func (t *Tracer) AddJSON(jsonTrace []byte) error
  • func (t *Tracer) Done()
  • func (t *Tracer) Donef(format string, args ...any)
  • func (t *Tracer) Enabled() bool
  • func (t *Tracer) NewChild(format string, args ...any) *Tracer
  • func (t *Tracer) Printf(format string, args ...any)
  • func (t *Tracer) String() string
  • func (t *Tracer) ToJSON() string

Types

type Tracer

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

Tracer represents query tracer.

It must be created via New call. Each created tracer must be finalized via Done or Donef call.

Tracer may contain sub-tracers (branches) in order to build tree-like execution order. Call Tracer.NewChild func for adding sub-tracer.

func New

func New(enabled bool, format string, args ...any) *Tracer

New creates a new instance of the tracer with the given fmt.Sprintf(format, args...) message.

If enabled isn't set, then all function calls to the returned object will be no-op.

Done or Donef must be called when the tracer should be finished.

func (*Tracer) AddJSON

func (t *Tracer) AddJSON(jsonTrace []byte) error

AddJSON adds a sub-trace to t.

The jsonTrace must be encoded with ToJSON.

AddJSON cannot be called from concurrent goroutines.

func (*Tracer) Done

func (t *Tracer) Done()

Done finishes t.

Done cannot be called multiple times. Other Tracer functions cannot be called after Done call.

func (*Tracer) Donef

func (t *Tracer) Donef(format string, args ...any)

Donef appends the given fmt.Sprintf(format, args..) message to t and finished it.

Donef cannot be called multiple times. Other Tracer functions cannot be called after Donef call.

func (*Tracer) Enabled

func (t *Tracer) Enabled() bool

Enabled returns true if the t is enabled.

func (*Tracer) NewChild

func (t *Tracer) NewChild(format string, args ...any) *Tracer

NewChild adds a new child Tracer to t with the given fmt.Sprintf(format, args...) message.

The returned child must be closed via Done or Donef calls.

NewChild cannot be called from concurrent goroutines. Create children tracers from a single goroutine and then pass them to concurrent goroutines.

func (*Tracer) Printf

func (t *Tracer) Printf(format string, args ...any)

Printf adds new fmt.Sprintf(format, args...) message to t.

Printf cannot be called from concurrent goroutines.

func (*Tracer) String

func (t *Tracer) String() string

String returns string representation of t.

String must be called when t methods aren't called by other goroutines.

It is safe calling String() when child tracers aren't finished yet. In this case they will contain the corresponding message.

func (*Tracer) ToJSON

func (t *Tracer) ToJSON() string

ToJSON returns JSON representation of t.

ToJSON must be called when t methods aren't called by other goroutines.

It is safe calling ToJSON() when child tracers aren't finished yet. In this case they will contain the corresponding message.