/* 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 */ package engine import ( "math" "sync" "time" "github.com/cgrates/cgrates/utils" ) // A TrendProfile represents the settings of a Trend type TrendProfile struct { Tenant string ID string Schedule string // Cron expression scheduling gathering of the metrics StatID string Metrics []string TTL time.Duration QueueLength int MinItems int // minimum number of items for building Trends CorrelationType string // *last, *average Tolerance float64 // allow this deviation margin for *constant trend Stored bool // store the Trend in dataDB ThresholdIDs []string } // Clone will clone the TrendProfile so it can be used by scheduler safely func (tP *TrendProfile) Clone() (clnTp *TrendProfile) { clnTp = &TrendProfile{ Tenant: tP.Tenant, ID: tP.ID, Schedule: tP.Schedule, StatID: tP.StatID, QueueLength: tP.QueueLength, TTL: tP.TTL, MinItems: tP.MinItems, CorrelationType: tP.CorrelationType, Tolerance: tP.Tolerance, Stored: tP.Stored, } if tP.Metrics != nil { clnTp.Metrics = make([]string, len(tP.Metrics)) for i, mID := range tP.Metrics { clnTp.Metrics[i] = mID } } if tP.ThresholdIDs != nil { clnTp.ThresholdIDs = make([]string, len(tP.ThresholdIDs)) for i, tID := range tP.ThresholdIDs { clnTp.ThresholdIDs[i] = tID } } return } type TrendProfileWithAPIOpts struct { *TrendProfile APIOpts map[string]any } func (srp *TrendProfile) TenantID() string { return utils.ConcatenatedKey(srp.Tenant, srp.ID) } type TrendProfilesAPI struct { Tenant string TpIDs []string } type TrendWithAPIOpts struct { *Trend APIOpts map[string]any } // Trend is the unit matched by filters type Trend struct { tMux *sync.RWMutex Tenant string ID string RunTimes []time.Time Metrics map[time.Time]map[string]*MetricWithTrend CompressedMetrics []byte // if populated, Metrics will be empty // indexes help faster processing mLast map[string]time.Time // last time a metric was present mCounts map[string]int // number of times a metrics is present in Metrics mTotals map[string]float64 // cached sum, used for average calculations tP *TrendProfile // cache here the settings } // computeIndexes should be called after each retrieval from DB func (t *Trend) computeIndexes() { t.mLast = make(map[string]time.Time) t.mCounts = make(map[string]int) t.mTotals = make(map[string]float64) for _, runTime := range t.RunTimes { for _, mWt := range t.Metrics[runTime] { t.indexesAppendMetric(mWt, runTime) } } } // indexesAppendMetric appends a single metric to indexes func (t *Trend) indexesAppendMetric(mWt *MetricWithTrend, rTime time.Time) { t.mLast[mWt.ID] = rTime t.mCounts[mWt.ID]++ t.mTotals[mWt.ID] += mWt.Value } // getTrendGrowth returns the percentage growth for a specific metric // // correlation parameter will define whether the comparison is against last or average value // errors in case of previous func (t *Trend) getTrendGrowth(mID string, mVal float64, correlation string, roundDec int) (tG float64, err error) { var prevVal float64 if _, has := t.mLast[mID]; !has { return -1.0, utils.ErrNotFound } if _, has := t.Metrics[t.mLast[mID]][mID]; !has { return -1.0, utils.ErrNotFound } switch correlation { case utils.MetaLast: prevVal = t.Metrics[t.mLast[mID]][mID].Value case utils.MetaAverage: prevVal = t.mTotals[mID] / float64(t.mCounts[mID]) default: return -1.0, utils.ErrCorrelationUndefined } diffVal := mVal - prevVal return utils.Round(diffVal/100, roundDec, utils.MetaRoundingMiddle), nil } // getTrendLabel identifies the trend label for the instant value of the metric // // *positive, *negative, *constant, N/A func (t *Trend) getTrendLabel(tGrowth float64, tolerance float64) (lbl string) { switch { case tGrowth > 0: lbl = utils.MetaPositive case tGrowth < 0: lbl = utils.MetaNegative default: lbl = utils.MetaConstant } if math.Abs(tGrowth) <= tolerance { // percentage value of diff is lower than threshold lbl = utils.MetaConstant } return } // MetricWithTrend represents one read from StatS type MetricWithTrend struct { ID string // Metric ID Value float64 // Metric Value TrendGrowth float64 // Difference between last and previous TrendLabel string // *positive, *negative, *constant, N/A } func (tr *Trend) TenantID() string { return utils.ConcatenatedKey(tr.Tenant, tr.ID) }