bunotel

README

OpenTelemetry instrumentation for Bun

See example for details.

Documentation

Index

• type Option
  • func WithAttributes(attrs ...attribute.KeyValue) Option
  • func WithDBName(name string) Option
  • func WithFormattedQueries(format bool) Option
  • func WithMeterProvider(mp metric.MeterProvider) Option
  • func WithSpanNameQueryGen(f func(*bun.QueryEvent) string) Option
  • func WithTracerProvider(tp trace.TracerProvider) Option
• type QueryHook
  • func NewQueryHook(opts ...Option) *QueryHook
  • func (h *QueryHook) AfterQuery(ctx context.Context, event *bun.QueryEvent)
  • func (h *QueryHook) BeforeQuery(ctx context.Context, event *bun.QueryEvent) context.Context
  • func (h *QueryHook) Init(db *bun.DB)

Types

type Option

type Option func(h *QueryHook)

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 WithFormattedQueries

func WithFormattedQueries(format bool) Option

WithFormattedQueries enables formatting of the query that is added as the statement attribute to the trace. This means that all placeholders and arguments will be filled first and the query will contain all information as sent to the database.

func WithMeterProvider

func WithMeterProvider(mp metric.MeterProvider) Option

WithMeterProvider returns an Option to use the MeterProvider when creating a Meter.

func WithSpanNameQueryGen

func WithSpanNameQueryGen(f func(*bun.QueryEvent) string) Option

WithSpanNameQueryGen takes a function that determines the span name for a given query event.

func WithTracerProvider

func WithTracerProvider(tp trace.TracerProvider) Option

WithTracerProvider returns an Option to use the TracerProvider when creating a Tracer.

type QueryHook

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

QueryHook is a bun.QueryHook that reports query timing via OpenTelemetry.

func NewQueryHook

func NewQueryHook(opts ...Option) *QueryHook

NewQueryHook creates a new QueryHook with the given options.

func (*QueryHook) AfterQuery

func (h *QueryHook) AfterQuery(ctx context.Context, event *bun.QueryEvent)

func (*QueryHook) BeforeQuery

func (h *QueryHook) BeforeQuery(ctx context.Context, event *bun.QueryEvent) context.Context

func (*QueryHook) Init

func (h *QueryHook) Init(db *bun.DB)