trace

Documentation

Overview

Package trace implements a OpenTelemetry middleware for labstack/echo.

Index

• Variables
• func Record(ctx context.Context, err error, keyVals ...string)
• func RecordAndLog(ctx context.Context, err error, keyVals ...string)
• func WithConfig(config Config) echo.MiddlewareFunc
• type Config
• type ResponseRecorder
  • func NewResponseRecorder(resp *echo.Response) *ResponseRecorder
  • func (d *ResponseRecorder) GetResponse() string
  • func (d *ResponseRecorder) Write(b []byte) (int, error)

Variables

var DefaultConfig = Config{
	Skipper:       middleware.DefaultSkipper,
	ComponentName: defaultComponentName,
	DumpBodies:    false,
	LimitBodySize: defaultBodyLimit,
}

Functions

func Record

func Record(ctx context.Context, err error, keyVals ...string)

Record adds an error to the current span and appends keyVal as attributes.

func RecordAndLog

func RecordAndLog(ctx context.Context, err error, keyVals ...string)

func WithConfig

func WithConfig(config Config) echo.MiddlewareFunc

trunk-ignore(golangci-lint/cyclop)

Types

type Config

type Config struct {
	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper

	// Tracer is the default tracer that should be used.
	// If empty, a new tracer is retrieved using otel.Tracer("")
	Tracer trace.Tracer

	// ComponentName used for describing the tracing component.
	ComponentName string

	// DumpBodies should be set to true if the request and response
	// bodies should be dumped to spans.
	DumpBodies bool

	// LimitBodySize holds the maximum number of bytes that are appended to
	// a span.
	LimitBodySize int
}

type ResponseRecorder

type ResponseRecorder struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

ResponseRecorder can record a labstack/echo response body.

func NewResponseRecorder

func NewResponseRecorder(resp *echo.Response) *ResponseRecorder

New ResponseRecorder returns a new response recorder that stores the body written to resp.

func (*ResponseRecorder) GetResponse

func (d *ResponseRecorder) GetResponse() string

GetResponse returns the response recorded in d.

func (*ResponseRecorder) Write

func (d *ResponseRecorder) Write(b []byte) (int, error)

Write proxies calls to the actual *echo.Response and a buffer.