apiserver

Documentation

Index

• func BillableEventsHandler(store eventio.BillableEventReader, ...) echo.HandlerFunc
• func CacheHeaders(next echo.HandlerFunc) echo.HandlerFunc
• func CurrencyRatesHandler(store eventio.CurrencyRateReader) echo.HandlerFunc
• func DiscovererStatusHandler(discoverer instancediscoverer.CFAppDiscoverer) echo.HandlerFunc
• func EventStoreStatusHandler(store eventio.EventStore) echo.HandlerFunc
• func ForecastEventsHandler(store eventio.BillableEventForecaster) echo.HandlerFunc
• func ListenAndServe(ctx context.Context, logger lager.Logger, e *echo.Echo, addr string) error
• func MetricsDiscoveryHandler(discoverer instancediscoverer.CFAppDiscoverer) echo.HandlerFunc
• func MetricsProxyHandler(proxy metricsproxy.MetricsProxy, discoverer instancediscoverer.CFAppDiscoverer) echo.HandlerFunc
• func New(cfg Config) *echo.Echo
• func NewBaseServer(cfg Config) *echo.Echo
• func NewProxyMetrics(cfg Config, discoverer instancediscoverer.CFAppDiscoverer, ...) *echo.Echo
• func PricingPlansHandler(store eventio.PricingPlanReader) echo.HandlerFunc
• func TotalCostHandler(store eventio.TotalCostReader) echo.HandlerFunc
• func UsageEventsHandler(store eventio.UsageEventReader, uaa auth.Authenticator) echo.HandlerFunc
• func VATRatesHandler(store eventio.VATRateReader) echo.HandlerFunc
• type Config
• type ErrorResponse
• type Logger
  • func NewLogger(logger lager.Logger) *Logger
  • func (l *Logger) Debug(i ...interface{})
  • func (l *Logger) Debugf(format string, i ...interface{})
  • func (l *Logger) Debugj(j log.JSON)
  • func (l *Logger) Error(i ...interface{})
  • func (l *Logger) Errorf(format string, i ...interface{})
  • func (l *Logger) Errorj(j log.JSON)
  • func (l *Logger) Fatal(i ...interface{})
  • func (l *Logger) Fatalf(format string, i ...interface{})
  • func (l *Logger) Fatalj(j log.JSON)
  • func (l *Logger) Info(i ...interface{})
  • func (l *Logger) Infof(format string, i ...interface{})
  • func (l *Logger) Infoj(j log.JSON)
  • func (l *Logger) Level() log.Lvl
  • func (l *Logger) Output() io.Writer
  • func (l *Logger) Panic(i ...interface{})
  • func (l *Logger) Panicf(format string, i ...interface{})
  • func (l *Logger) Panicj(j log.JSON)
  • func (l *Logger) Prefix() string
  • func (l *Logger) Print(i ...interface{})
  • func (l *Logger) Printf(format string, i ...interface{})
  • func (l *Logger) Printj(j log.JSON)
  • func (l *Logger) SetHeader(_ string)
  • func (l *Logger) SetLevel(newLvl log.Lvl)
  • func (l *Logger) SetOutput(w io.Writer)
  • func (l *Logger) SetPrefix(p string)
  • func (l *Logger) Warn(i ...interface{})
  • func (l *Logger) Warnf(format string, i ...interface{})
  • func (l *Logger) Warnj(j log.JSON)
  • func (l *Logger) Write(p []byte) (int, error)
• type MetricsLabels
• type MetricsTarget

Functions

func BillableEventsHandler

func BillableEventsHandler(store eventio.BillableEventReader, consolidatedStore eventio.ConsolidatedBillableEventReader, uaa auth.Authenticator) echo.HandlerFunc

func CacheHeaders

func CacheHeaders(next echo.HandlerFunc) echo.HandlerFunc

CacheHeaders sets the cache headers to prevent caching

func CurrencyRatesHandler

func CurrencyRatesHandler(store eventio.CurrencyRateReader) echo.HandlerFunc

func DiscovererStatusHandler

func DiscovererStatusHandler(discoverer instancediscoverer.CFAppDiscoverer) echo.HandlerFunc

func EventStoreStatusHandler

func EventStoreStatusHandler(store eventio.EventStore) echo.HandlerFunc

func ForecastEventsHandler

func ForecastEventsHandler(store eventio.BillableEventForecaster) echo.HandlerFunc

func ListenAndServe

func ListenAndServe(ctx context.Context, logger lager.Logger, e *echo.Echo, addr string) error

func MetricsDiscoveryHandler

func MetricsDiscoveryHandler(discoverer instancediscoverer.CFAppDiscoverer) echo.HandlerFunc

func MetricsProxyHandler

func MetricsProxyHandler(proxy metricsproxy.MetricsProxy, discoverer instancediscoverer.CFAppDiscoverer) echo.HandlerFunc

func New

func New(cfg Config) *echo.Echo

