README.txt
Search API
- 6.x README.txt
- 6.x modules/tinymce/README.txt
- 6.x modules/student_files/README.txt
- 6.x modules/batch/README.txt
- 6.x modules/lassie/README.txt
- 6.x modules/prereqs/README.txt
- 6.x themes/how_to_customize/README.txt
- 6.x modules/encryption/README.txt
- 6.x custom/files/README.txt
- 4.x README.txt
- 4.x modules/tinymce/inc/tiny_mce/plugins/style/readme.txt
- 4.x modules/tinymce/README.txt
- 5.x README.txt
- 5.x modules/tinymce/README.txt
- 5.x modules/batch/README.txt
- 5.x themes/basic/README.txt
- 5.x inc/pchart/README.txt
- 5.x inc/pchart/pchart/readme.txt
- 5.x modules/tinymce/inc/tiny_mce/plugins/style/readme.txt
Lassie ======================== Richard Peacock (flightpathacademics.com) DESCRIPTION The Lassie modue is meant to be used by module and routine developers, to monitor long-running jobs and to make sure they finish within the expected amount of time. If a job doesn't finish, Lassie will email an admin user to warn them. This module is very useful for making sure a nightly routine finished without errors. REQUIREMENTS In order to function correctly, you should set your site's cron to run at least once per hour. USE In your code, "start" a job for Lassie to monitor like so: lassie_start($job_name, $hours, $emails); * $job_name must be a machine name (no spaces or unusual characters) unique to this job. * $hours is an INTEGER (whole number-- no decimals) which tells Lassie how long we *expect* the job to take to run. If we do not finish within this number of hours, the email addresses will be notified. * $emails is an optional list of emails addresses (separated by comma) to notify if the job fails to end by $hours. To tell Lassie that you have finished the job, always end your routine with: lassie_finish($job_name);
File
modules/lassie/README.txtView source
- Lassie
- ========================
- Richard Peacock (flightpathacademics.com)
-
-
- DESCRIPTION
-
- The Lassie modue is meant to be used by module and routine developers,
- to monitor long-running jobs and to make sure they finish within the expected
- amount of time.
-
- If a job doesn't finish, Lassie will email an admin user to warn them.
-
- This module is very useful for making sure a nightly routine finished without errors.
-
-
- REQUIREMENTS
- In order to function correctly, you should set your site's cron to run at least once per hour.
-
-
-
- USE
-
- In your code, "start" a job for Lassie to monitor like so:
-
- lassie_start($job_name, $hours, $emails);
-
- * $job_name must be a machine name (no spaces or unusual characters) unique to this job.
-
- * $hours is an INTEGER (whole number-- no decimals) which tells Lassie how long we *expect* the job to take to run. If we do not finish
- within this number of hours, the email addresses will be notified.
-
- * $emails is an optional list of emails addresses (separated by comma) to notify if the job fails to end by $hours.
-
-
- To tell Lassie that you have finished the job, always end your routine with:
-
- lassie_finish($job_name);