httpd

package
v1.9.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 3, 2023 License: MIT Imports: 59 Imported by: 17

Documentation

Overview

Package httpd implements the HTTP service and REST API for InfluxDB.

Index

Constants

View Source 
const (
	// DefaultBindAddress is the default address to bind to.
	DefaultBindAddress = ":8086"

	// DefaultRealm is the default realm sent back when issuing a basic auth challenge.
	DefaultRealm = "InfluxDB"

	// DefaultBindSocket is the default unix socket to bind to.
	DefaultBindSocket = "/var/run/influxdb.sock"

	// DefaultMaxBodySize is the default maximum size of a client request body, in bytes. Specify 0 for no limit.
	DefaultMaxBodySize = 25e6

	// DefaultEnqueuedWriteTimeout is the maximum time a write request can wait to be processed.
	DefaultEnqueuedWriteTimeout = 30 * time.Second
)
View Source 
const (
	// DefaultChunkSize specifies the maximum number of points that will
	// be read before sending results back to the engine.
	//
	// This has no relation to the number of bytes that are returned.
	DefaultChunkSize = 10000

	DefaultDebugRequestsInterval = 10 * time.Second

	MaxDebugRequestsInterval = 6 * time.Hour
)

Variables

This section is empty.

Functions

func LimitListener added in v1.0.0 

func LimitListener(l net.Listener, n int) net.Listener

LimitListener returns a Listener that accepts at most n simultaneous connections from the provided Listener and will drop extra connections.

Types

type AuthenticationMethod added in v1.0.0 

type AuthenticationMethod int

AuthenticationMethod defines the type of authentication used. 

const (
	// Authenticate using basic authentication.
	UserAuthentication AuthenticationMethod = iota

	// Authenticate with jwt.
	BearerAuthentication
)

Supported authentication methods.

type Config 

type Config struct {
	Enabled                 bool              `toml:"enabled"`
	BindAddress             string            `toml:"bind-address"`
	AuthEnabled             bool              `toml:"auth-enabled"`
	LogEnabled              bool              `toml:"log-enabled"`
	SuppressWriteLog        bool              `toml:"suppress-write-log"`
	WriteTracing            bool              `toml:"write-tracing"`
	FluxEnabled             bool              `toml:"flux-enabled"`
	FluxLogEnabled          bool              `toml:"flux-log-enabled"`
	PprofEnabled            bool              `toml:"pprof-enabled"`
	PprofAuthEnabled        bool              `toml:"pprof-auth-enabled"`
	DebugPprofEnabled       bool              `toml:"debug-pprof-enabled"`
	PingAuthEnabled         bool              `toml:"ping-auth-enabled"`
	PromReadAuthEnabled     bool              `toml:"prom-read-auth-enabled"`
	HTTPHeaders             map[string]string `toml:"headers"`
	HTTPSEnabled            bool              `toml:"https-enabled"`
	HTTPSCertificate        string            `toml:"https-certificate"`
	HTTPSPrivateKey         string            `toml:"https-private-key"`
	MaxRowLimit             int               `toml:"max-row-limit"`
	MaxConnectionLimit      int               `toml:"max-connection-limit"`
	SharedSecret            string            `toml:"shared-secret"`
	Realm                   string            `toml:"realm"`
	UnixSocketEnabled       bool              `toml:"unix-socket-enabled"`
	UnixSocketGroup         *toml.Group       `toml:"unix-socket-group"`
	UnixSocketPermissions   toml.FileMode     `toml:"unix-socket-permissions"`
	BindSocket              string            `toml:"bind-socket"`
	MaxBodySize             int               `toml:"max-body-size"`
	AccessLogPath           string            `toml:"access-log-path"`
	AccessLogStatusFilters  []StatusFilter    `toml:"access-log-status-filters"`
	MaxConcurrentWriteLimit int               `toml:"max-concurrent-write-limit"`
	MaxEnqueuedWriteLimit   int               `toml:"max-enqueued-write-limit"`
	EnqueuedWriteTimeout    time.Duration     `toml:"enqueued-write-timeout"`
	TLS                     *tls.Config       `toml:"-"`
}

Config represents a configuration for a HTTP service.

func NewConfig 

func NewConfig() Config

NewConfig returns a new Config with default settings.

func (Config) Diagnostics added in v1.3.0 

func (c Config) Diagnostics() (*diagnostics.Diagnostics, error)

Diagnostics returns a diagnostics representation of a subset of the Config.

type Controller added in v1.7.0 

type Controller interface {
	Query(ctx context.Context, compiler flux.Compiler) (flux.Query, error)
	PrometheusCollectors() []prometheus.Collector
}

