make the configured list of AZs available to QuotaPlugin.Scrape()

sapcc · Nov 7, 2023 · cfe045a · cfe045a
1 parent 6a31bdd
commit cfe045a
Show file tree

Hide file tree

Showing 16 changed files with 22 additions and 17 deletions.
diff --git a/internal/collector/scrape.go b/internal/collector/scrape.go
@@ -162,7 +162,7 @@ func (c *Collector) processResourceScrapeTask(_ context.Context, task projectScr
 	logg.Debug("scraping %s resources for %s/%s", srv.Type, dbDomain.Name, dbProject.Name)
 
 	//perform resource scrape
-	resourceData, serializedMetrics, err := plugin.Scrape(project)
+	resourceData, serializedMetrics, err := plugin.Scrape(project, c.Cluster.Config.AvailabilityZones)
 	if err != nil {
 		task.Err = util.UnpackError(err)
 	}

diff --git a/internal/core/constraints_test.go b/internal/core/constraints_test.go
@@ -174,7 +174,7 @@ func (p quotaConstraintTestPlugin) ServiceInfo(serviceType string) limes.Service
 func (p quotaConstraintTestPlugin) Rates() []limesrates.RateInfo {
 	return nil
 }
-func (p quotaConstraintTestPlugin) Scrape(project KeystoneProject) (result map[string]ResourceData, serializedMetrics []byte, err error) {
+func (p quotaConstraintTestPlugin) Scrape(project KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]ResourceData, serializedMetrics []byte, err error) {
 	return nil, nil, nil
 }
 func (p quotaConstraintTestPlugin) IsQuotaAcceptableForProject(project KeystoneProject, fullQuotas map[string]map[string]uint64, allServiceInfos []limes.ServiceInfo) error {

diff --git a/internal/core/plugin.go b/internal/core/plugin.go
@@ -116,9 +116,14 @@ type QuotaPlugin interface {
 	//in the result map must be identical to the resource names
 	//from Resources().
 	//
-	//The serializedMetrics return value is persisted in the Limes DB and
+	//The `allAZs` list comes from the Limes config and should be used when
+	//building AZ-aware usage data, to ensure that each AZ-aware resource reports
+	//usage in all available AZs, even when the project in question does not have
+	//usage in every AZ.
+	//
+	//The `serializedMetrics` return value is persisted in the Limes DB and
 	//supplied to all subsequent RenderMetrics calls.
-	Scrape(project KeystoneProject) (result map[string]ResourceData, serializedMetrics []byte, err error)
+	Scrape(project KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]ResourceData, serializedMetrics []byte, err error)
 	//IsQuotaAcceptableForProject checks if the given quota set is acceptable
 	//for the given project, and returns nil if the quota is acceptable, or a
 	//human-readable error otherwise. This should only be used when the

diff --git a/internal/plugins/archer.go b/internal/plugins/archer.go
@@ -94,7 +94,7 @@ func (p *archerPlugin) Rates() []limesrates.RateInfo {
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *archerPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *archerPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	url := p.Archer.ServiceURL("quotas", project.UUID)
 	var res gophercloud.Result
 	//nolint:bodyclose // already closed by gophercloud

diff --git a/internal/plugins/cinder.go b/internal/plugins/cinder.go
@@ -159,7 +159,7 @@ func (p *cinderPlugin) ScrapeRates(project core.KeystoneProject, prevSerializedS
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *cinderPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, _ []byte, err error) {
+func (p *cinderPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, _ []byte, err error) {
 	isVolumeType := make(map[string]bool)
 	for _, volumeType := range p.VolumeTypes {
 		isVolumeType[volumeType] = true

diff --git a/internal/plugins/cronus.go b/internal/plugins/cronus.go
@@ -94,7 +94,7 @@ func (p *cronusPlugin) Rates() []limesrates.RateInfo {
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *cronusPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *cronusPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	return nil, nil, nil
 }
 

diff --git a/internal/plugins/designate.go b/internal/plugins/designate.go
@@ -91,7 +91,7 @@ func (p *designatePlugin) ScrapeRates(project core.KeystoneProject, prevSerializ
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *designatePlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *designatePlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	//query quotas
 	quotas, err := dnsGetQuota(p.DesignateV2, project.UUID)
 	if err != nil {

diff --git a/internal/plugins/keppel.go b/internal/plugins/keppel.go
@@ -84,7 +84,7 @@ func (p *keppelPlugin) ScrapeRates(project core.KeystoneProject, prevSerializedS
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *keppelPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *keppelPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	quotas, err := p.KeppelV1.GetQuota(project.UUID)
 	if err != nil {
 		return nil, nil, err

diff --git a/internal/plugins/manila.go b/internal/plugins/manila.go
@@ -198,7 +198,7 @@ func (p *manilaPlugin) ScrapeRates(project core.KeystoneProject, prevSerializedS
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *manilaPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *manilaPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	quotaSets := make(map[string]manilaQuotaSetDetail)
 	for _, shareType := range p.ShareTypes {
 		stName := resolveManilaShareType(shareType, project)

diff --git a/internal/plugins/neutron.go b/internal/plugins/neutron.go
@@ -324,7 +324,7 @@ func (p *neutronPlugin) ScrapeRates(project core.KeystoneProject, prevSerialized
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *neutronPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *neutronPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	data := make(map[string]core.ResourceData)
 
 	err = p.scrapeNeutronInto(data, project.UUID)

diff --git a/internal/plugins/nova.go b/internal/plugins/nova.go
@@ -212,7 +212,7 @@ func (p *novaPlugin) ScrapeRates(project core.KeystoneProject, prevSerializedSta
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *novaPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *novaPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	var limitsData struct {
 		Limits struct {
 			Absolute struct {

diff --git a/internal/plugins/swift.go b/internal/plugins/swift.go
@@ -125,7 +125,7 @@ func (p *swiftPlugin) ScrapeRates(project core.KeystoneProject, prevSerializedSt
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *swiftPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *swiftPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	account := p.Account(project.UUID)
 	headers, err := account.Headers()
 	if schwift.Is(err, http.StatusNotFound) || schwift.Is(err, http.StatusGone) {

diff --git a/internal/test/plugins/quota_autoapproval.go b/internal/test/plugins/quota_autoapproval.go
@@ -95,7 +95,7 @@ func (p *AutoApprovalQuotaPlugin) CollectMetrics(ch chan<- prometheus.Metric, pr
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *AutoApprovalQuotaPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *AutoApprovalQuotaPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	return map[string]core.ResourceData{
 		"approve":   {UsageData: core.InAnyAZ(core.UsageData{Usage: 0}), Quota: int64(p.StaticBackendQuota)},
 		"noapprove": {UsageData: core.InAnyAZ(core.UsageData{Usage: 0}), Quota: int64(p.StaticBackendQuota) + 10},

diff --git a/internal/test/plugins/quota_generic.go b/internal/test/plugins/quota_generic.go
@@ -146,7 +146,7 @@ func (p *GenericQuotaPlugin) ScrapeRates(project core.KeystoneProject, prevSeria
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *GenericQuotaPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *GenericQuotaPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	if p.ScrapeFails {
 		return nil, nil, errors.New("Scrape failed as requested")
 	}

diff --git a/internal/test/plugins/quota_noop.go b/internal/test/plugins/quota_noop.go
@@ -94,7 +94,7 @@ func (p *NoopQuotaPlugin) CollectMetrics(ch chan<- prometheus.Metric, project co
 }
 
 // Scrape implements the core.QuotaPlugin interface.
-func (p *NoopQuotaPlugin) Scrape(project core.KeystoneProject) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
+func (p *NoopQuotaPlugin) Scrape(project core.KeystoneProject, allAZs []limes.AvailabilityZone) (result map[string]core.ResourceData, serializedMetrics []byte, err error) {
 	if p.WithEmptyResource {
 		result = map[string]core.ResourceData{
 			"things": {}, //no usage at all (this is used to test that the scraper adds a zero entry for AZ "any")

diff --git a/main.go b/main.go
@@ -235,7 +235,7 @@ func taskTestGetQuota(cluster *core.Cluster, args []string) {
 		logg.Fatal("unknown service type: %s", serviceType)
 	}
 
-	result, serializedMetrics, err := cluster.QuotaPlugins[serviceType].Scrape(project)
+	result, serializedMetrics, err := cluster.QuotaPlugins[serviceType].Scrape(project, cluster.Config.AvailabilityZones)
 	must.Succeed(err)
 
 	for resourceName := range result {