Documentation

Overview

    Package otelrestful instruments github.com/emicklei/go-restful.

    Instrumentation is provided to trace the emicklei/go-restful/v3 package (https://github.com/emicklei/go-restful).

    Instrumentation of an incoming request is achieved via a go-restful FilterFunc called `OTelFilterFunc` which may be applied at any one of

    * the container level
    * webservice level
    * route level
    

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func OTelFilter

    func OTelFilter(service string, opts ...Option) restful.FilterFunction

      OTelFilter returns a restful.FilterFunction which will trace an incoming request.

      The service parameter should describe the name of the (virtual) server handling the request. Options can be applied to configure the tracer and propagators used for this filter.

      Types

      type Option

      type Option func(*config)

        Option specifies instrumentation configuration options.

        func WithPropagators

        func WithPropagators(propagators propagation.TextMapPropagator) Option

          WithPropagators specifies propagators to use for extracting information from the HTTP requests. If none are specified, global ones will be used.

          func WithTracerProvider

          func WithTracerProvider(provider oteltrace.TracerProvider) Option

            WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.