trc

Documentation

Overview

Package trc is used for working with tracing spans. It contains the options to use in Connector.StartSpan

Index

• type Option
  • func Bool(k string, v bool) Option
  • func Client() Option
  • func ClientIP(ip string) Option
  • func Consumer() Option
  • func Float(k string, v float64) Option
  • func Int(k string, v int) Option
  • func Internal() Option
  • func Producer() Option
  • func Request(r *http.Request) Option
  • func Server() Option
  • func String(k string, v string) Option
  • func Strings(k string, v []string) Option
• type Span
  • func NewSpan(ts trace.Span) Span
• type SpanImpl
  • func (s SpanImpl) End()
  • func (s SpanImpl) IsEmpty() bool
  • func (s SpanImpl) Log(severity string, msg string, args ...any)
  • func (s SpanImpl) SetBool(k string, v bool)
  • func (s SpanImpl) SetClientIP(ip string)
  • func (s SpanImpl) SetError(err error)
  • func (s SpanImpl) SetFloat(k string, v float64)
  • func (s SpanImpl) SetInt(k string, v int)
  • func (s SpanImpl) SetOK(statusCode int)
  • func (s SpanImpl) SetRequest(r *http.Request)
  • func (s SpanImpl) SetString(k string, v string)
  • func (s SpanImpl) SetStrings(k string, v []string)
  • func (s SpanImpl) TraceID() string

Types

type Option

type Option trace.SpanStartOption

Option is an alias for trace.SpanStartOption which are options used to create tracing spans.

func Bool

func Bool(k string, v bool) Option

Bool tags the span during its creation.

func Client

func Client() Option

Client indicates that the span represents the operation of client making a request to a server.

func ClientIP

func ClientIP(ip string) Option

ClientIP tags the span during its creation with the IP address and port number of the client.

func Consumer

func Consumer() Option

Consumer represents the operation of a consumer receiving a message from a message broker.

func Float

func Float(k string, v float64) Option

Float tags the span during its creation.

func Int

func Int(k string, v int) Option

Int tags the span during its creation.

func Internal

func Internal() Option

Internal indicates that the span represents an internal operation within an application.

func Producer

func Producer() Option

Producer represents the operation of a producer sending a message to a message broker.

func Request

func Request(r *http.Request) Option

Request tags the span during its creation with the request data.

func Server

func Server() Option

Server indicates that the span represents the operation of handling a request from a client.

func String

func String(k string, v string) Option

String tags the span during its creation.

func Strings

func Strings(k string, v []string) Option

Strings tags the span during its creation.

type Span

type Span interface {
	// End completes the span.
	// Updates to the span are not allowed after this method has been called.
	End()
	// SetError sets the status of the span to error.
	SetError(err error)
	// SetOK sets the status of the span to OK, with the indicated response status code.
	SetOK(statusCode int)
	// Log records a log event on the span.
	Log(severity string, message string, args ...any)
	// SetString tags the span during its creation.
	SetString(k string, v string)
	// SetStrings tags the span during its creation.
	SetStrings(k string, v []string)
	// SetBool tags the span during its creation.
	SetBool(k string, v bool)
	// SetInt tags the span during its creation.
	SetInt(k string, v int)
	// SetFloat tags the span during its creation.
	SetFloat(k string, v float64)
	// SetRequest tags the span with the request data.
	// Warning: this has a large memory footprint.
	SetRequest(r *http.Request)
	// SetClientIP tags the span during its creation with the IP address and port number of the client.
	SetClientIP(ip string)
	// IsEmpty indicates if the span is not initialized.
	IsEmpty() bool
	// TraceID is an identifier that groups related spans together.
	TraceID() string
}

Span represents an operation that is being traced.

func NewSpan

func NewSpan(ts trace.Span) Span

NewSpan creates a new span.

type SpanImpl

type SpanImpl struct {
	trace.Span
}

SpanImpl implements the span interface.

func (SpanImpl) End

func (s SpanImpl) End()

End completes the span. Updates to the span are not allowed after this method has been called.

func (SpanImpl) IsEmpty

func (s SpanImpl) IsEmpty() bool

IsEmpty indicates if the span is not initialized.

func (SpanImpl) Log

func (s SpanImpl) Log(severity string, msg string, args ...any)

Log records a log event on the span.

func (SpanImpl) SetBool

func (s SpanImpl) SetBool(k string, v bool)

SetBool tags the span during its creation.

func (SpanImpl) SetClientIP

func (s SpanImpl) SetClientIP(ip string)

SetClientIP tags the span during its creation with the IP address and port number of the client.

func (SpanImpl) SetError

func (s SpanImpl) SetError(err error)

SetError sets the status of the span to error.

func (SpanImpl) SetFloat

func (s SpanImpl) SetFloat(k string, v float64)

SetFloat tags the span during its creation.

func (SpanImpl) SetInt

func (s SpanImpl) SetInt(k string, v int)

SetInt tags the span during its creation.

func (SpanImpl) SetOK

func (s SpanImpl) SetOK(statusCode int)

SetOK sets the status of the span to OK, with the indicated response status code.

func (SpanImpl) SetRequest

func (s SpanImpl) SetRequest(r *http.Request)

SetRequest tags the span with the request data. Warning: this has a large memory footprint.

func (SpanImpl) SetString

func (s SpanImpl) SetString(k string, v string)

SetString tags the span during its creation.

func (SpanImpl) SetStrings

func (s SpanImpl) SetStrings(k string, v []string)

SetStrings tags the span during its creation.

func (SpanImpl) TraceID

func (s SpanImpl) TraceID() string

TraceID is an identifier that groups related spans together.