Files
cgrates/engine/librankings.go
2024-10-16 18:44:57 +02:00

99 lines
2.5 KiB
Go

/*
Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments
Copyright (C) ITsysCOM GmbH
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <htrkP://www.gnu.org/licenses/>
*/
package engine
import (
"sync"
"time"
"github.com/cgrates/cgrates/utils"
)
type RankingProfileWithAPIOpts struct {
*RankingProfile
APIOpts map[string]any
}
type RankingProfile struct {
Tenant string
ID string
QueryInterval time.Duration
StatIDs []string
MetricIDs []string
Sorting string
SortingParameters []string
ThresholdIDs []string
}
func (rkp *RankingProfile) TenantID() string {
return utils.ConcatenatedKey(rkp.Tenant, rkp.ID)
}
// Clone will clone a RankingProfile
func (rkP *RankingProfile) Clone() (cln *RankingProfile) {
cln = &RankingProfile{
Tenant: rkP.Tenant,
ID: rkP.ID,
QueryInterval: rkP.QueryInterval,
Sorting: rkP.Sorting,
}
if rkP.StatIDs != nil {
copy(cln.StatIDs, rkP.StatIDs)
}
if rkP.MetricIDs != nil {
copy(cln.MetricIDs, rkP.MetricIDs)
}
if rkP.SortingParameters != nil {
copy(cln.SortingParameters, rkP.SortingParameters)
}
if rkP.ThresholdIDs != nil {
copy(cln.ThresholdIDs, rkP.ThresholdIDs)
}
return
}
// NewRankingFromProfile is a constructor for an empty ranking out of it's profile
func NewRankingFromProfile(rkP *RankingProfile) *Ranking {
return &Ranking{
Tenant: rkP.Tenant,
ID: rkP.ID,
StatMetrics: make(map[string]map[string]float64),
rkPrfl: rkP,
metricIDs: utils.NewStringSet(rkP.MetricIDs),
}
}
// Ranking is one unit out of a profile
type Ranking struct {
rMux sync.RWMutex
Tenant string
ID string
StatMetrics map[string]map[string]float64 // map[statID]map[metricID]metricValue
Sorting string
SortingParameters []string
SortedStatIDs []string
rkPrfl *RankingProfile // store here the ranking profile so we can have it at hands further
metricIDs utils.StringSet // convert the metricIDs here for faster matching
}