carbonapi

Documentation

Index

• Variables
• type App
  • func New(config cfg.API, logger *zap.Logger, buildVersion string) (*App, error)
  • func (app *App) Start()
• type PrometheusMetrics
• type Rule
• type RuleConfig

Variables

var BuildVersion string

BuildVersion is provided to be overridden at build time. Eg. go build -ldflags -X 'main.BuildVersion=...'

Types

type App

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

App is the main carbonapi runnable

func New

func New(config cfg.API, logger *zap.Logger, buildVersion string) (*App, error)

New creates a new app

func (*App) Start

func (app *App) Start()

Start starts the app: inits handlers, logger, starts HTTP server

type PrometheusMetrics

type PrometheusMetrics struct {
	Requests     prometheus.Counter
	Responses    *prometheus.CounterVec
	DurationsExp prometheus.Histogram
	DurationsLin prometheus.Histogram
	TimeInQueue  prometheus.Histogram
}

PrometheusMetrics are metrix exported via /metrics endpoint for Prom scraping

type Rule

type Rule map[string]string

type RuleConfig

type RuleConfig struct {
	Rules []Rule
}