Function Detail (for Supporting System Operation and Management)

Monitoring Functions#

hcpd is available to run in foreground. All commands can output debug information (logs in debug level) if you change the level. And you can configure timeouts to detect transport disconnection or idling among operations on the server.

Please be careful of unexpected timeouts from changing the log level to debug since producing many logs makes delays of processing on file transfer on some environment, e.g. computers behind NAT.

Related Option

Command Name	Short Name	Option Name	Description
hcpd	f	foreground	Running in foreground
hcpd/hcp/hsync/hrm/hcp-ls/hmkdir/hpwd/hmv/hln/hchmod/hchown		investigation	Running in investigation mode (deprecated)

Related Configuration

Category	Configuration Name	Description
Server　Configuration	TransportTimeout	Set transport timeout
	IdleTimeout	Set idling timeout
	SystemLog	System log configuration
	SystemLogLevel	System log level
Client Common Configuration	TransportTimeout	Set transport timeout
	ApplicationLog	Application log configuration
	ApplicationLogLevel	Application log level

Performance Evaluation Functions#

This is a function to confirm performances of data processing on sources and network communication. The function is useful for taking benchmarks on your environments and making investigation for causes from which expected performance dose not appears.

Related Option

Command Name	Short Name	Option Name	Description
hcp	N	no-send	Measure disk I/O performance in reading
hcp/hrm	n	no-diskio	Measure network I/O performance with HCP protocol

Related Configuration

Category	Configuration Name	Description
Server Configuration	MemoryTransferConcurrency	Memory copy parallelism (when disabling local disk I/O)
Client Configuration (hcp)	MemoryTransferConcurrency	Memory copy parallelism (when disabling local disk I/O)

Logging Management Functions#

HCP tools provides the following types of logs.

Target	Type	Recorded Content	Initial Configuration	Default Place to Output
Server	System Log	System logs	○	/var/log/hcpd.log(Linux)
				C:/ProgramData/Clealink/HCP Tools/hcpd.log(Windows)
	System Statistics	traffic volume and access status on hcpd daemon running	○	/var/tmp/.hcp.statistics.system(Linux)
				C:/ProgramData/Clealink/HCP Tools/Temp/_hcp.statistics.system(Windows)
	Application Statistics	Run results of application	○	/var/tmp/.hcp.statistics.application(Linux)
				C:/ProgramData/Clealink/HCP Tools/Temp/_hcp.statistics.application(Windows)
	TCP Transport Statistics	traffic and statistics on TCP transport	-	/var/tmp/.hcp.statistics.transport.tcp.service_<service_num>.<service_port>.thread_<thread_num> (Linux)
				C:/ProgramData/Clealink/HCP Tools/Temp/_hcp.statistics.transport.tcp.service_<service_num>.<service_port>.thread_<thread_num>(Windows)
	HpFP Transport Statistics	traffic and statistics on HpFP transport	-	/var/tmp/.hcp.statistics.transport.hpfp.service_<service_num>.<service_port>.thread_<thread_num>(Linux)
				C:/ProgramData/Clealink/HCP Tools/Temp/_hcp.statistics.transport.hpfp.service_<service_num>.<service_port>.thread_<thread_num>(Windows)
	File Operation Log	File operation logs	-	/var/log/hcpd.file.operation.log(Linux)
				C:/ProgramData/Clealink/HCP Tools/hcpd.file.operation.log(Windows)
Client	Application Log	Application logs	○	stdout
	Application Statistics	Run results of application	○	<user_curdir>.hcp.statistics.application(Linux)
				<user_curdir>_hcp.statistics.application(Windows)
	TCP Transport Statistics	traffic and statistics on TCP transport	-	<user_curdir>.hcp.statistics.transport.tcp(Linux)
				<user_curdir>_hcp.statistics.transport.tcp(Windows)
	HpFP Transport Statistics	traffic and statistics on HpFP transport	-	<user_curdir>.hcp.statistics.transport.hpfp(Linux)
				<user_curdir>_hcp.statistics.transport.hpfp(Windows)

* On Unix platforms, HCP tools also output logs from syslog subject to its system configuration.

* As other forms of recording running results, it save a running result of a command to a specific file (.hcp.out on Linux and _hcp.out on Windows). This file is overwritten when each command runs. So the file dose not hold records before the current run.

HCP tools provides the following logging management functions for each type of logs.

