Files
cgrates/services/libcgr-engine_test.go
ionutboangiu c7dbcaea03 Revise CPU/Memory profiling
CPU profiling changes:

cgr-engine.go:
- use filepath.Join instead of path.Join
- handle *CoreService.StopCPUProfiling error inside deferred function
- same with the error from *os.File.Close()

cores/core.go:
- StartCPUProfile now returns an *os.File (as opposed to an io.WriteCloser),
  because os.File.Stat is used beforehand to check if a handler of the file is
  already active and confirm the status of profiling.  Asserting the type would
  have worked as well.
- handle pprof.StartCPUProfile error and ensure file is closed before returning
- log file close error as a warning if it occurs
- return missing mandatory error with correct path field name ('DirPath')
- no need to check if fileCPU is nil for profiling status
  - pprof.StartCPUProfiling will return an error if profiling is already started
  - os.File.Close() will return ErrClosed if profiling is already stopped
- differentiate between calling StopCPUProfiling when profiling hasn't started
and when it was already stopped by returning appropriate errors

Memory profiling changes:

- merge StopChanMemProf with StopMemoryProfiling
- remove fileMEM and stopMemProf from struct and constructors
- add separate mutex for memory profiling, ensure thread safety
- handle all significant errors
- log error if StopMemoryProfiling fails during CoreS Shutdown
- ignore errors if profiling inactive in Shutdown and deferred Stop
- move validations inside V1 functions
- return error if StartMemoryProfiling already started
- return error if StopMemoryProfiling already stopped or never started
- close profiling loop on error, not the cgr-engine
- StopMemoryProfiling closes channel and profiling loop writes final profile
- rename Path to DirPath for mandatory field error
- rename memprof_nrfiles flag to memprof_maxfiles
- increase default memprof_interval
- consider MaxFiles <= 0 as unlimited
- move memory profiling logic after starting services
- use CoreService Start/StopMemoryProfiling in main
- remove final memory profile block (created by deferred Stop)
- convert MemProfiling to method on CoreService and rename to profileMemory
- use Ticker for recurrent actions instead of Timer
- compute mem_final.prof full path in StartMemoryProfiling
- suffix profile files with current time instead of numbers
- update dispatcher methods after changes
- move MemoryPrf from utils to cores, rename to MemoryProfilingParams
- add logs for starting/stopping profiling
- added the possibility to disable timestamps in the memory profile file names
  and use increments of 1 instead.

Other changes:

- improved integration tests for flags (now table tests)
- improved profiling integration tests
2024-11-01 15:59:39 +01:00

162 lines
4.2 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 <http://www.gnu.org/licenses/>
*/
package services
import (
"path"
"reflect"
"testing"
"time"
)
// If any flag changes, this test should fail.
// Do not use constants in this test to ensure these changes are detected.
func TestCgrEngineFlags(t *testing.T) {
ngFlags := NewCGREngineFlags()
tests := []struct {
name string
flags []string
flagVar any
defaultVal any
want any
}{
{
name: "cfgPath",
flags: []string{"-config_path", path.Join("/usr", "share", "cgrates", "conf", "samples", "tutorial")},
flagVar: ngFlags.CfgPath,
defaultVal: "/etc/cgrates/",
want: "/usr/share/cgrates/conf/samples/tutorial",
},
{
name: "version",
flags: []string{"-version"},
flagVar: ngFlags.Version,
defaultVal: false,
want: true,
},
{
name: "pidFile",
flags: []string{"-pid", "/run/cgrates/cgrates.pid"},
flagVar: ngFlags.PidFile,
defaultVal: "",
want: "/run/cgrates/cgrates.pid",
},
{
name: "cpuProfDir",
flags: []string{"-cpuprof_dir", "/tmp/profiling"},
flagVar: ngFlags.CpuPrfDir,
defaultVal: "",
want: "/tmp/profiling",
},
{
name: "memProfDir",
flags: []string{"-memprof_dir", "/tmp/profiling"},
flagVar: ngFlags.MemPrfDir,
defaultVal: "",
want: "/tmp/profiling",
},
{
name: "memProfInterval",
flags: []string{"-memprof_interval", "1s"},
flagVar: ngFlags.MemPrfInterval,
defaultVal: 15 * time.Second,
want: time.Second,
},
{
name: "memProfMaxFiles",
flags: []string{"-memprof_maxfiles", "3"},
flagVar: ngFlags.MemPrfMaxF,
defaultVal: 1,
want: 3,
},
{
name: "memProfTimestamp",
flags: []string{"-memprof_timestamp"},
flagVar: ngFlags.MemPrfTS,
defaultVal: false,
want: true,
},
{
name: "scheduledShutdown",
flags: []string{"-scheduled_shutdown", "1h"},
flagVar: ngFlags.ScheduledShutDown,
defaultVal: "",
want: "1h",
},
{
name: "singleCPU",
flags: []string{"-singlecpu"},
flagVar: ngFlags.Singlecpu,
defaultVal: false,
want: true,
},
{
name: "syslogger",
flags: []string{"-logger", "*stdout"},
flagVar: ngFlags.SysLogger,
defaultVal: "",
want: "*stdout",
},
{
name: "nodeID",
flags: []string{"-node_id", "CGRateS.org"},
flagVar: ngFlags.NodeID,
defaultVal: "",
want: "CGRateS.org",
},
{
name: "logLevel",
flags: []string{"-log_level", "7"},
flagVar: ngFlags.LogLevel,
defaultVal: -1,
want: 7,
},
{
name: "preload",
flags: []string{"-preload", "TestPreloadID"},
flagVar: ngFlags.Preload,
defaultVal: "",
want: "TestPreloadID",
},
{
name: "check_config",
flags: []string{"-check_config", "true"},
flagVar: ngFlags.CheckConfig,
defaultVal: false,
want: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
flagVal := reflect.ValueOf(tt.flagVar).Elem().Interface()
if flagVal != tt.defaultVal {
t.Errorf("%s=%v, want default value %v", tt.name, flagVal, tt.defaultVal)
}
if err := ngFlags.Parse(tt.flags); err != nil {
t.Errorf("cgrEngineFlags.Parse(%v) returned unexpected error: %v", tt.flags, err)
}
flagVal = reflect.ValueOf(tt.flagVar).Elem().Interface()
if flagVal != tt.want {
t.Errorf("%s=%v, want %v", tt.name, flagVal, tt.want)
}
})
}
}