uppal/cgrates
1
0
Fork 1
mirror of https://github.com/cgrates/cgrates.git synced 2026-02-11 18:16:24 +05:00
Code Issues Packages Projects Releases Wiki Activity

History basic documentation, FsCgr tests fixup for localtime compliance, SaveInterval config on history server parsed as time.Duration

Browse Source
This commit is contained in:
DanB
2013-12-29 14:17:38 +01:00
parent ec5417d6e4
commit 5024944a2b
11 changed files with 78 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cdrs/fscdr_test.go
View File

@@ -108,7 +108,7 @@ func TestFsCdrAsRatedCdr(t *testing.T) {
expctRatedCdr := &utils.RatedCDR{CgrId: utils.FSCgrId("01df56f4-d99a-4ef6-b7fe-b924b2415b7f"), AccId: "01df56f4-d99a-4ef6-b7fe-b924b2415b7f",
CdrHost: "127.0.0.1", CdrSource: FS_CDR_SOURCE, ReqType: utils.RATED,
Direction: "*out", Tenant: "ipbx.itsyscom.com", TOR: "call", Account: "dan", Subject: "dan", Destination: "+4986517174963",
AnswerTime: time.Date(2013, 8, 4, 11, 50, 56, 0, time.Local), Duration: time.Duration(4)*time.Second,
AnswerTime: time.Date(2013, 8, 4, 9, 50, 56, 0, time.UTC).Local(), Duration: time.Duration(4)*time.Second,
ExtraFields: map[string]string{"effective_caller_id_number": "+4986517174960"}, MediationRunId: "wholesale_run", Cost: -1}
if !reflect.DeepEqual(rtCdrOut, expctRatedCdr) {
t.Errorf("Received: %v, expected: %v", rtCdrOut, expctRatedCdr)

2
cmd/cgr-engine/cgr-engine.go
View File

@@ -220,7 +220,7 @@ func startHistoryScribe() {
var scribeServer history.Scribe
if cfg.HistoryServerEnabled {
if scribeServer, err = history.NewFileScribe(cfg.HistoryPath, cfg.HistorySavePeriod); err != nil {
if scribeServer, err = history.NewFileScribe(cfg.HistoryPath, cfg.HistorySaveInterval); err != nil {
engine.Logger.Crit(err.Error())
exitChan <- true
return

13
config/config.go
View File

@@ -133,11 +133,11 @@ type CGRConfig struct {
FreeswitchPass string // FS socket password
FreeswitchReconnects int // number of times to attempt reconnect after connect fails
HistoryAgentEnabled bool // Starts History as an agent: <true|false>.
HistoryServerEnabled bool // Starts History as server: <true|false>.
HistoryServer string // Address where to reach the master history server: <internal|x.y.z.y:1234>
HistoryServerEnabled bool // Starts History as server: <true|false>.
HistoryListen string // History server listening interface: <internal|x.y.z.y:1234>
HistoryPath string // Location on disk where to store history files.
HistorySavePeriod string // The timout duration between history writes
HistorySaveInterval time.Duration // The timout duration between history writes
}
func (self *CGRConfig) setDefaults() error {
@@ -225,7 +225,7 @@ func (self *CGRConfig) setDefaults() error {
self.HistoryServer = "127.0.0.1:2013"
self.HistoryListen = "127.0.0.1:2013"
self.HistoryPath = "/var/log/cgrates/history"
self.HistorySavePeriod = "1s"
self.HistorySaveInterval = time.Duration(1) * time.Second
return nil
}
@@ -538,8 +538,11 @@ func loadConfig(c *conf.ConfigFile) (*CGRConfig, error) {
if hasOpt = c.HasOption("history_server", "path"); hasOpt {
cfg.HistoryPath, _ = c.GetString("history_server", "path")
}
if hasOpt = c.HasOption("history_server", "save_period"); hasOpt {
cfg.HistorySavePeriod, _ = c.GetString("history_server", "save_period")
if hasOpt = c.HasOption("history_server", "save_interval"); hasOpt {
saveIntvlStr,_ := c.GetString("history_server", "save_interval")
if cfg.HistorySaveInterval, errParse = utils.ParseDurationWithSecs(saveIntvlStr); errParse != nil {
return nil, errParse
}
}
return cfg, nil
}

4
config/config_test.go
View File

@@ -130,7 +130,7 @@ func TestDefaults(t *testing.T) {
eCfg.HistoryServerEnabled = false
eCfg.HistoryListen = "127.0.0.1:2013"
eCfg.HistoryPath = "/var/log/cgrates/history"
eCfg.HistorySavePeriod = "1s"
eCfg.HistorySaveInterval = time.Duration(1)*time.Second
if !reflect.DeepEqual(cfg, eCfg) {
t.Log(eCfg)
t.Log(cfg)
@@ -251,7 +251,7 @@ func TestConfigFromFile(t *testing.T) {
eCfg.HistoryServerEnabled = true
eCfg.HistoryListen = "test"
eCfg.HistoryPath = "test"
eCfg.HistorySavePeriod = "test"
eCfg.HistorySaveInterval = time.Duration(99)*time.Second
if !reflect.DeepEqual(cfg, eCfg) {
t.Log(eCfg)
t.Log(cfg)

11
config/test_data.txt
View File

@@ -99,12 +99,13 @@ server = test # Adress where to connect to FreeSWITCH socket.
passwd = test # FreeSWITCH socket password.
reconnects = 99 # Number of attempts on connect failure.
[history_agent]
enabled = true # Starts History as a client: <true|false>.
server = test # Address where to reach the master history server: <internal|x.y.z.y:1234>
[history_server]
enabled = true # Starts History service: <true|false>.
listen = test # Listening addres for history server: <internal|x.y.z.y:1234>
path = test # Location on disk where to store history files.
save_period = test # Timeout duration between saves
save_interval = 99 # Timeout duration between saves
[history_agent]
enabled = true # Starts History as a client: <true|false>.
server = test # Address where to reach the master history server: <internal|x.y.z.y:1234>

18
data/conf/cgrates.cfg
View File

@@ -34,7 +34,7 @@
[balancer]
# enabled = false # Start Balancer service: <true|false>.
# listen = 127.0.0.1:2012 # Balancer listen interface: <disabled|x.y.z.y:1234>.
# listen = 127.0.0.1:2012 # Balancer listen interface: <""|x.y.z.y:1234>.
[rater]
# enabled = false # Enable RaterCDRSExportPath service: <true|false>.
@@ -101,11 +101,13 @@
# passwd = ClueCon # FreeSWITCH socket password.
# reconnects = 5 # Number of attempts on connect failure.
[history_agent]
#enabled = false # Starts History as a client: <true|false>.
#server = 127.0.0.1:2013 # Address where to reach the master history server: <internal|x.y.z.y:1234>
[history_server]
#enabled = false # Starts History service: <true|false>.
#listen = 127.0.0.1:2013 # Listening addres for history server: <internal|x.y.z.y:1234>
#path = /var/log/cgrates/history # Location on disk where to store history files.
# enabled = false # Starts History service: <true|false>.
# listen = 127.0.0.1:2013 # Listening addres for history server: <internal|x.y.z.y:1234>
# path = /var/log/cgrates/history # Location on disk where to store history files.
# save_interval = 1s # Interval to save changed cache into .git archive
[history_agent]
# enabled = false # Starts History as a client: <true|false>.
# server = 127.0.0.1:2013 # Address where to reach the master history server: <internal|x.y.z.y:1234>

1
docs/advanced.rst
View File

@@ -8,6 +8,7 @@
cdrserver
cdrclient
cdrexporter
history
ratinglogic

12
docs/cdrclient.rst
View File

@@ -3,19 +3,21 @@ CDR Client (cdrc)
It's role is to gather offline CDRs and post them to CDR Server(CDRS) component.
Controlled within *cdrc* section of the configuration file.
Part of the *cgr-engine*, can be started on a remote server as standalone component.
Controlled within *cdrc* section of the configuration file.
Has two modes of operation:
- Automated: CDR file processing is triggered on file creation/move.
- Manual: CDR file processing will be triggered at configured time interval (delay/sleep between processes).
- Periodic: CDR file processing will be triggered at configured time interval (delay/sleep between processes) and it will be performed on all files present in the folder (IN) at run time.
Principles behind functionality:
- Monitor/process a CDR folder (IN) as outlined above.
- Read every file in the folder, extract the information based on configuration and post it via configured mechanism to CDRS.
- For every file processed, extract the information based on configuration and post it via configured mechanism to CDRS.
- The fields extracted out of each CDR row are the same ones depicted in the CDRS documentation (following primary and extra fields concept).
- Once the file processing completes, move it in it's original format in another folder (OUT) in order to avoid re-processing. Here it worths mentioning the auto-detection of duplicated CDRs at server side based on accid and host fields.
- Once the file processing completes, move it in it's original format in another folder (OUT) in order to avoid re-processing. Here it's worth mentioning the auto-detection of duplicated CDRs at server side based on accid and host fields.
For the moment we support processing CDRs in the following formats:

38
docs/history.rst Normal file
View File

@@ -0,0 +1,38 @@
Rates history
=============
Enhances CGRateS with ability to archive rates modifications.
Ability to scale by using server-agents approach.
In a distributed environment, there will be a single server (which can be backed up using technologies such as Linux-HA) and more agents sending the modifications to be archived.
History-Server
--------------
Part of the *cgr-engine*.
Controlled within *history_server* section of the configuration file.
Stores rates archive in a .git folder, hence making the rating changes available for analysis via any git browser tool (eg: gitg in linux).
Functionality:
- On startup reads the rates archive out of .git folder and caches the data.
- When receiving rates information from the agents it will recompile the rates cache.
- Based on configured save interval it will dump the rating cache (if changed) into the .git archive.
- Archives the following rating data:
- Destinations inside *destinations.json* file.
- Rating plans inside *rating_plans.json* file.
- Rating profiles inside *rating_profiles.json* file.
History-Agent
-------------
Integrated in the rates loader components.
Part of *cgr-engine* and *cgr-loader*.
Enabled via *history_agent* configuration section within *cgr-engine* and *history_server* command line parameter in case of *cgr-loader*.
Sends the complete rating data loaded into ratingDb to *history_server* for archiving.

3
docs/installation.rst
View File

@@ -32,7 +32,7 @@ Since on Debian we use Daemontools_ to control the CGRateS another way to check
3.2. Using source
-----------------
After the go environment is installed_ and configured_ issue the following commands:
After the go environment is installed_ (at least go1.2) and configured_ issue the following commands:
::
go get github.com/cgrates/cgrates
@@ -42,6 +42,7 @@ This command will install the trunk version of CGRateS together with all the nec
.. _installed: http://golang.org/doc/install
.. _configured: http://golang.org/doc/code.html
3.3. Post-install
-----------------
CGRateS needs at minimum one external database where to keep it's main data as well as logs of it's operation.

7
history/file_scribe.go
View File

@@ -49,17 +49,14 @@ type FileScribe struct {
savePeriod time.Duration
}
func NewFileScribe(fileRoot string, savePeriod string) (*FileScribe, error) {
func NewFileScribe(fileRoot string, saveInterval time.Duration) (*FileScribe, error) {
// looking for git
gitCommand, err := exec.LookPath("git")
if err != nil {
return nil, errors.New("Please install git: " + err.Error())
}
s := &FileScribe{fileRoot: fileRoot, gitCommand: gitCommand}
s := &FileScribe{fileRoot: fileRoot, gitCommand: gitCommand, savePeriod: saveInterval}
s.loopChecker = make(chan int)
if s.savePeriod, err = time.ParseDuration(savePeriod); err != nil {
return nil, err
}
s.gitInit()
if err := s.load(DESTINATIONS_FILE); err != nil {
return nil, err