Client Documentation
3.10. Transfer monitorΒΆ
SFTPPlus client transfer monitor is provided as an external tool to monitor blocked or erroneous transfers.
Note
Transfer monitor is only available for Linux and Unix operating system.
While executing a transfer the SFTPPlus client will write various auxiliary files in a temporary folder. The transfer monitor uses these files for deciding whether a transfer has entered an erroneous state.
The monitor can be used for detecting the following error types:
Stalled transfers
- Transfers for which the server is not sending any for a long time.
- Transfers for which the server is not receiving any data for a long time .
Infinite loop error recovery state.
- Transfer for which the client acknowledge the sending or receiving of data and the server continue to send or receive erroneous data.
Transfer monitor is implemented as a shell script. When changing the configuration variables you will need to use the following syntax:
VARIABLE_NAME=new value
Note
There should be no space characters between the variable name and the equal sign VARIABLE_NAME =new value is not a correct variable definition.
The available configuration variables are described below:
- SFTPPLUS_FOLDER
Base installation folder.
This is the folder in which the SFTPPlus client is installed.
- MONITORED_FOLDER (Default value: ${SFTPPLUS_FOLDER}/tmp)
Full path to the folder used for storing auxiliary transfer files.
On standard installation this is the tmp folder.
- MONITOR_INTERVAL (Default value: 10)
- This option specifies the frequency in seconds at which files are checked for new state.
- BLOCKED_COUNT=3
This option specifies the number of monitored intervals after which an unchanged transfer is considered blocked. This should be a positive integer number.
For the case when the transfer monitor is configured with MONITOR_INTERVAL=10 and BLOCKED_COUNT=3, a transfer will be considered blocked after 30 seconds of inactivity.
- MAXIMUM_SIZE=10000
This options defined the maximum file size in bytes for an auxiliary file.
If a transfers create an auxiliary file greater than maximum result file, the transfer will abort since there is a risk of using all disk space and this is a sign that the transfer entered an infinity loop state.
- LOG_FILE (Default value: ${SFTPPLUS_FOLDER}/transfer_monitor.log)
- The SFTPPlus Client transfer monitor uses a separate file for logging its actions and current state. This options specifies the full path to the file used for storing log entries.
- PID_FILE (Default value: ${SFTPPLUS_FOLDER}/transfer_monitor.pid)
- The transfer monitor runs as an Unix background service (daemon). Upon execution the transfer monitor will write its process id (PID) inside a configuration files. The process id can be later used for closing the monitor or checking if the process is still running.
- DEBUG (Default value: 0)
Set to 1 to enable debug log entries or 0 to disabled them.
Debug entries provide addition information which are not required when executed in a regular production environment.