Latest revision as of 15:16, 13 June 2024

This procedure describes how to configure a Tmedia and ProSBC to send its Call Detail Records (CDR) files to a remote server automatically and perform daily (or monthly) file archives.

Overview

The tbcopycdr script supports the following features:

Move cdr files from TMG_CDR_DIR to TMG_TEMP_DIR
Send files to a remote server
Move sucessfully sent files (rename to .sent.gz) from TMG_TEMP_DIR to TMG_ARCHIVE_DIR (ARCHIVE=true)
Rename sucessfully sent files (.sent.gz) in TMG_TEMP_DIR (ARCHIVE=false; ERASE_AFTER_SEND=false)
Delete sucessfully sent files from TMG_TEMP_DIR (ARCHIVE=false; ERASE_AFTER_SEND=true)
If a file failed to be sent to remote server, it is kept in TMG_TEMP_DIR until it is successfully sent

The tbarchivecdr script creates a gzip tar archive with all gz files copied by tbcopycdr in TMG_ARCHIVE_DIR

Change directory to TMG_ARCHIVE_DIR
Create a temporary folder with the current date (for example: 2016-01-30)
Sleep for 90 second
Move all *.gz files and $TMG_TEMP_DIR/$LOG_FILE to this folder
Archive the folder in a gzipped tar file (cdr_2016_01_30_$hostname.tgz)

Configuration

The script is configured with user variables.

CONFIG_FILE: Configuration file name and location. By default, it is set to /root/tbcopycdr.cfg

CONFIG_FILE=/root/tbcopycdr.cfg

tbcopycdr.cfg file example:

TMG_TEMP_DIR=/home/tbcopycdr
TMG_CDR_DIR=/lib/tb/toolpack/setup/12358/cdr_logs
ARCHIVE=true
TMG_ARCHIVE_DIR=/lib/tb/toolpack/setup/12358/cdr_archive
ARCHIVE_MAX_DAYS=180
REMOTE_HOST=192.168.101.170
REMOTE_PORT=22
REMOTE_DIR=/root/cdr_backups
REMOTE_USER=root

The configuration file can redefine any of the following user variables. To see the default variables:

head -n 50 /usr/bin/tbcopycdr

TMG_CDR_DIR: Tmedia directory where the CDR are located. Default is /lib/tb/toolpack/setup/12358/cdr_logs

TMG_CDR_DIR=/lib/tb/toolpack/setup/12358/cdr_logs

REMOTE_HOST : Remote hostname or Ip address. Remote host copy is disabled by default.

REMOTE_HOST=10.10.10.10

REMOTE_PORT : Remote host ssh port.

REMOTE_PORT=22

REMOTE_DIR : Remote directory where to copy the backup files (/root/backup by default)

REMOTE_DIR=/root/backup

REMOTE_USER : Remote host login user.

REMOTE_USER=root

CONNECT_TIMEOUT : scp connection timeout

CONNECT_TIMEOUT=10

ARCHIVE: true or false. If set to true, move successfully sent files (rename to .sent.gz) from TMG_TEMP_DIR to TMG_ARCHIVE_DIR. Default is false.

ARCHIVE=false

TMG_ARCHIVE_DIR: Directory where the cdrs are moved if ARCHIVE=true

TMG_ARCHIVE_DIR=/lib/tb/toolpack/setup/12358/cdr_archive

ARCHIVE_MAX_DAYS: Define how many days the archive file (.tgz) should be kept in TMG_ARCHIVE_DIR. This user variable is used by tbarchivecdr only.

# Assign no value to disable
ARCHIVE_MAX_DAYS=

ERASE_AFTER_SEND: Take effect only if ARCHIVE is false. If ERASE_AFTER_SEND is true, erase file from TMG_TEMP_DIR, else, rename and keep files in working directory.

ERASE_AFTER_SEND=false

Note: If you set ERASE_AFTER_SEND to false, the CDR text file will be available in the /home/telcobridges/cdr/ directory and renamed *.gz.already_send.

Remote Server Copy

You must create an SSH key pair and copy it to the remote server, if the remote server copy is configured. This will enable copy the backup files to the remote host without asking for a password. Follow the instructions here:

Password-less SSH

Troubleshooting

Test

Run the tbcopycdr script with the -v option

tbcopycdr -v

If no errors are seen in the shell, your configuration is correct. In addition, you should have a hello_world.log file on the remote host.

Log File

Transfer results are written in $TMG_TEMP_DIR/$LOG_FILE

Schedule the Scripts

Create a new crontab on the Tmedia

crontab -e

Add new lines with the cron configuration

tbcopycdr:

Frequency	Cron Configuration
Every 10 minutes	`/10 * * * /usr/bin/tbcopycdr > /dev/null 2>&1`
hourly (top of the hour)	`0 * * * * /usr/bin/tbcopycdr > /dev/null 2>&1`
daily (midnight)	`0 0 * * * /usr/bin/tbcopycdr > /dev/null 2>&1`

tbarchivecdr:

