collect

Documentation

Index

• Constants
• type CloudWatchCollector
  • func NewCloudWatchCollector(config CloudWatchCollectorConfig) (*CloudWatchCollector, error)
  • func (cwc *CloudWatchCollector) Collect(metric metric.Metric) error
• type CloudWatchCollectorConfig
• type Collector
• type FileCollector
  • func NewFileCollector(config FileCollectorConfig) (*FileCollector, error)
  • func (fc *FileCollector) Collect(metric metric.Metric) error
• type FileCollectorConfig

Constants

const (
	DefaultMetricFileNameSuffix = "doctor-metrics.json"
	DefaultFileRotationInterval = 1 * time.Hour
)

Types

type CloudWatchCollector

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

CloudWatchCollector implements the Collector interface, collecting metrics to a file

func NewCloudWatchCollector

func NewCloudWatchCollector(config CloudWatchCollectorConfig) (*CloudWatchCollector, error)

NewCloudWatchCollector attempts to create a new CloudWatchCollector using the specified config returning the CloudWatchCollector and error (if any)

func (*CloudWatchCollector) Collect

func (cwc *CloudWatchCollector) Collect(metric metric.Metric) error

Collect collects metric to CloudWatch returning error (if any) (rotation is only triggered when a metric is collection) Collect is safe to call across go-routines

type CloudWatchCollectorConfig

type CloudWatchCollectorConfig struct {
	Ctx             context.Context
	AWSRegion       string
	MetricNamespace string
}

CloudWatchCollectorConfig wraps values for configuring a CloudWatch

type Collector

type Collector interface {
	Collect(metric metric.Metric) error
}

Collector allows for collecting a metric to an arbitrary metric sink (e.g. a file or AWS CloudWatch) for historical and real time monitoring purposes

type FileCollector

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

FileCollector implements the Collector interface, collecting metrics to a file

func NewFileCollector

func NewFileCollector(config FileCollectorConfig) (*FileCollector, error)

NewFileCollector attempts to create a new FileCollector using the specified config (or default values where appropriate) returning the FileCollector and error (if any)

func (*FileCollector) Collect

func (fc *FileCollector) Collect(metric metric.Metric) error

Collect collects metric to a file, returning error (if any) Collect will ensure that the file is rotated at most `fileRotationInterval` (rotation is only triggered when a metric is collection) Collect is safe to call across go-routines, and will block to ensure an in progress collection completes cleanly before a new metric is collected

type FileCollectorConfig

type FileCollectorConfig struct {
	MetricFileNameSuffix string
	FileRotationInterval *time.Duration
}

FileCollectorConfig wraps values for configuring a FileCollector