collect

Documentation

Index

• func ProcessMetrics(prometheusAPI v1.API, metric string, metricObjects []metrics.MetricObject, ...) error
• type Option
  • func WithStep(step time.Duration) Option
• type Options
  • func DefaultOptions() *Options
  • func (o *Options) Step() time.Duration

Functions

func ProcessMetrics

func ProcessMetrics(prometheusAPI v1.API, metric string, metricObjects []metrics.MetricObject, dataDir string, timePeriod int, log *zap.Logger, inputOptions ...Option) error

ProcessMetrics queries the Prometheus API with the given metric object and outputs the returned data into CSV files prometheusAPI: the Prometheus client used to make API calls with metric: the current metric group being processed dataDir: the name of the directory that the CSV files will be written to timePeriod: the time, in minutes, to look back, starting from the current time, for the Prometheus query

Types

type Option

type Option func(*Options)

func WithStep

func WithStep(step time.Duration) Option

WithStep sets the step size. This is mainly useful for testing queries with differing step sizes, and to provide the option for specific metrics to use a different step size than the default

type Options

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

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns the default options

func (*Options) Step

func (o *Options) Step() time.Duration

Step returns the step size