influxdb

Documentation

Overview

Package influxdb provides the InfluxDB Backend provider

Index

• func NewClient(name string, o *bo.Options, router http.Handler, cache cache.Cache, ...) (backends.Backend, error)
• type Client
  • func (c *Client) DefaultHealthCheckConfig() *ho.Options
  • func (c *Client) DefaultPathConfigs(o *bo.Options) map[string]*po.Options
  • func (c *Client) FastForwardRequest(r *http.Request) (*http.Request, error)
  • func (c *Client) ParseTimeRangeQuery(r *http.Request) (*timeseries.TimeRangeQuery, *timeseries.RequestOptions, bool, error)
  • func (c *Client) ProxyHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) QueryHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) RegisterHandlers(map[string]http.Handler)
  • func (c *Client) SetExtent(r *http.Request, trq *timeseries.TimeRangeQuery, extent *timeseries.Extent)
  • func (c *Client) UnmarshalInstantaneous(data []byte) (timeseries.Timeseries, error)

Functions

func NewClient

func NewClient(name string, o *bo.Options, router http.Handler,
	cache cache.Cache, _ backends.Backends, _ types.Lookup) (backends.Backend, error)

NewClient returns a new Client Instance

Types

type Client

type Client struct {
	backends.TimeseriesBackend
}

Client Implements the Proxy Client Interface

func (*Client) DefaultHealthCheckConfig

func (c *Client) DefaultHealthCheckConfig() *ho.Options

DefaultHealthCheckConfig returns the default HealthCheck Config for this backend provider

func (*Client) DefaultPathConfigs

func (c *Client) DefaultPathConfigs(o *bo.Options) map[string]*po.Options

DefaultPathConfigs returns the default PathConfigs for the given Provider

func (*Client) FastForwardRequest

func (c *Client) FastForwardRequest(r *http.Request) (*http.Request, error)

FastForwardRequest is not used for InfluxDB and is here to conform to the Proxy Client interface

func (*Client) ParseTimeRangeQuery

func (c *Client) ParseTimeRangeQuery(r *http.Request) (*timeseries.TimeRangeQuery,
	*timeseries.RequestOptions, bool, error)

ParseTimeRangeQuery parses the key parts of a TimeRangeQuery from the inbound HTTP Request

func (*Client) ProxyHandler

func (c *Client) ProxyHandler(w http.ResponseWriter, r *http.Request)

ProxyHandler sends a request through the basic reverse proxy to the origin, and services non-cacheable InfluxDB API calls

func (*Client) QueryHandler

func (c *Client) QueryHandler(w http.ResponseWriter, r *http.Request)

QueryHandler handles timeseries requests for InfluxDB and processes them through the delta proxy cache

func (*Client) RegisterHandlers

func (c *Client) RegisterHandlers(map[string]http.Handler)

func (*Client) SetExtent

func (c *Client) SetExtent(r *http.Request, trq *timeseries.TimeRangeQuery, extent *timeseries.Extent)

SetExtent will change the upstream request query to use the provided Extent

func (*Client) UnmarshalInstantaneous

func (c *Client) UnmarshalInstantaneous(data []byte) (timeseries.Timeseries, error)

UnmarshalInstantaneous is not used for InfluxDB and is here to conform to the Proxy Client interface