tracing

Documentation

Overview

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Package tracing enables dependency-injection at runtime. When used together with an underscore-import of `github.com/open-policy-agent/opa/features/tracing`, the server and its runtime will emit OpenTelemetry spans to the configured sink.

Index

• func NewHandler(f http.Handler, label string, opts Options) http.Handler
• func NewTransport(tr http.RoundTripper, opts Options) http.RoundTripper
• func RegisterHTTPTracing(ht HTTPTracingService)
• type HTTPTracingService
• type Options
  • func NewOptions(opts ...interface{}) Options

Functions

func NewHandler

func NewHandler(f http.Handler, label string, opts Options) http.Handler

NewHandler returns another http.Handler, instrumented to emit tracing spans according to Options. Provided by the HTTPTracingService registered with this package via RegisterHTTPTracing.

func NewTransport

func NewTransport(tr http.RoundTripper, opts Options) http.RoundTripper

NewTransport returns another http.RoundTripper, instrumented to emit tracing spans according to Options. Provided by the HTTPTracingService registered with this package via RegisterHTTPTracing.

func RegisterHTTPTracing

func RegisterHTTPTracing(ht HTTPTracingService)

RegisterHTTPTracing enables a HTTPTracingService for further use.

Types

type HTTPTracingService

type HTTPTracingService = v1.HTTPTracingService

HTTPTracingService defines how distributed tracing comes in, server- and client-side

type Options

type Options = v1.Options

Options are options for the HTTPTracingService, passed along as-is.

func NewOptions

func NewOptions(opts ...interface{}) Options

NewOptions is a helper method for constructing `tracing.Options`