/* 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 Affero 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 Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see */ package ees import ( "fmt" "slices" "strings" "sync" "time" "github.com/cgrates/birpc/context" "github.com/cgrates/cgrates/config" "github.com/cgrates/cgrates/engine" "github.com/cgrates/cgrates/utils" "github.com/cgrates/ltcache" ) // onCacheEvicted is called by ltcache when evicting an item func onCacheEvicted(_ string, value any) { ee := value.(EventExporter) ee.GetMetrics().StopCron() ee.Close() } // NewEventExporterS initializes a new EventExporterS. func NewEventExporterS(cfg *config.CGRConfig, filterS *engine.FilterS, connMgr *engine.ConnManager) (*EventExporterS, error) { eeS := &EventExporterS{ cfg: cfg, filterS: filterS, connMgr: connMgr, } if err := eeS.SetupExporterCache(); err != nil { return nil, fmt.Errorf("failed to set up exporter cache: %v", err) } return eeS, nil } // EventExporterS is managing the EventExporters type EventExporterS struct { cfg *config.CGRConfig filterS *engine.FilterS connMgr *engine.ConnManager exporterCache map[string]*ltcache.Cache // map[eeType]*ltcache.Cache mu sync.RWMutex // protects exporterCache } // ClearExporterCache clears the cache of EventExporters. func (eeS *EventExporterS) ClearExporterCache() { eeS.mu.Lock() defer eeS.mu.Unlock() for chID, ch := range eeS.exporterCache { ch.Clear() delete(eeS.exporterCache, chID) } } // SetupExporterCache initializes the cache for EventExporters. func (eeS *EventExporterS) SetupExporterCache() error { expCache := make(map[string]*ltcache.Cache) eesCfg := eeS.cfg.EEsNoLksCfg() // Initialize cache. for chID, chCfg := range eesCfg.Cache { if chCfg.Limit == 0 { continue // skip if caching is disabled } expCache[chID] = ltcache.NewCache(chCfg.Limit, chCfg.TTL, chCfg.StaticTTL, false, []func(itmID string, value any){onCacheEvicted}) // Precache exporters if required. if chCfg.Precache { for _, expCfg := range eesCfg.Exporters { if expCfg.Type == chID { ee, err := NewEventExporter(expCfg, eeS.cfg, eeS.filterS, eeS.connMgr) if err != nil { return fmt.Errorf("precache: failed to init EventExporter %q: %v", expCfg.ID, err) } expCache[chID].Set(expCfg.ID, ee, nil) } } } } eeS.exporterCache = expCache return nil } func (eeS *EventExporterS) attrSProcessEvent(cgrEv *utils.CGREvent, attrIDs []string, ctx string) (*utils.CGREvent, error) { var rplyEv engine.AttrSProcessEventReply cgrEv.APIOpts[utils.MetaSubsys] = utils.MetaEEs cgrEv.APIOpts[utils.OptsAttributesProfileIDs] = attrIDs cgrEv.APIOpts[utils.OptsContext] = utils.FirstNonEmpty(ctx, utils.IfaceAsString(cgrEv.APIOpts[utils.OptsContext]), utils.MetaEEs) err := eeS.connMgr.Call(context.TODO(), eeS.cfg.EEsNoLksCfg().AttributeSConns, utils.AttributeSv1ProcessEvent, cgrEv, &rplyEv) if err != nil && err.Error() != utils.ErrNotFound.Error() { return nil, err } if len(rplyEv.AlteredFields) != 0 { if !slices.ContainsFunc(rplyEv.AlteredFields, func(field string) bool { return strings.HasPrefix( field, utils.MetaReq+utils.NestingSep+utils.CostDetails, ) }, ) { // CostDetails was not changed, its original value can be used safely. if _, has := cgrEv.Event[utils.CostDetails]; has { rplyEv.Event[utils.CostDetails] = cgrEv.Event[utils.CostDetails] } return rplyEv.CGREvent, nil } // If CostDetails key exists in Event, ensure its value // is of type *engine.EventCost. if cd, has := rplyEv.Event[utils.CostDetails]; has { if _, canCast := cd.(*engine.EventCost); !canCast { ec, err := engine.ConvertToEventCost(cd) if err != nil { return nil, err } rplyEv.Event[utils.CostDetails] = ec } } return rplyEv.CGREvent, nil } return cgrEv, nil } // V1ProcessEvent will be called each time a new event is received from readers // rply -> map[string]map[string]any func (eeS *EventExporterS) V1ProcessEvent(ctx *context.Context, cgrEv *engine.CGREventWithEeIDs, rply *map[string]map[string]any) (err error) { eeS.cfg.RLocks(config.EEsJson) defer eeS.cfg.RUnlocks(config.EEsJson) expIDs := utils.NewStringSet(cgrEv.EeIDs) lenExpIDs := expIDs.Size() cgrDp := utils.MapStorage{ utils.MetaReq: cgrEv.Event, utils.MetaOpts: cgrEv.APIOpts, } if cgrEv.CGREvent.Time != nil { cgrDp[utils.MetaEventTimestamp] = *cgrEv.CGREvent.Time } var wg sync.WaitGroup var withErr bool var metricMapLock sync.RWMutex metricsMap := make(map[string]utils.MapStorage) _, hasVerbose := cgrEv.APIOpts[utils.OptsEEsVerbose] for _, eeCfg := range eeS.cfg.EEsNoLksCfg().Exporters { if eeCfg.Type == utils.MetaNone || // ignore *none type exporter (lenExpIDs != 0 && !expIDs.Has(eeCfg.ID)) { continue } if cgrEv.APIOpts == nil { cgrEv.APIOpts = make(map[string]any) } cgrEv.APIOpts[utils.MetaExporterID] = eeCfg.ID if len(eeCfg.Filters) != 0 { tnt := utils.FirstNonEmpty(cgrEv.Tenant, eeS.cfg.GeneralCfg().DefaultTenant) if pass, errPass := eeS.filterS.Pass(tnt, eeCfg.Filters, cgrDp); errPass != nil { return errPass } else if !pass { continue // does not pass the filters, ignore the exporter } } exportEvent := cgrEv.CGREvent if !eeCfg.Synchronous { exportEvent = exportEvent.Clone() } if eeCfg.Flags.GetBool(utils.MetaAttributes) { if exportEvent, err = eeS.attrSProcessEvent( cgrEv.CGREvent, eeCfg.AttributeSIDs, utils.FirstNonEmpty( eeCfg.AttributeSCtx, utils.IfaceAsString(cgrEv.APIOpts[utils.OptsContext]), utils.MetaEEs)); err != nil { return } } eeS.mu.RLock() eeCache, hasCache := eeS.exporterCache[eeCfg.Type] eeS.mu.RUnlock() var isCached bool var ee EventExporter if hasCache { var x any if x, isCached = eeCache.Get(eeCfg.ID); isCached { ee = x.(EventExporter) } } if !isCached { if ee, err = NewEventExporter(eeCfg, eeS.cfg, eeS.filterS, eeS.connMgr); err != nil { return fmt.Errorf("failed to init EventExporter %q: %v", eeCfg.ID, err) } if hasCache { eeS.mu.Lock() if _, has := eeCache.Get(eeCfg.ID); !has { eeCache.Set(eeCfg.ID, ee, nil) } else { // Another exporter instance with the same ID has been cached in // the meantime. Mark this instance to be closed after the export. hasCache = false } eeS.mu.Unlock() } } metricMapLock.Lock() metricsMap[ee.Cfg().ID] = utils.MapStorage{} // will return the ID for all processed exporters metricMapLock.Unlock() if eeCfg.Synchronous { wg.Add(1) // wait for sync to complete before returning } // log the message before starting the gorutine, but still execute the exporter if hasVerbose && !eeCfg.Synchronous { utils.Logger.Warning( fmt.Sprintf("<%s> with id <%s>, running verbosed exporter with synchronous false", utils.EEs, ee.Cfg().ID)) } go func(evict, sync bool, ee EventExporter) { if err := exportEventWithExporter(ee, exportEvent, evict, eeS.cfg, eeS.filterS); err != nil { utils.Logger.Warning( fmt.Sprintf("<%s> Exporter <%s> error : <%s>", utils.EEs, ee.Cfg().ID, err.Error())) withErr = true } if sync { if hasVerbose { metricMapLock.Lock() metricsMap[ee.Cfg().ID] = ee.GetMetrics().ClonedMapStorage() metricMapLock.Unlock() } wg.Done() } }(!hasCache, eeCfg.Synchronous, ee) } wg.Wait() if withErr { err = utils.ErrPartiallyExecuted return } *rply = make(map[string]map[string]any) metricMapLock.Lock() for exporterID, metrics := range metricsMap { (*rply)[exporterID] = make(map[string]any) for key, val := range metrics { switch key { case utils.PositiveExports, utils.NegativeExports: slsVal, canCast := val.(utils.StringSet) if !canCast { return fmt.Errorf("cannot cast to map[string]any %+v for positive exports", val) } (*rply)[exporterID][key] = slsVal.AsSlice() default: (*rply)[exporterID][key] = val } } } metricMapLock.Unlock() if len(*rply) == 0 { return utils.ErrNotFound } return } func exportEventWithExporter(exp EventExporter, ev *utils.CGREvent, oneTime bool, cfg *config.CGRConfig, filterS *engine.FilterS) (err error) { defer func() { updateEEMetrics(exp.GetMetrics(), ev.ID, ev.Event, err != nil, utils.FirstNonEmpty(exp.Cfg().Timezone, cfg.GeneralCfg().DefaultTimezone)) if oneTime { exp.Close() } }() var eEv any exp.GetMetrics().IncrementEvents() if len(exp.Cfg().ContentFields()) == 0 { if eEv, err = exp.PrepareMap(ev); err != nil { return } } else { expNM := utils.NewOrderedNavigableMap() dsMap := map[string]utils.DataStorage{ utils.MetaReq: utils.MapStorage(ev.Event), utils.MetaEM: exp.GetMetrics(), utils.MetaOpts: utils.MapStorage(ev.APIOpts), utils.MetaCfg: cfg.GetDataProvider(), utils.MetaVars: utils.MapStorage{utils.MetaTenant: ev.Tenant, utils.MetaExporterID: ev.APIOpts[utils.MetaExporterID]}, } var canCast bool dsMap[utils.MetaEC], canCast = ev.Event[utils.CostDetails].(*engine.EventCost) if !canCast { dsMap[utils.MetaEC] = engine.NewBareEventCost() } err = engine.NewExportRequest(dsMap, utils.FirstNonEmpty(ev.Tenant, cfg.GeneralCfg().DefaultTenant), filterS, map[string]*utils.OrderedNavigableMap{ utils.MetaExp: expNM, }).SetFields(exp.Cfg().ContentFields()) if err != nil { return fmt.Errorf("failed to populate ExportRequest fields: %v", err) } if eEv, err = exp.PrepareOrderMap(expNM); err != nil { return } } key := utils.ConcatenatedKey(utils.FirstNonEmpty(engine.MapEvent(ev.Event).GetStringIgnoreErrors(utils.CGRID), utils.GenUUID()), utils.FirstNonEmpty(engine.MapEvent(ev.Event).GetStringIgnoreErrors(utils.RunID), utils.MetaDefault)) return ExportWithAttempts(exp, eEv, key) } func ExportWithAttempts(exp EventExporter, eEv any, key string) (err error) { if exp.Cfg().FailedPostsDir != utils.MetaNone { defer func() { if err != nil { AddFailedPost(exp.Cfg().FailedPostsDir, exp.Cfg().ExportPath, exp.Cfg().Type, exp.Cfg().Attempts, eEv, exp.Cfg().Opts) } }() } fib := utils.FibDuration(time.Second, 0) for i := 0; i < exp.Cfg().Attempts; i++ { if err = exp.Connect(); err == nil { break } if i+1 < exp.Cfg().Attempts { time.Sleep(fib()) } } if err != nil { utils.Logger.Warning( fmt.Sprintf("<%s> Exporter <%s> could not connect because err: <%s>", utils.EEs, exp.Cfg().ID, err.Error())) return } if exp.Cfg().Flags.GetBool(utils.MetaLog) { var evLog string switch c := eEv.(type) { case []byte: evLog = string(c) case string: evLog = c case *HTTPPosterRequest: evByt, cancast := c.Body.([]byte) if cancast { evLog = string(evByt) break } evLog = utils.ToJSON(c.Body) default: evLog = utils.ToJSON(c) } utils.Logger.Info( fmt.Sprintf("<%s> LOG, exporter <%s>, message: %s", utils.EEs, exp.Cfg().ID, evLog)) } for i := 0; i < exp.Cfg().Attempts; i++ { if err = exp.ExportEvent(eEv, key); err == nil || err == utils.ErrDisconnected { // special error in case the exporter was closed break } if i+1 < exp.Cfg().Attempts { time.Sleep(fib()) } } if err != nil { utils.Logger.Warning( fmt.Sprintf("<%s> Exporter <%s> could not export because err: <%s>", utils.EEs, exp.Cfg().ID, err.Error())) } return } // V1ResetExporterMetricsParams contains required parameters for resetting exporter metrics. type V1ResetExporterMetricsParams struct { Tenant string ID string // unique identifier of the request ExporterID string APIOpts map[string]any } // V1ResetExporterMetrics resets the metrics for a specific exporter identified by ExporterID. // Returns utils.ErrNotFound if the exporter is not found in the cache. func (eeS *EventExporterS) V1ResetExporterMetrics(ctx *context.Context, params V1ResetExporterMetricsParams, reply *string) error { eeCfg := eeS.cfg.EEsCfg().ExporterCfg(params.ExporterID) ee, ok := eeS.exporterCache[eeCfg.Type].Get(eeCfg.ID) if !ok { return utils.ErrNotFound } ee.(EventExporter).GetMetrics().Reset() *reply = utils.OK return nil }