collective.warmup 1.2

Why not a simple bash script?

While the basic use case is very simple, collective.warmup offers the following extra features:

• Verifies the correctness of the response body (e.g. contains a certain string)

• Can operate in crawl mode, following links in pages to warm up all related pages

• Can filter out certain urls according to a general definition

Dependencies

• lxml

Manual installation

To install it (using virtualenv, on a GNU/Debian machine):

$ sudo apt-get install build-essential python-dev python-lxml python-virtualenv libxml2-dev libxslt1-dev
$ virtualenv warmup && cd warmup && souce bin/activate
(warmup) $ pip install collective.warmup

and launch it with:

(warmup) $ bin/warmup <path/file.ini>

Alternative installation with buildout

To integrate collective.warmup in a buildout with Plone, add this to your configuration:

[buildout]
...
parts =
    ...
    warmup


[instance]
...
eggs +=
    collective.warmup


[instance]
environment-vars +=
    WARMUP_BIN ${buildout:directory}/bin/warmup
    WARMUP_INI ${buildout:directory}/warmup.ini
    WARMUP_HEALTH_THRESHOLD 50000


[warmup]
recipe = zc.recipe.egg:scripts
eggs = collective.warmup

After executing the buildout you will find the warmup script in the bin directory.

In this example, the script will be executed automatically by the Zope instance each time it is started.

Configuration file

This is a sample warmup.ini configuration:

[warmup]
enabled = True
sleep = 2
base_url = http://localhost
logfile = /path/to/warmup.log

urls =
    Home page


[config]
max_attempts = 2
base_path = mysite


[Home page]
path = ${config:base_path}/
max_attempts = ${config:max_attempts}
check_exists =
    Welcome
check_not_exists =
    p0wned by
follow_links = True
ignore_middle =
    @@
    ++theme++
    #
    ?
ignore_end =
    .css
    .js
    .png
    .jpg
    .jpeg
    .gif
    .xml
    RSS
    .ico

Options

Health check

In order not to mark backend healthy too early by the load-balancer, before proper warmup, this package defines a browser view called @@health.check which can be used within your load-balancer probe mechanism. See bellow a Varnish configuration example:

backend instance_1 {
    .host = "localhost";
    .port = "8081";
    .probe = {
         .url = "/health.check";
         .interval = 5s;
         .timeout = 1s;
         .window = 5;
         .threshold = 3;
     }
}

This way Varnish will mark the Zope instance backend healthy when ZODB cache-size is bigger than WARMUP_HEALTH_THRESHOLD. If you do not define the WARMUP_HEALTH_THRESHOLD environment variable, the Zope instance backend will be marked healthy as soon as Zope will be able to handle requests.

Credits

1.2 (2016-09-08)

• Check for write permissions within logfile and fallback to a temporary file if can’t write instead of sys.exit [avoinea]

• Add @@health.check browser view to be used with load-balancer health-check in order not to mark backend healthy too early before proper warmup. [avoinea]

• Avoid zombie processes. [jone]

• Add zcml:condition for Plone 3 compatibility [gborelli]

1.1 (2014-07-18)

• Python 2.4 support [gborelli]

1.0 (2014-04-06)

• First release