New creates a new server. Use ListenAndServe to start accepting connections. Serves api functions

func NewBaseServer

func NewBaseServer(cfg Config) *echo.Echo

New creates a base new server. Use ListenAndServe to start accepting connections. It will only serve the status page

func NewProxyMetrics

func NewProxyMetrics(cfg Config, discoverer instancediscoverer.CFAppDiscoverer, proxy metricsproxy.MetricsProxy) *echo.Echo

func PricingPlansHandler

func PricingPlansHandler(store eventio.PricingPlanReader) echo.HandlerFunc

func TotalCostHandler

func TotalCostHandler(store eventio.TotalCostReader) echo.HandlerFunc

func UsageEventsHandler

func UsageEventsHandler(store eventio.UsageEventReader, uaa auth.Authenticator) echo.HandlerFunc

func VATRatesHandler

func VATRatesHandler(store eventio.VATRateReader) echo.HandlerFunc

Types

type Config

type Config struct {
	// Authenticator sets the auth mechanism (required)
	Authenticator auth.Authenticator
	// Store sets the Store used for querying events (required)
	Store eventio.EventStore
	// Logger sets the request logger
	Logger lager.Logger
	// EnablePanic will cause the server to crash on panic if set to true
	EnablePanic bool
}

type ErrorResponse

type ErrorResponse struct {
	Error      string `json:"error"`
	Constraint string `json:"constraint,omitempty"`
}

type Logger

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

Logger wraps a lager.Logger in the echo.Logger interface

func NewLogger

func NewLogger(logger lager.Logger) *Logger

func (*Logger) Debug

func (l *Logger) Debug(i ...interface{})

func (*Logger) Debugf

func (l *Logger) Debugf(format string, i ...interface{})

func (*Logger) Debugj

func (l *Logger) Debugj(j log.JSON)

func (*Logger) Error

func (l *Logger) Error(i ...interface{})

func (*Logger) Errorf

func (l *Logger) Errorf(format string, i ...interface{})

func (*Logger) Errorj

func (l *Logger) Errorj(j log.JSON)

func (*Logger) Fatal

func (l *Logger) Fatal(i ...interface{})

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, i ...interface{})

func (*Logger) Fatalj

func (l *Logger) Fatalj(j log.JSON)

func (*Logger) Info

func (l *Logger) Info(i ...interface{})

func (*Logger) Infof

func (l *Logger) Infof(format string, i ...interface{})

func (*Logger) Infoj

func (l *Logger) Infoj(j log.JSON)

func (*Logger) Level

func (l *Logger) Level() log.Lvl

func (*Logger) Output

func (l *Logger) Output() io.Writer

func (*Logger) Panic

func (l *Logger) Panic(i ...interface{})

func (*Logger) Panicf

func (l *Logger) Panicf(format string, i ...interface{})

func (*Logger) Panicj

func (l *Logger) Panicj(j log.JSON)

func (*Logger) Prefix

func (l *Logger) Prefix() string

func (*Logger) Print

func (l *Logger) Print(i ...interface{})

func (*Logger) Printf

func (l *Logger) Printf(format string, i ...interface{})

func (*Logger) Printj

func (l *Logger) Printj(j log.JSON)

func (*Logger) SetHeader

func (l *Logger) SetHeader(_ string)

func (*Logger) SetLevel

func (l *Logger) SetLevel(newLvl log.Lvl)

func (*Logger) SetOutput

func (l *Logger) SetOutput(w io.Writer)

func (*Logger) SetPrefix

func (l *Logger) SetPrefix(p string)

func (*Logger) Warn

func (l *Logger) Warn(i ...interface{})

func (*Logger) Warnf

func (l *Logger) Warnf(format string, i ...interface{})

func (*Logger) Warnj

func (l *Logger) Warnj(j log.JSON)

func (*Logger) Write

func (l *Logger) Write(p []byte) (int, error)

Write writes len(p) bytes from p to the underlying data stream. It returns the number of bytes written from p (0 <= n <= len(p)) and any error encountered that caused the write to stop early. Write must return a non-nil error if it returns n < len(p). Write must not modify the slice data, even temporarily.

So… * Always say you wrote all the data. * Never return an error? * Parse the data as JSON without ever modifying the slice.

type MetricsLabels

type MetricsLabels struct {
	MetricsPath     string `json:"__metrics_path__"`
	OrgName         string `json:"__meta_target_orgName"`
	SpaceName       string `json:"__meta_target_spaceName"`
	ApplicationName string `json:"__meta_target_applicationName"`
	ApplicationId   string `json:"__meta_target_applicationID"`
	InstanceNumber  string `json:"__meta_target_instanceNumber"`
	InstanceID      string `json:"__meta_target_instanceId"`
}

type MetricsTarget

type MetricsTarget struct {
	Targets []string      `json:"targets"`
	Labels  MetricsLabels `json:"labels"`
}