Frequency	Cron Configuration
daily@23h59	`59 23 * * * /usr/bin/tbarchivecdr > /dev/null 2>&1`
weekly (sunday@23h59)	`59 23 * 7 * /usr/bin/tbarchivecdr > /dev/null 2>&1`

Cron table example for a cdr copy to an external server every 10 minutes with a daily archive of all the transmitted files:

*/10 * * * * /usr/bin/tbcopycdr > /dev/null 2>&1
59 23 * * * /usr/bin/tbarchivecdr > /dev/null 2>&1

@@ Line 1: / Line 1: @@
-This procedure shows how to configure a Tmedia to send its CDR files to a remote server automatically.
+{{DISPLAYTITLE:Automatic Text CDR Retrieval}}
-Warning: If the destination is a Windows server, you require to install software that supports scp (i.e. freeSSHd). Not tested by TelcoBridges personnel.
+This procedure describes how to configure a Tmedia and [[ProSBC]] to send its Call Detail Records (CDR) files to a remote server automatically and perform daily (or monthly) file archives.
+= Overview =
+The ''tbcopycdr'' script supports the following features:
+*Move cdr files from TMG_CDR_DIR to TMG_TEMP_DIR
+*Send files to a remote server
+*Move sucessfully sent files (rename to .sent.gz) from TMG_TEMP_DIR to TMG_ARCHIVE_DIR (ARCHIVE=true)
+*Rename sucessfully sent files (.sent.gz) in TMG_TEMP_DIR (ARCHIVE=false; ERASE_AFTER_SEND=false)
+*Delete sucessfully sent files from TMG_TEMP_DIR (ARCHIVE=false; ERASE_AFTER_SEND=true)
+*If a file failed to be sent to remote server, it is kept in TMG_TEMP_DIR until it is successfully sent
+<br>
+The ''tbarchivecdr'' script creates a gzip tar archive with all gz files copied by ''tbcopycdr'' in TMG_ARCHIVE_DIR
+*Change directory to TMG_ARCHIVE_DIR
+*Create a temporary folder with the current date (for example: 2016-01-30)
+*Sleep for 90 second
+*Move all *.gz files and $TMG_TEMP_DIR/$LOG_FILE to this folder
+*Archive the folder in a gzipped tar file (cdr_2016_01_30_$hostname.tgz)
-= Setup SSH Public/Private Key =
+= Configuration =
+The script is configured with '''user variables'''.
+*''CONFIG_FILE'': Configuration file name and location. By default, it is set to /root/tbcopycdr.cfg
+ CONFIG_FILE=/root/tbcopycdr.cfg
-This will enable the [[Tmedia]] to send files to the remote host without asking for a password:
+''tbcopycdr.cfg'' file example:
+ TMG_TEMP_DIR=/home/tbcopycdr
+ TMG_CDR_DIR=/lib/tb/toolpack/setup/12358/cdr_logs
+ ARCHIVE=true
+ TMG_ARCHIVE_DIR=/lib/tb/toolpack/setup/12358/cdr_archive
+ ARCHIVE_MAX_DAYS=180
+ REMOTE_HOST=192.168.101.170
+ REMOTE_PORT=22
+ REMOTE_DIR=/root/cdr_backups
+ REMOTE_USER=root
-*Connect to the [[Tmedia]] using SSH as root
+The configuration file can redefine any of the following user variables.
+To see the default variables:
+ head -n 50 /usr/bin/tbcopycdr
-*Create [[Tmedia]] public/private dsa key pair
+*''TMG_CDR_DIR'': Tmedia directory where the [[Text_Call_Detail_Records_(CDR)|CDR]] are located. Default is /lib/tb/toolpack/setup/12358/cdr_logs
-  ssh-keygen -t dsa
+  TMG_CDR_DIR=/lib/tb/toolpack/setup/12358/cdr_logs
-Note: Do not add a pass phrase, simply press enter until the key pair is generate.
-*Append the content of the public key to the remote host authorized keys
-[[Tmedia]] public key location
+*''REMOTE_HOST'' : Remote hostname or Ip address. Remote host copy is disabled by default.
-  /root/.ssh/id_dsa.pub
+  REMOTE_HOST=10.10.10.10
+*''REMOTE_PORT'' : Remote host ssh port.
-Remote Host authorized keys location
+ REMOTE_PORT=22
-  ~/.ssh/authorized_keys
+*''REMOTE_DIR'' : Remote directory where to copy the backup files (/root/backup by default)
+  REMOTE_DIR=/root/backup
-= Configure the Tmedia to Send files =
+*''REMOTE_USER'' : Remote host login user.
+ REMOTE_USER=root
+*''CONNECT_TIMEOUT'' : ''scp'' connection timeout
+ CONNECT_TIMEOUT=10
-*Open the file configuration
+*''ARCHIVE'': true or false. If set to true, move successfully sent files (rename to .sent.gz) from TMG_TEMP_DIR to TMG_ARCHIVE_DIR. Default is false.
-  vim /usr/bin/tbcopycdr
+ ARCHIVE=false
+*''TMG_ARCHIVE_DIR'': Directory where the cdrs are moved if ARCHIVE=true
+  TMG_ARCHIVE_DIR=/lib/tb/toolpack/setup/12358/cdr_archive
+*''ARCHIVE_MAX_DAYS'': Define how many days the archive file (.tgz) should be kept in TMG_ARCHIVE_DIR. This user variable is used by ''tbarchivecdr'' only.
+ # Assign no value to disable
+ ARCHIVE_MAX_DAYS=
-*Set the following variables in the file
+*''ERASE_AFTER_SEND'': Take effect only if ARCHIVE is false. If ERASE_AFTER_SEND is true, erase file from TMG_TEMP_DIR, else, rename and keep files in working directory.
-**TMG_CDR_DIR (Tmedia directory where the [[Text_Call_Detail_Records_(CDR)|CDR]] are located)
+  ERASE_AFTER_SEND=false
-**REMOTE_DIR  (Remote host directory where the [[Text_Call_Detail_Records_(CDR)|CDR]] will be send)
-**REMOTE_USER (Remote host user)
-**REMOTE_HOST (Remote host name or Ip address)
-**ERASE_AFTER_SEND (TMedia will erase the [[Text_Call_Detail_Records_(CDR)|CDR]] files locally or not after a successful send, default true)
-Note: if you set ERASE_AFTER_SEND to false the CDR text file will be available in the /home/telcobridges/cdr/ directory and rename *.gz.already_send.
+Note: If you set ERASE_AFTER_SEND to false, the CDR text file will be available in the /home/telcobridges/cdr/ directory and renamed *.gz.already_send.
-Example: Send the files to the home directory of the root user of host 10.10.10.10
+= Remote Server Copy =
- TMG_CDR_DIR=/lib/tb/toolpack/setup/12358/2.5/apps/gateway/cdr_logs/
+You must create an SSH key pair and copy it to the remote server, if the remote server copy is configured. This will enable copy the backup files to the remote host without asking for a password. Follow the instructions here:
- REMOTE_DIR=~/
+* [[Password_less_ssh|Password-less SSH]]
- REMOTE_USER=root
- REMOTE_HOST=10.10.10.10
- ERASE_AFTER_SEND=true
-=== Validate Setup Configuration ===
+=Troubleshooting =
+== Test ==
 *Run the tbcopycdr script with the -v option
   tbcopycdr -v
