/ 
Helios-2.71_4350
River stage one • 5 direct dependents • 5 total dependents
/ helios.pl

NAME

helios.pl - Launch a daemon to service jobs in the Helios job processing system

SYNOPSIS

# Make sure HELIOS_INI is set and exported.  Optionally enable debug mode.
export HELIOS_INI=/path/to/helios.ini
[export HELIOS_DEBUG=1]
# Full command line options 
helios.pl [--service=<service class>] [--jobtypes=<jobtypename,jobtypename>] \
[--clear-halt] [--version] [--help]

# Simple cmd line example: start a daemon with the Helios::TestService service.
helios.pl Helios::TestService

# More complex: start a Helios::TestService daemon, but have it run MyService jobs.
helios.pl --service=Helios::TestService --jobtypes=MyService

# Just prints version info.
helios.pl --version

# Prints this help page.
helios.pl --help

DESCRIPTION

The helios.pl program, given a Helios service class, will launch a daemon to service Helios jobs of that class. The number of worker processes to run concurrently and various other parameters are set via a helios.ini file and the Helios collective database (the connection information of which is also defined in helios.ini).

Under normal operation, helios.pl will attempt to load the service class specified on the command line and use it to read the contents of the helios.ini file. If successful, it will attempt to connect to the Helios collective database and read the relevant configuration parameters from there. If that is successful, helios.pl will daemonize and start servicing jobs of the specified class. If additional jobtypes are specified with the --jobtypes option, jobs of those additional types will also be serviced by the loaded service class.

In debug mode (set HELIOS_DEBUG=1), helios.pl will not disconnect from the terminal, and will output extra debugging information to the screen and the Helios log. It will also enable debug mode on the service class, which may also support the output of extra debugging information if you so choose.

If the --clear-halt option is specified, helios.pl will attempt to remove a HALT parameter specified in the Helios configuration for the specified service on the current host. This is helpful if you shutdown your Helios service daemon using the Helios::Panoptes Collective Admin view. Note that it will NOT remove a HALT specified globally (where host = '*').

HELIOS.INI

The initial parameters for helios.pl are defined in an INI-style configuration file typically named "helios.ini". The file's location is normally specified by setting the HELIOS_INI environment variable before helios.pl is started.

A helios.ini file normally contains a [global] section with the parameters necessary to connect to the Helios collective database, and any parameters local to the host on which the Helios service is currently running. In addition, each service class may have its own section in helios.ini containing parameters specfic to that service on that host.

Example helios.ini:

[global]
dsn=dbi:mysql:host=10.1.0.21;db=helios_db
user=helios
password=password

[LongRunningJobService]
master_launch_interval=60
zero_launch_interval=90

[AnotherService]
OVERDRIVE=1
MAX_WORKERS=3

Helios.ini Parameters for helios.pl

This section just covers the basic config options for helios.pl. For a complete list of built-in Helios config options, consult the Helios::Configuration man page.

Configuration options to place in the [global] section:

These options will be the same for all Helios services running a host that share the same collective database, so these options must be placed in a helios.ini section named [global] so they are visible to all running helios.pl instances.

dsn [REQUIRED]

Datasource name for the Helios parameter database. This will also contain the data structures for the underlying TheSchwartz queuing system.

user [REQUIRED]

Database user for the datasource name described above.

password [REQUIRED]

Database password for the datasource name described above.

pid_path

The location where helios.pl should write the PID file for this service instance. The default is "/var/run/helios". The name of the PID file will be a variation on the service class's name.

Configuration options to place in individual service sections:

The options listed in this section are available to tune helios.pl to work better with your Helios service class and the jobs it wants to service. These are read at startup and, unlike other Helios config options, cannot be dynamically changed while helios.pl is running. If you wish to tune one of these parameters, reset the parameter and restart the service daemon.

master_launch_interval

Set the master_launch_interval to determine how long helios.pl should sleep after launching workers before accessing the database to update its configuration parameters and check for waiting jobs. The default is 1 second, which should be sufficient for most applications.

zero_launch_interval

