http

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func NewClient(opts ...ClientOption) *http.Client
• func NewRoundTripper(opts ...ClientOption) http.RoundTripper
• func NewServeMux() *runtime.ServeMux
• func RegisterMetrics(mux *runtime.ServeMux) error
• func Transport() *http.Transport
• func UserAgent(cfg *Config) string
• type ClientOption
  • func WithClientBreaker() ClientOption
  • func WithClientLogger(logger *zap.Logger) ClientOption
  • func WithClientMetrics(meter metric.Meter) ClientOption
  • func WithClientRetry(cfg *r.Config) ClientOption
  • func WithClientRoundTripper(rt http.RoundTripper) ClientOption
  • func WithClientSecure(sec *security.Config) (ClientOption, error)
  • func WithClientTracer(tracer trace.Tracer) ClientOption
  • func WithClientUserAgent(userAgent string) ClientOption
• type Config
• type Server
  • func NewServer(params ServerParams) (*Server, error)
• type ServerParams

Variables

var Module = fx.Options(
	fx.Provide(NewServeMux),
	fx.Provide(NewServer),
	fx.Invoke(RegisterMetrics),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for HTTP.

func NewClient

func NewClient(opts ...ClientOption) *http.Client

NewClient for HTTP.

func NewRoundTripper

func NewRoundTripper(opts ...ClientOption) http.RoundTripper

NewRoundTripper for HTTP.

func NewServeMux

func NewServeMux() *runtime.ServeMux

NewServeMux for HTTP.

func RegisterMetrics

func RegisterMetrics(mux *runtime.ServeMux) error

RegisterMetrics for HTTP.

func Transport

func Transport() *http.Transport

Transport for HTTP.

func UserAgent

func UserAgent(cfg *Config) string

UserAgent for HTTP.

Types

type ClientOption

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption for HTTP.

func WithClientBreaker

func WithClientBreaker() ClientOption

WithClientBreaker for HTTP.

func WithClientLogger

func WithClientLogger(logger *zap.Logger) ClientOption

WithClientLogger for HTTP.

func WithClientMetrics

func WithClientMetrics(meter metric.Meter) ClientOption

WithClientMetrics for HTTP.

func WithClientRetry

func WithClientRetry(cfg *r.Config) ClientOption

WithClientRetry for HTTP.

func WithClientRoundTripper

func WithClientRoundTripper(rt http.RoundTripper) ClientOption

WithClientRoundTripper for HTTP.

func WithClientSecure

func WithClientSecure(sec *security.Config) (ClientOption, error)

WithClientSecure for HTTP.

func WithClientTracer

func WithClientTracer(tracer trace.Tracer) ClientOption

WithClientTracer for HTTP.

func WithClientUserAgent

func WithClientUserAgent(userAgent string) ClientOption

WithUserAgent for HTTP.

type Config

type Config struct {
	*server.Config `yaml:",inline" json:",inline" toml:",inline"`
}

Config for HTTP.

type Server

type Server struct {
	*server.Server
}

Server for HTTP.

func NewServer

func NewServer(params ServerParams) (*Server, error)

NewServer for HTTP.

type ServerParams

type ServerParams struct {
	fx.In

	Shutdowner fx.Shutdowner
	Mux        *runtime.ServeMux
	Config     *Config
	Logger     *zap.Logger
	Tracer     trace.Tracer
	Meter      metric.Meter
	Limiter    *v3.Limiter
	Key        limiter.KeyFunc
	Handlers   []negroni.Handler `optional:"true"`
}

ServerParams for HTTP.