monitor

Documentation

Overview

Package monitor contains the interface for monitoring adapters.

Subpackages contain several examples of adapters.

Index

• type EarlyRetriever
• type MonitoringAdapter
• type RetrievalItem

Types

type EarlyRetriever

type EarlyRetriever interface {
	RetrieveAllValues(items []RetrievalItem) []assessment_model.GuaranteeData
}

EarlyRetriever is implemented by adapters that want to (and can) retrieve all monitoring information in one query for efficiency reasons

type MonitoringAdapter

type MonitoringAdapter interface {
	// Intialize the monitoring retrieval for one evaluation of the agreement
	//
	// A new MonitoringAdapter, copy of current adapter, must be returned
	Initialize(a *model.Agreement) MonitoringAdapter

	// GetValues retrieve the metrics corresponding to the variables found in a guarantee
	GetValues(gt model.Guarantee, vars []string, to time.Time) assessment_model.GuaranteeData
}

MonitoringAdapter is an interface which should be implemented per monitoring solution

type RetrievalItem

type RetrievalItem struct {
	Guarantee model.Guarantee
	Var       model.Variable
	From      time.Time
	To        time.Time
}

RetrievalItem contains the retrieval information for a variable

Used in EarlyRetriever interface