-If no error were seen on the shell, your configuration is correct. Also, you should have a hello_world.log file on the remote host.
+If no errors are seen in the shell, your configuration is correct. In addition, you should have a hello_world.log file on the remote host.
+== Log File ==
+Transfer results are written in $TMG_TEMP_DIR/$LOG_FILE
-= Configure Tmedia to send the files automatically =
+= Schedule the Scripts =
 *Create a new crontab on the [[Tmedia]]
   crontab -e
-*Add new line with the cron configuration
+*Add new lines with the cron configuration
-Example:
+'''''tbcopycdr''''':
 {| cellpadding="5" border="1" class="wikitable"
 |-
 ! width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | Frequency
-! width="350" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | Cron Configuration
+! width="400" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | Cron Configuration
 |-
-! width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | Every 10 minutes
+| width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255); text-align:center;" | Every 10 minutes
-! width="350" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>*/10 * * * * /usr/bin/tbcopycdr</code>
+| width="400" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>*/10 * * * * /usr/bin/tbcopycdr > /dev/null 2>&1</code>
 |-
-! width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | hourly (top of the hour)
+| width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255); text-align:center;" | hourly (top of the hour)
-! width="350" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>0 * * * * /usr/bin/tbcopycdr</code>
+| width="400" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>0 * * * * /usr/bin/tbcopycdr > /dev/null 2>&1</code>
 |-
-! width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | daily (midnight)
+| width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255); text-align:center;" | daily (midnight)
-! width="350" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>0 0 * * * /usr/bin/tbcopycdr</code>
+| width="400" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>0 0 * * * /usr/bin/tbcopycdr > /dev/null 2>&1</code>
 |}
+'''''tbarchivecdr''''':
+{| cellpadding="5" border="1" class="wikitable"
+|-
+! width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | Frequency
+! width="400" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | Cron Configuration
+|-
+| width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255); text-align:center;" | daily@23h59
+| width="400" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>59 23 * * * /usr/bin/tbarchivecdr > /dev/null 2>&1</code>
+|-
+| width="210" style="background: none repeat scroll 0% 0% rgb(255, 255, 255); text-align:center;" | weekly (sunday@23h59)
+| width="400" style="background: none repeat scroll 0% 0% rgb(255, 255, 255);" | <code>59 23 * 7 * /usr/bin/tbarchivecdr > /dev/null 2>&1</code>
+|}
+Cron table example for a cdr copy to an external server every 10 minutes with a daily archive of all the transmitted files:
+ */10 * * * * /usr/bin/tbcopycdr > /dev/null 2>&1
+23 * * * /usr/bin/tbarchivecdr > /dev/null 2>&1

TMG:Automatic Text CDR Retrieval: Difference between revisions