type Handler 

type Handler struct {
	Version   string
	BuildType string

	MetaClient interface {
		Database(name string) *meta.DatabaseInfo
		Databases() []meta.DatabaseInfo
		Authenticate(username, password string) (ui meta.User, err error)
		User(username string) (meta.User, error)
		AdminUserExists() bool
	}

	QueryAuthorizer QueryAuthorizer

	WriteAuthorizer interface {
		AuthorizeWrite(username, database string) error
	}

	QueryExecutor *query.Executor

	Monitor interface {
		Statistics(tags map[string]string) ([]*monitor.Statistic, error)
		Diagnostics() (map[string]*diagnostics.Diagnostics, error)
	}

	PointsWriter interface {
		WritePoints(database, retentionPolicy string, consistencyLevel models.ConsistencyLevel, user meta.User, points []models.Point) error
	}

	Store Store

	// Flux services
	Controller       Controller
	CompilerMappings flux.CompilerMappings

	Config    *Config
	Logger    *zap.Logger
	CLFLogger *log.Logger
	// contains filtered or unexported fields
}

Handler represents an HTTP handler for the InfluxDB server.

func NewHandler 

func NewHandler(c Config) *Handler

NewHandler returns a new instance of handler with routes.

func (*Handler) AddRoutes added in v0.12.0 

func (h *Handler) AddRoutes(routes ...Route)

AddRoutes sets the provided routes on the handler.

func (*Handler) Close added in v1.5.0 

func (h *Handler) Close()

func (*Handler) Open added in v1.5.0 

func (h *Handler) Open()

func (*Handler) ServeHTTP 

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP responds to HTTP request to the handler.

func (*Handler) SetHeadersHandler added in v1.8.1 

func (h *Handler) SetHeadersHandler(handler http.Handler) http.Handler

func (*Handler) SetHeadersWrapper added in v1.8.1 

func (h *Handler) SetHeadersWrapper(f func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)

wrapper that adds user supplied headers to the response.

func (*Handler) Statistics added in v1.0.0 

func (h *Handler) Statistics(tags map[string]string) []models.Statistic

Statistics returns statistics for periodic monitoring.

type QueryAuthorizer added in v1.8.5 

type QueryAuthorizer interface {
	AuthorizeQuery(u meta.User, query *influxql.Query, database string) (query.FineAuthorizer, error)
	AuthorizeDatabase(u meta.User, priv influxql.Privilege, database string) error
}

type RequestInfo added in v1.3.0 

type RequestInfo struct {
	IPAddr   string
	Username string
}

func (*RequestInfo) String added in v1.3.0 

func (r *RequestInfo) String() string

type RequestProfile added in v1.3.0 

type RequestProfile struct {
	Requests map[RequestInfo]*RequestStats
	// contains filtered or unexported fields
}

func (*RequestProfile) AddQuery added in v1.3.0 

func (p *RequestProfile) AddQuery(info RequestInfo)

func (*RequestProfile) AddWrite added in v1.3.0 

func (p *RequestProfile) AddWrite(info RequestInfo)

func (*RequestProfile) Stop added in v1.3.0 

func (p *RequestProfile) Stop()

Stop informs the RequestTracker to stop collecting statistics for this profile.

type RequestStats added in v1.3.0 

type RequestStats struct {
	Writes  int64 `json:"writes"`
	Queries int64 `json:"queries"`
}

type RequestTracker added in v1.3.0 

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

func NewRequestTracker added in v1.3.0 

func NewRequestTracker() *RequestTracker

func (*RequestTracker) Add added in v1.3.0 

func (rt *RequestTracker) Add(req *http.Request, user meta.User)

func (*RequestTracker) TrackRequests added in v1.3.0 

func (rt *RequestTracker) TrackRequests() *RequestProfile

type Response 

type Response struct {
	Results []*query.Result
	Err     error
}

Response represents a list of statement results.

func (*Response) Error 

func (r *Response) Error() error

Error returns the first error from any statement. Returns nil if no errors occurred on any statements.

func (Response) MarshalJSON 

func (r Response) MarshalJSON() ([]byte, error)

MarshalJSON encodes a Response struct into JSON.

func (*Response) UnmarshalJSON 

func (r *Response) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the data into the Response struct.

type ResponseWriter added in v1.0.0 

type ResponseWriter interface {
	// WriteResponse writes a response.
	WriteResponse(resp Response) (int, error)

	http.ResponseWriter
}

ResponseWriter is an interface for writing a response.

func NewResponseWriter added in v1.0.0 