Set the zero_launch_interval to determine how long helios.pl should sleep after reaching its MAX_WORKERS limit. The default is 10 sec. If jobs are running long enough that helios.pl is frequently hitting is MAX_WORKERS limit (there are waiting jobs but helios.pl can't launch new workers because previously launched jobs are still running), increasing the zero_launch_interval will reduce needless database traffic.

zero_sleep_interval

Set the zero_sleep_interval to adjust the amount of time between checks for available jobs in the job queue when the job queue is empty. If the helios.pl daemon determines there are no available jobs for a service, it sleeps zero_sleep_interval seconds and then checks for jobs again. The default is 10 sec. If you notice jobs are sitting in the job queue too long before workers are launched to service them, reduce this number to cause jobs to be started faster. If you have a small number of jobs and do not care if they sit in the job queue for a few seconds before being serviced, increase this number to reduce database queries.

HELIOS CTRL PANEL (helios_params_tb)

In addition to helios.ini, certain helios.pl configuration options can be set via the Ctrl Panel or Collective Admin views in the Helios::Panoptes web interface. These configuration options are read by helios.pl from the HELIOS_PARAMS_TB table in the Helios collective database. Though the Ctrl Panel is designed mostly to provide a standardized interface for your service classes to store and retrieve configuration parameters, certain helios.pl control parameters can be set here as well.

For more information on these config options, see the Helios::Configuration man page.

HELIOS OPERATION

After initial setup, the helios.pl daemon will enter a main operation loop where configuration parameters are refreshed, the job queue is checked, and worker processes are launched and cleaned up after. A HOLD = 1 parameter will temporarily cause the loop to pause processing, while a HALT parameter will cause the helios.pl daemon to exit the loop, clean up, and exit.

There are several steps in the helios.pl main operation loop:

  1. Refresh configuration parameters from database.

  2. Check job queue to see if there are jobs available for processing (if not, sleep for zero_sleep_interval seconds and start again).

  3. If there are jobs available, check to see how many worker processes are currently running. If MAX_WORKERS workers are already running, sleep for zero_launch_interval seconds and start again. The zero_launch_interval setting should be long enough to allow at least some of the running jobs to complete (the default is 10 secs).

  4. Subtract the number of currently running workers from MAX_WORKERS and launch that many workers to handle the available jobs. If MAX_WORKERS is 5 and only 2 workers are running, that means the helios.pl daemon will launch 3 workers. If there are less than MAX_WORKERS jobs available for processing, only 1 worker will be launched to reduce job contention between workers in the collective.

  5. Sleep master_launch_interval seconds and start the operation loop again.

SUBROUTINES

PROCESS CONTROL FUNCTIONS

daemonize()

The daemonize() function is called to turn the Helios program into a daemon servicing jobs of a particular class. It forks a new process, which disconnects from the launching terminal.

Normally, daemonization would also include setting up signal handling, but the daemonize() function isn't called in debug mode, so signal traps are actually set up in the main program.

double_clutch()

The double_clutch() function implements the WORKER_MAX_TTL functionality. If the WORKER_MAX_TTL parameter is set for a service, the service daemon periodically calls double_clutch() to check the workers and clean up any that have run too long. The double_clutch() function waits a certain amount of time (WORKER_MAX_TTL_WAIT_INTERVAL secs), then checks the amount of time each of the running workers has been active. If a worker has been running longer than the service's WORKER_MAX_TTL, the worker is killed (by sending it a SIGKILL signal).

launch_worker()

#[] fix this POD - Helios::TS not TheSchwartz

The launch_worker() function launches a new worker process. After the fork() from the main process, the new child process will call launch_worker(). The launch_worker() function will instantiate a new TheSchwartz object, set the object's ability (TheSchwartz term) to the class of the loaded service, and starts the worker on its way by calling the work() method. If the OVERDRIVE run mode is enabled for the service, the work_until_done() method is called instead.

SIGNAL HANDLERS

reaper()

The reaper() function is responsible for cleaning up after dead child processes. It's called when helios.pl receives a SIG_CHLD signal. The function reaps any children with waitpid(), removes the children's PID from the $workers hash of running workers, and re-establishes itself as the signal handler for the next SIG_CHLD signal.

terminator()

The terminator() function is responsible for shutting down a Helios service instance when helios.pl receives a SIGTERM signal. The shutdown process performs several steps:

  • Sets HALT in the Helios config params for the loaded service, so the worker processes know to exit at the end of their current job

  • Sleeps a certain amount of time (zero_launch_interval x 2 secs) to allow worker processes to complete the jobs they are processing and exit

  • Reaps any ended worker processes, and forcably kills any that are still running. After zero_launch_interval seconds, workers for a particular service should have exited if HALT is set. If you use this method of shutting down Helios services and repeatedly see a particular service's workers not exiting properly, increase the value of the zero_launch_interval configuration parameter for that service in your helios.ini or Helios::Panoptes Ctrl Panel.

  • Clears the HALT parameter set earlier, since all of the workers are now shut down (one way or the other).

  • Removes the service's PID file written in the pid_path set in helios.ini

  • Unregister's with the Helios collective's registry table in the Helios database

  • Issues a final log message indicating the loaded service has shut down on the current host

Once all these steps are complete, the helios.pl program exits.

PID FILE FUNCTIONS

write_pid_file($pid_path)

Writes a PID file to a location (defaults to /var/run/helios) to track which daemons are running. The file will be named after the service class running, all lowercase, with colons replaced by underscores. For example, the PID file for a service class named 'SearchIndex::LoadTestWorker' will be named "searchindex__loadtestworker.pid". To change the location where the PID file is created, set the pid_path option in helios.ini.

The running_process_check() function should be run before this function to exclusively lock the PID file.

remove_pid_file($pid_file)

During a clean shutdown, remove_pid_file() is called to delete the PID file associated with the service daemon.

running_process_check($pid_path)

Given the pid_path, check to see if a $pid_file for the loaded service class exists and, if it does, check to see if that process is still running. If the file doesn't exist or it does but isn't running, this function returns 0. If the process is still running, record the error and return the running process's pid to signal that service startup should halt.

If the PID file does not exist, running_process_check() creates it. The PID file is then exclusively locked to prevent other daemons for the same service from writing to it. This helps ensure multiple Helios daemons for same service will not start up at the same time.

OTHER FUNCTIONS

clean_shutdown()

The clean_shutdown function is called when helios.pl is intentionally shutdown (setting a HALT parameter in the Helios::Panoptes Ctrl Panel or sending the helios.pl process a TERM signal). It removes the PID file created on startup and unregisters the service instance from the collective database.

register()

The register() function records information about the currently running worker daemon in the database. The register() function is designed to be run every $REGISTRATION_INTERVAL seconds. That way, if a service daemon dies off unexpectedly (without calling unregister()), it can be determined that something has happened to the daemon and it possibly needs to be restarted.

(In reality, register() and unregister() are only necessary to provide a display for Panoptes, to more easily assess system status and facilitate the HALTing of service daemons or HOLDing of job processing.)

unregister()

The unregister() function removes any record of the currently running daemon from the database. It is called whenever there is a clean shutdown.

set_halt()

Set a HALT parameter for the currently loaded service on the current host to signal to all of the worker processes that they need to exit. This function is used by the terminator() function to safely signal to workers they need to exit when the current job is completed.

clear_halt()

If the --clear-halt option is specified on the command line, clear_halt() is called to attempt to clear the HALT parameter in the HELIOS_PARAMS_TB. For safety reasons, it only clears a HALT for the loaded service class AND the specific host helios.pl is running on; it will not clear a global HALT parameter (where the host is specified as '*').

workers_to_launch($waiting_jobs, $running_workers, $max_workers)

SEE ALSO

Helios, Helios::Tutorial, Helios::Service, Helios::Configuration

AUTHOR

Andrew Johnson, <lajandy at cpan dotorg>

COPYRIGHT AND LICENSE

Copyright (C) 2007-9 by CEB Toolbox, Inc.

Portions of this software, where noted, are Copyright (C) 2012-2013 by Logical Helion, LLC.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.0 or, at your option, any later version of Perl 5 you may have available.

WARRANTY

This software comes with no warranty of any kind.