otelx

func AddConfigSchema ¶

func AddConfigSchema(c interface {
	AddResource(url string, r io.Reader) error
}) error

AddConfigSchema adds the tracing schema to the compiler. The interface is specified instead of `jsonschema.Compiler` to allow the use of any jsonschema library fork or version.

func End ¶ added in v0.0.524

func End(span trace.Span, err *error)

End finishes span, and automatically sets the error state if *err is not nil or during panicking.

Usage:

func Divide(ctx context.Context, numerator, denominator int) (ratio int, err error) {
	ctx, span := tracer.Start(ctx, "my-operation")
	defer otelx.End(span, &err)
	if denominator == 0 {
		return 0, errors.New("cannot divide by zero")
	}
	return numerator / denominator, nil
}

func NewHandler ¶

func NewHandler(handler http.Handler, operation string, opts ...otelhttp.Option) http.Handler

NewHandler returns a wrapped otelhttp.NewHandler with our request filters.

func SetupJaeger ¶

func SetupJaeger(t *Tracer, tracerName string, c *Config) (trace.Tracer, error)

SetupJaeger configures and returns a Jaeger tracer.

The returned tracer will by default attempt to send spans to a local Jaeger agent. Optionally, otelx.JaegerConfig.LocalAgentAddress can be set to specify a different target.

By default, unless a parent sampler has taken a sampling decision, every span is sampled. otelx.JaegerSampling.TraceIdRatio may be used to customize the sampling probability, optionally alongside otelx.JaegerSampling.ServerURL to consult a remote server for the sampling strategy to be used.

func SetupOTLP ¶ added in v0.0.381

func SetupOTLP(t *Tracer, tracerName string, c *Config) (trace.Tracer, error)

func SetupZipkin ¶ added in v0.0.381

func SetupZipkin(t *Tracer, tracerName string, c *Config) (trace.Tracer, error)

func StringAttrs ¶

func StringAttrs(attrs map[string]string) []attribute.KeyValue

func TraceHandler ¶ added in v0.0.404

func TraceHandler(h http.Handler, opts ...otelhttp.Option) http.Handler

TraceHandler wraps otelx.NewHandler, passing the URL path as the span name.

func WithSpan ¶ added in v0.0.523

func WithSpan(ctx context.Context, name string, f func(context.Context) error, opts ...trace.SpanStartOption) (err error)

WithSpan wraps execution of f in a span identified by name.

If f returns an error or panics, the span status will be set to the error state. The error (or panic) will be propagated unmodified.

f will be wrapped in a child span by default. To make a new root span instead, pass the trace.WithNewRoot() option.