MageBees a Venture by Capacity Web Solutions Pvt. Ltd. Support Ticket:- https://support.magebees.com , Support Email:- [email protected] Full Page Cache Warmer Extension for Magento 2 User Manual Full Page Cache Warmer Extension for Magento 2 By
MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Full Page Cache Warmer Extension for Magento 2
User Manual
Full Page Cache Warmer Extension for Magento 2
By
Full Page Cache Warmer Extension for Magento 2 By MageBees
2 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
CONTENT
Introduction 3
Features 3
Configuration Settings 4
Manage Warmer Queue From Command Line 15
Manage Warmer Queue From Backend 16
Warmer Log 17
Warmer Performance Reports 18
Frontend Snapshots 19
FAQs 22
Support 23
Full Page Cache Warmer Extension for Magento 2 By MageBees
3 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
INTRODUCTION
In Magento 2, the store cache is frequently cleared due to several reasons like page content
updates, cache lifetime expiration etc. Therefore, It is required to timely cache all necessary
pages and provides customers with the ultimate shopping experience with our extension
which automatically warms the cache and ensures fast pages load.
This extension provides the facility to generate and process the warm page queue from the
admin section, by the Cron job or using a command line. With this extension, newly created
and updated pages automatically added to the warmer queue. Keep track of all cache
warming processes with a detailed log and visual reports.
EXTENSION FEATURES
1. Easy to install and admin can disable extension from backend. 2. Provide the functionality for auto-generate warmer queue after a cache clean and
flush 3. The warmer queue will be automatically updated on add/update of product,
category or CMS pages. 4. Provide the facility to choose warmer queue generation source like from sitemap
XML file, text file, different page type and priority or popular pages. 5. You can set the queue generation and warmer schedule for Cron job as per your
time. 6. You can set the batch size for the warmer queue process so server load will be
reduced. 7. You can set the Cron maximum run time and maximum queue size. 8. You can set the regular expressions to exclude pages from the warm-up queue. 9. With page combinations feature, each link from the queue will be warmed with all
possible combinations based on the selected customer groups, stores and currencies.
10. Provide HTTP authentication while crawl page url. 11. Display the cache status for frontend page url. 12. Keep track of all cache warming processes with a detailed log and visual reports. 13. You can generate and process the warm page queue from the admin section, by the
Cron job or using a command line.
Full Page Cache Warmer Extension for Magento 2 By MageBees
4 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
CONFIGURATION SETTINGS
Step-1
Go to admin → STORES → Configuration → MAGEBEES → Full Page Cache Warmer.
You will get the following screen.
Full Page Cache Warmer Extension for Magento 2 By MageBees
5 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Step-2
Click on Settings Tab. You will get the following screen.
Enabled: You can able to enable or disable this module from choosing Yes/No.
Auto Generate Queue after Cache Flush: With this option, you can automatically generate warmer queue after cache flush/clean. Select “No” to disable this functionality.
Auto Update warmer queue when product changes: With this option, updated or newly created product page, category page and CMS page url will automatically be added to the warmer queue.
Full Page Cache Warmer Extension for Magento 2 By MageBees
6 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Step-3
Click on Queue Generation Source Settings Tab.
Queue Generation Source: With this option, you can select the source for generating
warmer queue.
This will provide the below mention queue generation source.
Pages Types
o If you select “Page Types” from “Queue Generation Source” configuration
option, then you will get the following screen.
o You can choose the pages which you want to warm-up. You can set the priorities
of the pages by drag and drop them.
Full Page Cache Warmer Extension for Magento 2 By MageBees
7 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Sitemap XML
o If you select “Sitemap XML” from “Queue Generation Source” configuration
option, then you will get the following screen.
o With this option, you can add the sitemap XML file url to warm-up queue.
o For this, you require valid sitemap XML file on your Magento2 root directory or you
can also set the relative path to XML file.
o You can also add multiple sitemap XML files with comma-separated. Here both
XML file located on Magento2 root directory so you can add as shown in below
example.
Example: sitemap.xml,sitemap_new.xml
Text file with one link per line
o If you select “Text file with one link per line” from “Queue Generation Source”
configuration option, then you will get the following screen.
o With this option, you can use the custom text file which contains the list of urls
(one link per line) to be crawled.
Full Page Cache Warmer Extension for Magento 2 By MageBees
8 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Sitemap XML and Text File together
o With this option, you can use both sitemap XML and Text file together for url to
be crawled.
o For this, you have to set the relative sitemap XML file path and text file path.
Popular Pages
o With this option, you can create a warmer queue based on the most popular
pages of your website. Pages are ranked according to the number of visits. The
most popular pages URLs will be at the beginning of the queue and will be
warmed first.
Full Page Cache Warmer Extension for Magento 2 By MageBees
9 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Step-4
Click on Performance Settings Tab. You will get the following screen.
Full Page Cache Warmer Extension for Magento 2 By MageBees
10 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Queue Generation Schedule: With this option, you can set the warmer queue
generation schedule as per your time. You have to enter Cron expression for set the
warmer queue generation Cron job schedule.
Example: You can set like 0 */12 * * to run Cron every twelve hours.
Batch Size: The Cron job processes pages in batches. With this option, you can set
the maximum number of pages that can be processed by Cron within a single run.
Queue Max Size: With this option, you can set the maximum number of page url to
be added to the warm-up queue.
Warmer Schedule: With this option, you can set the warmer queue process schedule
as per your time. You have to enter Cron expression for set the warmer queue
process Cron job schedule.
Example: You can set like */10 * * * * to run Cron every ten minutes.
Delay Between Batch: With this option, you can set the delay between batch (in
seconds) to keep the server load safe.
Cron Max Run Time: With this option, you can set the maximum run time for Cron.
After collapsed maximum run time Cron will be terminated.
Cron On Complete: On completion of Cron, you can choose whether to Cron will be
terminated (stop) or sleep for some time.
Sleep When Empty: When there is no url left to crawl in the warmer queue the Cron
will wait for x seconds. You can set here x seconds.
Exclude Pages: With this option, you can exclude the pages from the warm-up
process by adding regular expression.
Example: p=|price=
In the above example, we have used multiple params which are separated by
pipeline (|) to excluding the pages from the warm-up process. Those url which
contains the params which are set in the configuration is excluded from the warm-up
process.
* * * * *
| | | | |
| | | | +---- Day of the Week (range: 0-6, 1 standing for Monday)
| | | +------ Month of the Year (range: 1-12)
| | +-------- Day of the Month (range: 1-31)
| +---------- Hour (range: 0-23)
+------------ Minute (range: 0-59)
Full Page Cache Warmer Extension for Magento 2 By MageBees
11 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Step-5
Click on Page Combinations Tab. You will get the following screen.
This will check all possible page combination for warmer queue url with selected sources.
Full Page Cache Warmer Extension for Magento 2 By MageBees
12 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Example:
Selected Customer Groups: General, NOT LOGGED IN
Selected Currencies: USD, INR
Selected Stores: French, English
Suppose if there are three url exist in the warmer queue then
3 links * 2 Customer Groups * 2 Currencies * 2 Stores = 24-page combinations (Request url)
will proceed during warm-up process.
As a result, each link will be checked in the following 8 combinations:
General + USD + French
General + USD + English
General + INR +French
General + INR + English
NOT LOGGED IN + USD +French
NOT LOGGED IN + USD + English
NOT LOGGED IN + INR +French
NOT LOGGED IN + INR + English
Full Page Cache Warmer Extension for Magento 2 By MageBees
13 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Step-6
Click on Connection Settings Tab. You will get the following screen.
Use Http Authentication: Use this option only if your website is protected with
.htaccess
Login: If “Use Http Authentication” is set to yes then set the login for
authenticating.
Password: If “Use Http Authentication” is set to yes then set the password for
authenticating.
Disable certificate verification: Enable this feature only in case If the Full Page Cache
Warmer doesn't work for https.
Full Page Cache Warmer Extension for Magento 2 By MageBees
14 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Step-7
Click on Debug Settings Tab. You will get the following screen.
Show Cache Status: On select Yes, the cache status will display in the frontend.
Note: This option will work only with default Magento’s built-in cache, It will not
work with varnish cache because with varnish cache the extension can’t get
necessary data for display cache status.
Allowed IPs For Cache Status: With this option, you can set particular IP addresses
for which cache statuses will be displayed. Leave empty this field If you want to allow
all IPs for show cache status. You can set the multiple IP by comma-separated value.
Full Page Cache Warmer Extension for Magento 2 By MageBees
15 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Manage Warmer Queue from Command Line
Our Extension provides the facility to manage the warmer queue generation and process
using the command line
1) For Warmer Queue Generate from Command-Line, follow below mention step.
Open command prompt /terminal and change directory to your Magento installation
directory.
Run below mention command:
2) For Warmer Queue Process from Command-Line, follow below mention step.
Open command prompt /terminal and change directory to your Magento installation
directory.
Run below mention command:
php bin/magento magebees:warmqueue:generate
php bin/magento magebees:warmqueue:process
Full Page Cache Warmer Extension for Magento 2 By MageBees
16 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Manage Warmer Queue from Backend
You can manage the warmer queue generation and process from backend with the nicely
designed grid. Follow below mention steps to manage the warmer queue from the backend.
Go to Admin Panel > SYSTEM > MageBees Full Page Cache Warmer > FPC Warmer
Queue.
You will get the following screen.
The Warmer queue grid displays the list of urls to be crawled which are exist in the
warmer queue for the process.
For generate the warmer queue manually at any time from admin, you have to
click on “Generate Warmer Queue” button. This will generate the queue of warm
the page url.
For Process the queue in batches manually, you have to click on “Start Warm Up”
button. This will start crawling the warmer queue url in batch.
Full Page Cache Warmer Extension for Magento 2 By MageBees
17 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Manage Warmer Log
You can see the already warmed page url list in warmer log grid. The log contains all crawled
page combinations as set in the configuration. Easily filter log data by any parameter you
need.
Go to Admin Panel > SYSTEM > MageBees Full Page Cache Warmer > FPC Warmer Log.
You will get the following screen.
You can clear the log of warmed page url from the database, by clicking on “Clear
Log” button.
Full Page Cache Warmer Extension for Magento 2 By MageBees
18 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Warmer Performance Reports
Our Extension provides the warmer performance reports according to page status and
warmed page quantity.
Go to Admin Panel > SYSTEM > MageBees Full Page Cache Warmer > FPC Warmer
Performance Report.
You will get the following screen.
Go to Admin Panel > SYSTEM > MageBees Full Page Cache Warmer > FPC Warmer
Performance Report > Warmed Pages.
You will get the following screen.
Full Page Cache Warmer Extension for Magento 2 By MageBees
19 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Frontend Snapshots
You can check the page status in frontend. You can able to see the page status only if you
have set the “Show Cache Status” to “Yes” and allowed the IP to show cache status.
[Fig 1: Cache Miss Status in Frontend]
Full Page Cache Warmer Extension for Magento 2 By MageBees
20 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
[Fig 2: Cache Hit Status in Frontend]
Full Page Cache Warmer Extension for Magento 2 By MageBees
21 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
[Fig 3: Not cacheable blocks with Ignored status in Frontend]
Full Page Cache Warmer Extension for Magento 2 By MageBees
22 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
FAQS
Q-1: I have tried to install “Full Page Cache Warmer Extension” using the terminal, but I
am not able to install using the command line, what are steps for custom installation of
“Full Page Cache Warmer Extension”?
Solution:
Please contact us for installing our module in your store.
Q-2: Is It possible to generate and process the warmer queue using the command line?
Solution: Yes, It Is possible to generate and process the warmer queue using the command line. Please follow below mention steps.
1) Open command prompt/terminal and change directory to your Magento installation directory.
2) Run following command :
For Generate Warmer Queue:
For Process Warmer Queue:
Q-3: Why I am getting Exception as ‘An error occurred during “ ” fileLock execution ‘?
Solution: Warmer queue generation and process can be executed from command line, backend and Cron job .so suppose If at some moment queue generation process executed from command line and process warmer queue is executed from backend then It may cause problem so prevent the conflict between this process, we have generated the lock file so you may get this exception.
This lock file will automatically unlock after the execution is complete and not show this exception after refreshing the page.
php bin/magento magebees:warmqueue:process
php bin/magento magebees:warmqueue:generate
Full Page Cache Warmer Extension for Magento 2 By MageBees
23 MageBees a Venture by Capacity Web Solutions Pvt. Ltd.
Support Ticket:- https://support.magebees.com, Support Email:- [email protected]
Thank you!
Do you need Extension Support? Please create a
support ticket for a quick reply,
https://support.magebees.com
Do you have any suggestions? Please contact us,
https://www.magebees.com/contact-us