Document toolboxDocument toolbox

Recovered Components

Owned by Jason Andrew
Sept 17, 2024
2 min read

In the template below, <instance> is the OS user (account) under which ServiceOptimizer is running.

If the system monitor restarts a component (or finds that it has itself been restarted), it will first move all the component log files (including optimizer log files) from the previous incarnation of that component into a subdirectory of the directory containing the logs:

$<SPHOME>/<instance>/log/recovery
The base name of the file will be altered so it's identified as a recovery file and also identified with the date and time of recovery by the master system monitor. The file is renamed

from: <prefix>.log
to: <prefix>.recovered.<datetime>.log

 Archived Log Files

ServiceOptimizer can be configured to move all the files from a run of an instance to a specified location. 
If this is enabled then when a ServiceOptimizer instance starts, all the files for the previous run are moved to: 
<archive directory>/<timestamp> 
Where

  • <archive directory> is by default <SPHOME>/<instance>/archive. SPHOME is local to the running application: in a distributed server it is usually local to the host on which the application is running.
  • <timestamp> is taken from the time at which the ServiceOptimizer instance was previously started and is in the format YYYYMMDDHHMMSS.


Optionally, a specific <archive directory> can be configured in sp083_system_parameters value "mon_archive_dir". This can be any network location that is visible from every host in the ServiceOptimizer instance. In a distributed server, this allows all ServiceOptimizer application log files to be archived at a single, shared location instead of on each host. If this specified <archive directory> is inaccessible then the default <archive directory> is used instead. 
Alternatively, an <archive directory> can be configured specific to a host, in Database sp416_host_machines. If the host-specific <archive directory> is inaccessible then the global <archive directory> is used instead. 
The sp083_system_parameters value mon_pci_archive_timeout must be set to take account of the time that may be required to archive the application logs – in particular if the <archive directory> is not local (see WARNING below). See  Mandatory System Parameters below for more information on this parameter.

WINDOWS ONLY 
If ServiceOptimizer is started as a service when the computer boots, network drive mapping might not be available to System Monitor when archiving application log files. In this case archive locations should not be specified by mapped drives (e.g. "L:\archive") but instead must be specified in UNC format (e.g. "\\sp-inst1\archive").

WARNING: If the <archive directory> is not local then the speed, reliability and traffic on the network connection to the destination must be considered. ServiceOptimizer application logs can be very big and can take considerable time to move across a network. The ServiceOptimizer instance will not start until the archiving process is complete and so significant delays can be incurred.

Mandatory System Parameters

The following parameters deal with the archiving of logfiles - see Application Logfiles for further details

ParameterDescription

Application logfile control

mon_archive_dir

Directory (folder) under which ServiceOptimizer application log files are archived.

mon_archive_logs

Determines whether logs from previous runs of the server will be saved. 'YES' will save logs, 'NO' will not.

mon_pci_archive_timeout

Time in seconds to wait for remote archiving to complete. 

In a distributed ServiceOptimizer instance, archiving could take a long time. The command sent from the master System Monitor to the slave System Monitor to trigger archiving on the slave has this specific reply timeout (used instead of mon_pci_command_timeout). 

Note that this parameter must be greater than or equal to the value for mon_pci_command_timeout or the System Monitor will not start.