Documentation
¶
Index ¶
Constants ¶
const DefaultBindAddress = ":8086"
DefaultBindAddress is the default address to bind to.
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 )
Variables ¶
This section is empty.
Functions ¶
func LimitListener ¶ added in v1.0.0
LimitListener returns a Listener that accepts at most n simultaneous connections from the provided Listener and will drop extra connections.
func MarshalJSON ¶
MarshalJSON will marshal v to JSON. Pretty prints if pretty is true.
Types ¶
type AuthenticationMethod ¶ added in v1.0.0
type AuthenticationMethod int
AuthenticationMethod defines the type of authentication used.
const ( UserAuthentication AuthenticationMethod = iota 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"`
WriteTracing bool `toml:"write-tracing"`
PprofEnabled bool `toml:"pprof-enabled"`
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"`
}
Config represents a configuration for a HTTP service.
type Handler ¶
type Handler struct {
Version string
MetaClient interface {
Database(name string) *meta.DatabaseInfo
Authenticate(username, password string) (ui *meta.UserInfo, err error)
Users() []meta.UserInfo
User(username string) (*meta.UserInfo, error)
}
QueryAuthorizer interface {
AuthorizeQuery(u *meta.UserInfo, query *influxql.Query, database string) error
}
WriteAuthorizer interface {
AuthorizeWrite(username, database string) error
}
QueryExecutor *influxql.QueryExecutor
PointsWriter interface {
WritePoints(database, retentionPolicy string, consistencyLevel models.ConsistencyLevel, points []models.Point) error
}
ContinuousQuerier continuous_querier.ContinuousQuerier
Config *Config
Logger *log.Logger
CLFLogger *log.Logger
// contains filtered or unexported fields
}
Handler represents an HTTP handler for the InfluxDB server.
func NewHandler ¶
NewHandler returns a new instance of handler with routes.
type Response ¶
Response represents a list of statement results.
func (*Response) Error ¶
Error returns the first error from any statement. Returns nil if no errors occurred on any statements.
func (Response) MarshalJSON ¶
MarshalJSON encodes a Response struct into JSON.
func (*Response) UnmarshalJSON ¶
UnmarshalJSON decodes the data into the Response struct
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 *log.Logger
// contains filtered or unexported fields
}
Service manages the listener and handler for an HTTP endpoint.
func (*Service) SetLogOutput ¶ added in v0.13.0
SetLogOutput sets the writer to which all logs are written. It must not be called after Open is called.