General Settings

This section contains description of all settings of Cache Warmer, except FPC Hole Punch, which has its own section.

They all are located at System -> Page Cache Warmer -> Settings, and divided into the following sections:

  • General - provides means for basic warming configuration.
  • Performance - allows you to tune-up performance bottlenecks.
  • Extended Settings - additional settings, that allow you to improve load balancing.
  • Debug - settings, that will provide you with additional information about cache problems.

General section

  • Enabled - enables full page cache warmer.
  • Warm pages by - strategy for warming pages. Two possible option are possible:
    • Popularity - crawler should cache popular pages first.
    • Page Type - crawler should cache pages according to additional option table with the following columns (drag and drop rows to define order):
      • Page Type - type of store pages (Catalog · Product · View, Catalog · Category · View, etc).
      • Status - a checkbox, which defines, whether this type of pages should be cached.
  • Ignored Pages - allows to set, which pages should be ignored by Cache Warmer. Consists of one or more records, where Expression contains regular expression.

    Example

    • /\?/ - ignore all pages, that have GET params (filtered category pages, search results pages, etc.).
    • /\?[\w]*&[\w]*&[\w]*/ - ignore pages with more than 2 GET params.

    Read more about regular expression here.

Performance section

This section will help you to tune-up our Cache Warmer crawler. It starts on cron schedule and begins to traverse list of URLs:

  • If URL is already cached, it is skipped;
  • If URL is not in the cache, crawler will visit it, to make it cached.

To adjust its work, you can use the following options:

  • Threads - the number of concurrent (parallel) requests to the store.
  • Delay between requests - delay between requests in milliseconds (1000 ms - 1 s).
  • Maximum job run time - maximum time allowed for one job run in seconds.
  • Job Schedule - Cron expression for schedule warmer jobs. Read more about setting Cron expressions here.
  • Set Job Label - if this option set to Yes, crawler builds list of URL, and on end of crontask, marks URL's that were actually visited. Subsequent crontask will start checking pages from last marked URL, thus reduce list to check whether page is cached.
  • Frequency for Job Label Update - used, when previous setting is enabled. This option defines, when visited mark should expire. When crawler reviews URL list, it clears all marks with timestamps, older than selected period. This way our crawler can renew cache for refreshed or even dropped pages. There are the following possible periods:
    • Once per hour - the shortest option, which made labels expire in an hour. Default value.
    • Every XX hour - where XX is hours from 2 to 24. These options allow you to balance label expiring.

Note

If cache is cleaned frequently, it's better not to use Set Job Label feature at all.

Extended Settings section

  • Don't run warmer job if average system load more than (%) - If average system load exceeds value in this field, warmer jobs won't' start. Average system load graph can be seen at SYSTEM->Page Cache Warmer -> Jobs. Read more in this FAQ section.
  • Crawler limit - Crawler will stop crawling when quantity of URLs in cache reaches this value.
  • Forbid cache flushing - completely disables flush FPC cache. Read more in this FAQ section.

Debug section

  • Show cache status - show block with info whether the page is in the cache in the frontend (it does not work for Vrnish).
  • Hole punch info - show hint for 'hole punched' blocks. Read more in this section.
  • Show cache status and hole punch info only for - сomma separated IP addresses, for which info box should be visible.
  • Log tags for cache flushing - record all cache flushes at /var/log/clean.log
  • Log backtrace for cache flushing - put backtrace for cache flushes to the /var/log/clean.log. For more info on this and previous setting, read more in this FAQ section.