clientcfghttp

Documentation

Index

• type ConfigManager
  • func (c *ConfigManager) GetBaggageRestrictions(ctx context.Context, serviceName string) ([]*baggage.BaggageRestriction, error)
  • func (c *ConfigManager) GetSamplingStrategy(ctx context.Context, serviceName string) (*api_v2.SamplingStrategyResponse, error)
• type HTTPHandler
  • func NewHTTPHandler(params HTTPHandlerParams) *HTTPHandler
  • func (h *HTTPHandler) RegisterRoutes(router *mux.Router)
  • func (h *HTTPHandler) RegisterRoutesWithHTTP(router *http.ServeMux)
• type HTTPHandlerParams

Types

type ConfigManager

type ConfigManager struct {
	SamplingProvider samplingstrategy.Provider
	BaggageManager   baggage.BaggageRestrictionManager
}

ConfigManager implements ClientConfigManager.

func (*ConfigManager) GetBaggageRestrictions

func (c *ConfigManager) GetBaggageRestrictions(ctx context.Context, serviceName string) ([]*baggage.BaggageRestriction, error)

GetBaggageRestrictions implements ClientConfigManager.GetBaggageRestrictions.

func (*ConfigManager) GetSamplingStrategy

func (c *ConfigManager) GetSamplingStrategy(ctx context.Context, serviceName string) (*api_v2.SamplingStrategyResponse, error)

GetSamplingStrategy implements ClientConfigManager.GetSamplingStrategy.

type HTTPHandler

type HTTPHandler struct {
	// contains filtered or unexported fields
}

HTTPHandler implements endpoints for used by Jaeger clients to retrieve client configuration, such as sampling and baggage restrictions.

func NewHTTPHandler

func NewHTTPHandler(params HTTPHandlerParams) *HTTPHandler

NewHTTPHandler creates new HTTPHandler.

func (*HTTPHandler) RegisterRoutes

func (h *HTTPHandler) RegisterRoutes(router *mux.Router)

RegisterRoutes registers configuration handlers with Gorilla Router.

func (*HTTPHandler) RegisterRoutesWithHTTP

func (h *HTTPHandler) RegisterRoutesWithHTTP(router *http.ServeMux)

RegisterRoutes registers configuration handlers with HTTP Router.

type HTTPHandlerParams

type HTTPHandlerParams struct {
	ConfigManager  configmanager.ClientConfigManager // required
	MetricsFactory metrics.Factory                   // required

	// BasePath will be used as a prefix for the endpoints, e.g. "/api"
	BasePath string

	// LegacySamplingEndpoint enables returning sampling strategy from "/" endpoint
	// using Thrift 0.9.2 enum codes.
	LegacySamplingEndpoint bool
}

HTTPHandlerParams contains parameters that must be passed to NewHTTPHandler.