func NewResponseWriter(w http.ResponseWriter, r *http.Request) ResponseWriter

NewResponseWriter creates a new ResponseWriter based on the Accept header in the request that wraps the ResponseWriter.

type Route added in v0.12.0 

type Route struct {
	Name           string
	Method         string
	Pattern        string
	Gzipped        bool
	LoggingEnabled bool
	HandlerFunc    interface{}
}

Route specifies how to handle a HTTP verb for a given endpoint.

type Service 

type Service struct {
	Handler *Handler

	Logger *zap.Logger
	// contains filtered or unexported fields
}

Service manages the listener and handler for an HTTP endpoint.

func NewService 

func NewService(c Config) *Service

NewService returns a new instance of Service.

func (*Service) Addr 

func (s *Service) Addr() net.Addr

Addr returns the listener's address. Returns nil if listener is closed.

func (*Service) BoundHTTPAddr added in v1.4.0 

func (s *Service) BoundHTTPAddr() string

BoundHTTPAddr returns the string version of the address that the HTTP server is listening on. This is useful if you start an ephemeral server in test with bind address localhost:0.

func (*Service) Close 

func (s *Service) Close() error

Close closes the underlying listener.

func (*Service) Err 

func (s *Service) Err() <-chan error

Err returns a channel for fatal errors that occur on the listener.

func (*Service) Open 

func (s *Service) Open() error

Open starts the service.

func (*Service) Statistics added in v1.0.0 

func (s *Service) Statistics(tags map[string]string) []models.Statistic

Statistics returns statistics for periodic monitoring.

func (*Service) WithLogger added in v1.2.0 

func (s *Service) WithLogger(log *zap.Logger)

WithLogger sets the logger for the service.

type Statistics added in v1.0.0 

type Statistics struct {
	Requests                     int64
	CQRequests                   int64
	QueryRequests                int64
	WriteRequests                int64
	PingRequests                 int64
	StatusRequests               int64
	WriteRequestBytesReceived    int64
	QueryRequestBytesTransmitted int64
	PointsWrittenOK              int64
	PointsWrittenDropped         int64
	PointsWrittenFail            int64
	AuthenticationFailures       int64
	RequestDuration              int64
	QueryRequestDuration         int64
	WriteRequestDuration         int64
	ActiveRequests               int64
	ActiveWriteRequests          int64
	ClientErrors                 int64
	ServerErrors                 int64
	RecoveredPanics              int64
	PromWriteRequests            int64
	PromReadRequests             int64
	FluxQueryRequests            int64
	FluxQueryRequestDuration     int64
}

Statistics maintains statistics for the httpd service.

type StatusFilter added in v1.7.0 

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

StatusFilter will check if an http status code matches a certain pattern.

func ParseStatusFilter added in v1.7.0 

func ParseStatusFilter(s string) (StatusFilter, error)

ParseStatusFilter will create a new status filter from the string.

func (StatusFilter) MarshalText added in v1.7.0 

func (sf StatusFilter) MarshalText() (text []byte, err error)

MarshalText converts a duration to a string for decoding toml

func (StatusFilter) Match added in v1.7.0 

func (sf StatusFilter) Match(statusCode int) bool

Match will check if the status code matches this filter.

func (*StatusFilter) UnmarshalText added in v1.7.0 

func (sf *StatusFilter) UnmarshalText(text []byte) error

UnmarshalText parses a TOML value into a duration value.

type StatusFilters added in v1.7.0 

type StatusFilters []StatusFilter

func (StatusFilters) Match added in v1.7.0 

func (filters StatusFilters) Match(statusCode int) bool

type Store added in v1.6.0 

type Store interface {
	ReadFilter(ctx context.Context, req *datatypes.ReadFilterRequest) (reads.ResultSet, error)
}

Store describes the behaviour of the storage packages Store type.

type Throttler added in v1.6.0 

type Throttler struct {

	// Maximum amount of time requests can wait in queue.
	// Must be set before adding middleware.
	EnqueueTimeout time.Duration

	Logger *zap.Logger
	// contains filtered or unexported fields
}

Throttler represents an HTTP throttler that limits the number of concurrent requests being processed as well as the number of enqueued requests.

func NewThrottler added in v1.6.0 

func NewThrottler(concurrentN, maxEnqueueN int) *Throttler

NewThrottler returns a new instance of Throttler that limits to concurrentN. requests processed at a time and maxEnqueueN requests waiting to be processed.

func (*Throttler) Handler added in v1.6.0 

func (t *Throttler) Handler(h http.Handler) http.Handler

Handler wraps h in a middleware handler that throttles requests.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.