cgrates/engine/statsqueue.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 <http://www.gnu.org/licenses/>
*/
package engine

import (
	"errors"
	"fmt"
	"sync"
	"time"

	"github.com/cgrates/cgrates/utils"
)

// SQItem represents one item in the stats queue
type SQItem struct {
	EventID    string     // Bounded to the original StatsEvent
	ExpiryTime *time.Time // Used to auto-expire events
}

// SQStored contains values saved in DB on store
type StoredSQ struct {
	SQItems   []*SQItem
	SQMetrics map[string][]byte
}

// StatsQueue represents an individual stats instance
type StatsQueue struct {
	sync.RWMutex
	dirty     bool // needs save
	sec       *StatsEventCache
	sqItems   []*SQItem
	sqMetrics map[string]StatsMetric

	ID                 string                    // QueueID
	ActivationInterval *utils.ActivationInterval // Activation interval
	Filters            []*RequestFilter
	QueueLength        int
	TTL                time.Duration
	Metrics            []string // list of metrics to build
	Store              bool     // store to DB
	Thresholds         []string // list of thresholds to be checked after changes
}

// Init prepares a StatsQueue for operations
// Should be executed at server start
func (sq *StatsQueue) Init(sec *StatsEventCache, storedSQ *StoredSQ) (err error) {
	sq.sec = sec
	if storedSQ == nil {
		return
	}
	sq.sqItems = storedSQ.SQItems
	for metricID := range sq.sqMetrics {
		if sq.sqMetrics[metricID], err = NewStatsMetric(metricID); err != nil {
			return
		}
		if stored, has := storedSQ.SQMetrics[metricID]; !has {
			continue
		} else if err = sq.sqMetrics[metricID].loadStoredValues(stored); err != nil {
			return
		}
	}
	return
}

// GetStoredSQ retrieves the data used for store to DB
func (sq *StatsQueue) GetStoredSQ() (sSQ *StoredSQ, err error) {
	sq.RLock()
	defer sq.RUnlock()
	if !sq.Store {
		return nil, errors.New("not storable")
	}
	sSQ = &StoredSQ{
		SQItems:   sq.sqItems,
		SQMetrics: make(map[string][]byte, len(sq.sqMetrics))}
	for metricID, metric := range sq.sqMetrics {
		if sSQ.SQMetrics[metricID], err = metric.getStoredValues(); err != nil {
			return nil, err
		}
	}
	return
}

// remExpired expires items in queue
func (sq *StatsQueue) remExpired() {
	var expIdx *int // index of last item to be expired
	for i, item := range sq.sqItems {
		if item.ExpiryTime == nil {
			break
		}
		if item.ExpiryTime.After(time.Now()) {
			break
		}
		sq.remEventWithID(item.EventID)
		item = nil // garbage collected asap
		expIdx = &i
	}
	if expIdx == nil {
		return
	}
	nextValidIdx := *expIdx + 1
	sq.sqItems = sq.sqItems[nextValidIdx:]
}

// remOnQueueLength rems elements based on QueueLength setting
func (sq *StatsQueue) remOnQueueLength() {
	if sq.QueueLength == 0 {
		return
	}
	if len(sq.sqItems) == sq.QueueLength { // reached limit, rem first element
		itm := sq.sqItems[0]
		sq.remEventWithID(itm.EventID)
		itm = nil
		sq.sqItems = sq.sqItems[1:]
	}
}

// addStatsEvent computes metrics for an event
func (sq *StatsQueue) addStatsEvent(ev StatsEvent) {
	evID := ev.ID()
	for metricID, metric := range sq.sqMetrics {
		if err := metric.addEvent(ev); err != nil {
			utils.Logger.Warning(fmt.Sprintf("<StatsQueue> metricID: %s, add eventID: %s, error: %s",
				metricID, evID, err.Error()))
		}
	}
}

// remStatsEvent removes an event from metrics
func (sq *StatsQueue) remEventWithID(evID string) {
	ev := sq.sec.GetEvent(evID)
	if ev == nil {
		utils.Logger.Warning(fmt.Sprintf("<StatsQueue> removing eventID: %s, error: event not cached", evID))
		return
	}
	for metricID, metric := range sq.sqMetrics {
		if err := metric.remEvent(ev); err != nil {
			utils.Logger.Warning(fmt.Sprintf("<StatsQueue> metricID: %s, remove eventID: %s, error: %s", metricID, evID, err.Error()))
		}
	}
}

// ProcessEvent processes a StatsEvent, returns true if processed
func (sq *StatsQueue) ProcessEvent(ev StatsEvent) (err error) {
	sq.Lock()
	sq.remExpired()
	sq.remOnQueueLength()
	sq.addStatsEvent(ev)
	sq.Unlock()
	return
}