You can manually configure the maintenance utility by editing the configuration file for the utility.
To configure the maintenance utility, you edit the file /usr/local/ctccap/etc/runtime.conf
, and add lines that assign values to variables.
Lines that contain a pound sign ("#") at the beginning of the line are comments and are ignored by the maintenance utility.
A variable assignment must be a single line in the following format:
variable_name="value"
The following list documents the configuration variables, their default values (if unspecified in file runtime.conf
), and their meanings.
Several are Boolean values that must either be YES
or NO
.
Capture health check
capture_health_capture_packets_dropped_in_output_high_threshold="50000"
If the capture statistics Packets dropped in output
is above this value, capture is unhealthy. This value is high when capture cannot reassemble hits as fast as they are captured off the network interfaces.
capture_health_enable="YES"
Enables capture health checks. This check is enabled by default to monitor the health of the capture processes.
capture_health_reassd_pct_cpu_high_threshold="90"
If the hit reassembly process uses more than 90% of the CPU, capture is unhealthy.
capture_health_reassd_virtual_size_high_threshold="1024000"
If the hit reassembly process uses more than the specified number of kilobytes (1,024,000 kilobytes is approximately 1 gigabyte), capture is unhealthy.
capture_health_schedule_minutes="5"
The number of minutes between health checks.
Capture restart
capture_restart_enable="NO"
Forces capture to restart at a specific time each day or weekly, on a specified day of the week. This check is disabled by default because the utility does not know a safe or low traffic volume time to force a restart. To enable it, assign it a value of YES
and set the capture restart time in the following property.
capture_restart_time_local="00:30"
Restart capture at the specified local time (by using a 24-hour clock). If you want to restart capture at 11:30 PM, use value "23:40". Do not include the leading zero if the hours is less than 10. For example, to specify 6:30 AM, use value "6:30".
capture_restart_weekday_local (no default)
Restart capture on the specified day of the week at the time that is specified by variable capture_restart_time_local. The value must be one of the following (all lowercase): sunday
, monday
, tuesday
, wednesday
, thursday
, friday
, Saturday
.
Restart capture on the specified day of the week at the time that is specified by variable capture_restart_time_local. If you specify this value, then the forced restart occurs on the specified day at the specified time. If you do not set this variable (the default), forced restarts occurs every day at the time specified.
Debugging
maintenance_debug_enable="NO"
Enables verbose logging of settings and execution. This option exists to help diagnose the behavior of the maintenance utility. It results in lots of output in the maintenance.log
file and must be used only when needed.
Log file cleanup
logfile_cleanup_enable="YES"
Enables log file cleanup.
logfile_cleanup_keepdays="14"
- Keep log files for the specified number of days. Log files older than the specified number of days is deleted.
- The log files that are monitored by the maintenance utility contain a date in the file name in the format <Year><Month><Day>, such as
20050601
for June 1, 2005. - The utility uses the date that is extracted from the file name, not the date, and time of the file that is maintained by the operating system.
logfile_cleanup_keepsize_kb="5120"
- Keep log files smaller than the specified number of kilobytes. The default value keeps log files smaller than approximately
5
megabytes. - Files larger than this size are deleted. The goal of this setting is to prevent large files from accumulating on the Passive Capture host machine.
logfile_cleanup_schedule_minutes="30"
The number of minutes between checks for cleaning up log files.
Statistics logging
statistics_logging_enable="YES"
Enables statistics logging. When enabled, the maintenance utility creates CSV files in directory /usr/local/ctccap/logs
with the name statistics_YYYYMMDD.log
, where YYYYMMDD
is the current year, month, and day, such as statistics_20050602.log
.
statistics_logging_schedule_minutes="1"
The number of minutes between statistics logging.
Time synchronization
timesource_sync_enable="NO"
- Enables time synchronization with a Tealeaf CX server that is running the Transport Service.
- The configuration values for the host and port of the Transport Service in file
/usr/local/ctccap/etc/ctc-conf.xml
and are normally assigned through the Delivery tab on the web console. - When the configuration values for the host and port are specified, the maintenance utility enables this feature by default. Otherwise, the maintenance utility disables time synchronization.
timesource_sync_schedule_minutes="15"
The number of minutes between time synchronizations.