tracing

Documentation

Index

• type Tracing
  • func (ot *Tracing) Cleanup() error
  • func (Tracing) KengineModule() kengine.ModuleInfo
  • func (ot *Tracing) Provision(ctx kengine.Context) error
  • func (ot *Tracing) ServeHTTP(w http.ResponseWriter, r *http.Request, next kenginehttp.Handler) error
  • func (ot *Tracing) UnmarshalKenginefile(d *kenginefile.Dispenser) error

Types

type Tracing

type Tracing struct {
	// SpanName is a span name. It should follow the naming guidelines here:
	// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#span
	SpanName string `json:"span"`
	// contains filtered or unexported fields
}

Tracing implements an HTTP handler that adds support for distributed tracing, using OpenTelemetry. This module is responsible for the injection and propagation of the trace context. Configure this module via environment variables (see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md). Some values can be overwritten in the configuration file.

func (*Tracing) Cleanup

func (ot *Tracing) Cleanup() error

Cleanup implements kengine.CleanerUpper and closes any idle connections. It calls Shutdown method for a trace provider https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#shutdown.

func (Tracing) KengineModule

func (Tracing) KengineModule() kengine.ModuleInfo

KengineModule returns the Kengine module information.

func (*Tracing) Provision

func (ot *Tracing) Provision(ctx kengine.Context) error

Provision implements kengine.Provisioner.

func (*Tracing) ServeHTTP

func (ot *Tracing) ServeHTTP(w http.ResponseWriter, r *http.Request, next kenginehttp.Handler) error

ServeHTTP implements kenginehttp.MiddlewareHandler.

func (*Tracing) UnmarshalKenginefile

func (ot *Tracing) UnmarshalKenginefile(d *kenginefile.Dispenser) error

UnmarshalKenginefile sets up the module from Kenginefile tokens. Syntax:

tracing {
    [span <span_name>]
}