MVP: Cost attribution #10269
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| // SPDX-License-Identifier: AGPL-3.0-only | ||
|
|
||
| package costattribution | ||
|
|
||
| import ( | ||
| "context" | ||
| "sort" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/go-kit/log" | ||
| "github.com/grafana/dskit/services" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
|
|
||
| "github.com/grafana/mimir/pkg/util/validation" | ||
| ) | ||
|
|
||
| const ( | ||
| trackerLabel = "tracker" | ||
| tenantLabel = "tenant" | ||
| defaultTrackerName = "cost-attribution" | ||
| missingValue = "__missing__" | ||
| overflowValue = "__overflow__" | ||
| ) | ||
|
|
||
| type Manager struct { | ||
| services.Service | ||
| logger log.Logger | ||
| inactiveTimeout time.Duration | ||
| limits *validation.Overrides | ||
|
|
||
| mtx sync.RWMutex | ||
| trackersByUserID map[string]*Tracker | ||
| reg *prometheus.Registry | ||
| cleanupInterval time.Duration | ||
| metricsExportInterval time.Duration | ||
| } | ||
|
|
||
| func NewManager(cleanupInterval, exportInterval, inactiveTimeout time.Duration, logger log.Logger, limits *validation.Overrides, reg *prometheus.Registry) (*Manager, error) { | ||
| m := &Manager{ | ||
| trackersByUserID: make(map[string]*Tracker), | ||
| limits: limits, | ||
| mtx: sync.RWMutex{}, | ||
| inactiveTimeout: inactiveTimeout, | ||
| logger: logger, | ||
| reg: reg, | ||
| cleanupInterval: cleanupInterval, | ||
| metricsExportInterval: exportInterval, | ||
| } | ||
|
|
||
| m.Service = services.NewTimerService(cleanupInterval, nil, m.iteration, nil).WithName("cost attribution manager") | ||
| if err := reg.Register(m); err != nil { | ||
| return nil, err | ||
| } | ||
| return m, nil | ||
| } | ||
|
|
||
| func (m *Manager) iteration(_ context.Context) error { | ||
| return m.purgeInactiveAttributionsUntil(time.Now().Add(-m.inactiveTimeout).Unix()) | ||
| } | ||
|
|
||
| func (m *Manager) EnabledForUser(userID string) bool { | ||
| if m == nil { | ||
| return false | ||
| } | ||
| return len(m.limits.CostAttributionLabels(userID)) > 0 | ||
| } | ||
|
|
||
| func (m *Manager) Tracker(userID string) *Tracker { | ||
| if !m.EnabledForUser(userID) { | ||
| return nil | ||
| } | ||
|
|
||
| // Check if the tracker already exists, if exists return it. Otherwise lock and create a new tracker. | ||
| m.mtx.RLock() | ||
| tracker, exists := m.trackersByUserID[userID] | ||
| m.mtx.RUnlock() | ||
| if exists { | ||
| return tracker | ||
| } | ||
|
|
||
| m.mtx.Lock() | ||
| defer m.mtx.Unlock() | ||
| if tracker, exists = m.trackersByUserID[userID]; exists { | ||
| return tracker | ||
| } | ||
| tracker = newTracker(userID, m.limits.CostAttributionLabels(userID), m.limits.MaxCostAttributionCardinalityPerUser(userID), m.limits.CostAttributionCooldown(userID), m.logger) | ||
|
There was a problem hiding this comment. Nit, but I would collect all the information needed to build a tracker (all the There was a problem hiding this comment. addressed in commit 679f2cc |
||
| m.trackersByUserID[userID] = tracker | ||
| return tracker | ||
| } | ||
|
|
||
| func (m *Manager) Collect(out chan<- prometheus.Metric) { | ||
| m.mtx.RLock() | ||
| defer m.mtx.RUnlock() | ||
| for _, tracker := range m.trackersByUserID { | ||
| tracker.Collect(out) | ||
| } | ||
| } | ||
|
|
||
| func (m *Manager) Describe(chan<- *prometheus.Desc) { | ||
colega marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // Describe is not implemented because the metrics include dynamic labels. The Manager functions as an unchecked exporter. | ||
| // For more details, refer to the documentation: https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#hdr-Custom_Collectors_and_constant_Metrics | ||
| } | ||
|
|
||
| func (m *Manager) deleteTracker(userID string) { | ||
| m.mtx.Lock() | ||
| defer m.mtx.Unlock() | ||
| delete(m.trackersByUserID, userID) | ||
| } | ||
|
|
||
| func (m *Manager) updateTracker(userID string) *Tracker { | ||
| t := m.Tracker(userID) | ||
|
|
||
| if t == nil { | ||
| m.deleteTracker(userID) | ||
| return nil | ||
| } | ||
|
|
||
| newTrackedLabels := m.limits.CostAttributionLabels(userID) | ||
|
|
||
| // sort the labels to ensure the order is consistent | ||
| sort.Slice(newTrackedLabels, func(i, j int) bool { | ||
|
There was a problem hiding this comment. Is it safe to modify the slice returned by There was a problem hiding this comment. modify the copy instead, addressed in 888d8b0 |
||
| return newTrackedLabels[i] < newTrackedLabels[j] | ||
| }) | ||
ying-jeanne marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // if the labels have changed or the max cardinality or cooldown duration have changed, create a new tracker | ||
| if !t.hasSameLabels(newTrackedLabels) || t.maxCardinality != m.limits.MaxCostAttributionCardinalityPerUser(userID) || t.cooldownDuration != int64(m.limits.CostAttributionCooldown(userID).Seconds()) { | ||
| m.mtx.Lock() | ||
| t = newTracker(userID, newTrackedLabels, m.limits.MaxCostAttributionCardinalityPerUser(userID), m.limits.CostAttributionCooldown(userID), m.logger) | ||
| m.trackersByUserID[userID] = t | ||
| m.mtx.Unlock() | ||
| return t | ||
| } | ||
|
|
||
| return t | ||
| } | ||
|
|
||
| func (m *Manager) purgeInactiveAttributionsUntil(deadline int64) error { | ||
| m.mtx.RLock() | ||
| userIDs := make([]string, 0, len(m.trackersByUserID)) | ||
| for userID := range m.trackersByUserID { | ||
| userIDs = append(userIDs, userID) | ||
| } | ||
| m.mtx.RUnlock() | ||
|
|
||
| for _, userID := range userIDs { | ||
| t := m.updateTracker(userID) | ||
| if t == nil { | ||
| continue | ||
| } | ||
|
|
||
| invalidKeys := t.inactiveObservations(deadline) | ||
| for _, key := range invalidKeys { | ||
| t.cleanupTrackerAttribution(key) | ||
| } | ||
|
|
||
| if t.shouldDelete(deadline) { | ||
| m.deleteTracker(userID) | ||
ying-jeanne marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
| return nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this doesn't need to be exported.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
addressed in commit 679f2cc