domain

Documentation

Overview

Package domain provides domain logic.

Index

• Constants
• Variables
• type FileMonitor
  • func NewFileMonitor(ctx context.Context, bus types.Bus, filePath string) (*FileMonitor, error)
  • func (m *FileMonitor) Close()
  • func (m *FileMonitor) Start()
• type MetricCollector
  • func NewMetricCollector(s *config.Settings, clock types.TimeProvider, costStore types.WritableStore, ...) (*MetricCollector, error)
  • func (d *MetricCollector) Close()
  • func (d *MetricCollector) DecodeV1(data []byte) ([]types.Metric, error)
  • func (d *MetricCollector) DecodeV2(data []byte) ([]types.Metric, *remote.WriteResponseStats, error)
  • func (d *MetricCollector) Flush(ctx context.Context) error
  • func (d *MetricCollector) PutMetrics(ctx context.Context, contentType, encodingType string, body []byte) (*remote.WriteResponseStats, error)
  • func (d *MetricCollector) Settings() *config.Settings
• type MetricFilter
  • func NewMetricFilter(cfg *config.Metrics) (*MetricFilter, error)
  • func (mf *MetricFilter) Filter(metrics []types.Metric) (costMetrics []types.Metric, observabilityMetrics []types.Metric, ...)

Constants

const (
	// FileCreated event type
	FileCreated = "file_created"
	// FileChanged event type
	FileChanged = "file_changed"
	// FileDeleted event type
	FileDeleted = "file_deleted"
	// FileRenamed event type
	FileRenamed = "file_rename"
)

const (
	SnappyBlockCompression = "snappy"
)

Variables

var (
	ErrJSONUnmarshal    = errors.New("failed to parse metric from request body")
	ErrMetricIDMismatch = errors.New("metric ID in path does not match product ID in body")
)

Types

type FileMonitor

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

FileMonitor is responsible for monitoring changes in the secret file, and will notify components in the application that depend on the secret filePath can be a directory or a single file

func NewFileMonitor

func NewFileMonitor(ctx context.Context, bus types.Bus, filePath string) (*FileMonitor, error)

NewFileMonitor creates a new file monitor.

func (*FileMonitor) Close

func (m *FileMonitor) Close()

func (*FileMonitor) Start

func (m *FileMonitor) Start()

type MetricCollector

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

MetricCollector is responsible for collecting and flushing metrics.

func NewMetricCollector

func NewMetricCollector(s *config.Settings, clock types.TimeProvider, costStore types.WritableStore, observabilityStore types.WritableStore) (*MetricCollector, error)

NewMetricCollector creates a new MetricCollector and starts the flushing goroutine.

func (*MetricCollector) Close

func (d *MetricCollector) Close()

Close stops the flushing goroutine gracefully.

func (*MetricCollector) DecodeV1

func (d *MetricCollector) DecodeV1(data []byte) ([]types.Metric, error)

DecodeV1 decompresses and decodes a Protobuf v1 WriteRequest, then converts it to a slice of Metric structs.

func (*MetricCollector) DecodeV2

func (d *MetricCollector) DecodeV2(data []byte) ([]types.Metric, *remote.WriteResponseStats, error)

DecodeV2 decompresses and decodes a Protobuf v2 WriteRequest, then converts it to a slice of Metric structs and collects stats.

func (*MetricCollector) Flush

func (d *MetricCollector) Flush(ctx context.Context) error

Flush triggers the flushing of accumulated metrics.

func (*MetricCollector) PutMetrics

func (d *MetricCollector) PutMetrics(ctx context.Context, contentType, encodingType string, body []byte) (*remote.WriteResponseStats, error)

PutMetrics appends metrics and returns write response stats.

func (*MetricCollector) Settings

func (d *MetricCollector) Settings() *config.Settings

type MetricFilter

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

MetricFilter is a filter that can be used to filter metrics, including labels, according to the configuration provided.

func NewMetricFilter

func NewMetricFilter(cfg *config.Metrics) (*MetricFilter, error)

NewMetricFilter creates a new MetricFilter for the given configuration.

func (*MetricFilter) Filter

func (mf *MetricFilter) Filter(metrics []types.Metric) (costMetrics []types.Metric, observabilityMetrics []types.Metric, droppedMetrics []types.Metric)

Filter processes the supplied metrics through the filter. It returns three slices: the first being the list of cost metrics, the second being the list of observability metrics, and the third being the list of dropped metrics. Both cost and observability metrics have also had the labels filtered to only include those that match the filter. Dropped metrics are defined as those which matched neither the cost nor observability filters.