Destination to Output Logs
You can specify a destination to output logs by changing configuration files of a server and client or using command options.
If you use the command options, you can specify the destination each command execution. The options are 'log-file' and 'stat-log-file' except for hsync. For hsync, 'hcp-log-file' and 'hcp-stat-log-file' are provided as identical options for them.
Log Level
You can set a log level to logs HCP tools produces. It can be chosen from EMERG, ALERT, CRIT, ERR, WARNING, INFO and DEBUG that are subject to the Severity of Syslog.
Log Rotation
For each log, you can specify log rotation subject to threshold of a file size or date and time.

Related Option

Command Name	Short Name	Option Name	Description
hcpd	l	log-file	Set file path to save system logs
	L	stat-log-file	Set base path to save statistics
hcp/hrm/hcp-ls/hmkdir/hpwd/hmv/hln/hchmod/hchown/hchown		log-file	Set file path to save application logs
		stat-log-file	Set base path to save statistics
		hcp-out	Set file path to save running records
		multi-run	Run in multi-running mode
hsync	v	verbose	Set verbosity of logs
		info	Set categories of logs for INFO level
	q	quiet	Set suppressing logs except for errors
		log-file	Specify a log file
		hcp-log-file	Specify a log file for HCP logs
		hcp-stat-log-file	Specify a path of logging HCP statistics
		hcp-out	Specify a path to save HCP running records
		multi-run	Run in multi-running mode

Related Configuration

Category	Configuration Name	Description
Server Configuration	SyslogOption	Set syslog option
	SyslogFacility	Set syslog facility
	SystemLog	System log configuration
	SystemLogLevel	System log level
	ApplicationStatLog	Application statistics configuration
	TransportStatLog	Transport statistics configuration
	SystemStatLog	System statistics configuration
	FileOperationLog	File operation logging configuration
	StatLogPerUserInPrivilegeSeparation	Save statistics logs to files determined from each user (when privilege separation being enabled)
	ApplicationStatLogSecurityEx	Set to output a security detail on application statistics
Client Common Configuration	ApplicationLog	Application log configuration
	ApplicationLogLevel	Application log level
	ApplicationStatLog	Application statistics configuration
	TransportStatLog	Transport statistics configuration
	ApplicationStatLogSecurityEx	Set to output a security detail on application statistics

Showing Software Information#

This describes functions to show information of the software itself (version), its helps and configuration status decided from configuration files and input parameters.

Normally HCP tools can show the information using the following options on the command line. When showing it at Windows server, you should see the log file for the information.

Related Option

Command Name	Short Name	Option Name	Description
hcpd/hcp/hsync/hrm/hcp-ls/hmkdir/hpwd/hmv/hln/hchmod/hchown	V	version	Display the application version
hcpd	t	config-test	Display configuration and input parameters
hcp/hsync/hrm/hcp-ls/hmkdir/hpwd/hmv/hln/hchmod/hchown		config-test	Display the configuration and input parameters
hcpd/hcp/hsync/hrm/hcp-ls/hmkdir/hpwd/hmv/hln/hchmod/hchown	h	help	Show command help

System Run-Time Configuration#

For smooth operation on your system, various options, e.g. path of configuration files, PID file's specification, license key specification and signals to stop, are provided.

Related Option

Command	Short Name	Option Name	Description
hcpd	c	config-file	Set file path of configuration
	p	pid-file	Set file path to save PID
	k	license	Set file path holding license key
	q	quit	Send signal to stop
hcp/hsync/hrm/hcp-ls/hmkdir/hpwd/hmv/hln/hchmod		config-file	Set file path of configuration
		config-option	Make configuration from command line

CPU Thread Limitation

This function limits a number of threads that will be running on the process of the software.

Related Configuration

Category	Configuration Name	Description
Server Configuration	MaxConcurrentThread	Limit number of threads to use (Linux)
Client Common Configuration	MaxConcurrentThread	Limit number of threads to use (Linux)

Cooperation with External Application

This is a function to call a script (or program) when running each command of the software is finished.

Related Configuration

Category	Configuration Name	Description
Server Configuration	CallbackScript	Specify a script to call when running a command is finished

Manipulation of Files and Directories#

You can make the following manipulation to files and directories on the server.

Delete
List
Create Directory
Print Working Directory
Move
Create Link
Change File Permission
Change Owner and Group

Related Commands

Command Name	Description
hrm	Remove files
hcp-ls	List files
hmkdir	Create directories
hpwd	Print the working directory
hmv	Move files
hln	Create links
hchmod	Change file permissions
hchown	Change owner and group of files