monitoring

README

Carbon Monitoring

Caspian periodically calls Carbon monitoring to update the carbon spec of ClusterInfo custum resources. The figure below shows the steps that carbon monitoring takes to update this field. Carbon monitoring retrieves the carbon intensity data from Electricity Maps.

Documentation

Index

• Variables
• type Monitor
  • func NewMonitor(config *rest.Config) *Monitor
  • func (m Monitor) GetCarbonFromFile(FilePath string) ([]string, bool)
  • func (m *Monitor) GetClusters() error
  • func (m Monitor) GetForecastedCarbonIntensity(zone string) ([]string, bool)
  • func (m Monitor) UpdateCarbon(spoke core.Cluster) error
  • func (m Monitor) UpdateClusterInfo() error

Variables

var ClusterInfoResource = schema.GroupVersionResource{Group: mcadv1beta1.GroupVersion.Group,
	Version: mcadv1beta1.GroupVersion.Version, Resource: "clusterinfo"}

Types

type Monitor

type Monitor struct {
	Spokes []core.Cluster

	T int
	// contains filtered or unexported fields
}

A monitor instace contains a list of Clusters, and rest client

func NewMonitor

func NewMonitor(config *rest.Config) *Monitor

NewMonior creates a Monitor instance and configures its clients.

func (Monitor) GetCarbonFromFile

func (m Monitor) GetCarbonFromFile(FilePath string) ([]string, bool)

Read carbon from file

func (*Monitor) GetClusters

func (m *Monitor) GetClusters() error

create the list of spoke Clusters, each spoke is corresponding to one clusterinfo object in hub

func (Monitor) GetForecastedCarbonIntensity

func (m Monitor) GetForecastedCarbonIntensity(zone string) ([]string, bool)

func (Monitor) UpdateCarbon

func (m Monitor) UpdateCarbon(spoke core.Cluster) error

Retrive carbon intensity and update the carbon field of clusterinfo object

func (Monitor) UpdateClusterInfo

func (m Monitor) UpdateClusterInfo() error

get the names and geolocation of each spoke, update the carbon intensity of its corresponding cluster Info object in the hub.