Stratus - Magento 2 Guides on Webscale Product Documentation

Stratus Magento 2 Guides - Improving the Cron

Mon, 01 Jan 0001 00:00:00 +0000

NOTE: All Magento 2 stores hosted on STRATUS are required to install the MageMojo Cron extension.

MageMojo’s (now Webscale Stratus) engineers have completely rewritten the Magento 2 cron functionality to fix the inherent bugs and to be much more resistant to failure.

The MageMojo Cron extension is free to install and may be installed by the store owner or developer, or Webscale Stratus support will install the extension at no additional cost.

Stratus Magento 2 Guides - Configure Elasticsearch

Mon, 01 Jan 0001 00:00:00 +0000

Log into the Magento 2 Administration backend.
Go to Stores > Configuration.
Go to Catalog > Catalog in the sidebar menu.

* De-select* Search Engine : Use system value. * Elasticsearch Server Hostname — Enter “elasticsearch”.
Click Test Connection to validate the settings.
Click Save Config to save the changes.

After activating Elasticsearch, re-index the catalogsearch_fulltext index using the Magento Admin, SSH access, or the Webscale STRATUS Control panel CLI commands .

Stratus Magento 2 Guides - Composer

Mon, 01 Jan 0001 00:00:00 +0000

Instead of identifying, installing, and configuring a PHP library independently, libraries can be specified in a JSON setup file.

Magento 2 relies on composer (though you can avoid it) through several repositories.

Composer for Magento 2 is pre-installed on MageMojo servers. To install, run:

composer create-project --repository-url=https://repo.magento.com/ magento/project-community-edition

How Composer Works

When Composer is called by this command, it first creates a project and pull in an existing package — in this case, Magento 2. The project will be created, for this example, in the magento/project-community-edition directory.

Stratus Magento 2 Guides - Customer Grid Empty

Mon, 01 Jan 0001 00:00:00 +0000

The customer list in Magento 2 may appear empty despite the fact there are many rows/customers in the customer_entity table. The grid depends on an indexer called the customer_grid index that stores data in the customer_grid_flat table. In this case, the flat table has not been properly populated by the indexer.

By tracing the indexer, it may show a “hang” on a query such as the following:

sendto(5, ",\7\0\0\3SELECT `e`.*, `e`.`entity_id`, TRIM(CONCAT_WS(' ', IF(`e`.`prefix` <> '', `e`.`prefix`, NULL), IF(`e`.`firstname` <> '', `e`.`firstname`, NULL), IF(`e`.`middlename` <> '', `e`.`middlename`,<br />
NULL), IF(`e`.`lastname` <> '', `e`.`lastname`, NULL), IF(`e`.`suffix` <> '', `e`.`suffix`, NULL))) AS `name`, `e`.`email`, `e`.`group_id`, `e`.`created_at`, `e`.`website_id`, `e`.`confirmation`,<br />
 `e`.`created_in`, `e`.`dob`, `e`.`gender`, `e`.`taxvat`, (SELECT `lookup`.`last_visit_at` FROM `customer_visitor` AS `lookup` WHERE (`lookup`.`customer_id` = `e`.`entity_id`) ORDER BY `lookup`.`last_visit_at`<br />
DESC LIMIT 1) AS `last_visit_at`, TRIM(CONCAT_WS(' ', IF(`shipping`.`street` <> '', `shipping`.`street`, NULL), IF(`shipping`.`city` <> '', `shipping`.`city`, NULL), IF(`shipping`.`region` <> '',<br />
`shipping`.`region`, NULL), IF(`shipping`.`postcode` <> '', `shipping`.`postcode`, NULL))) AS `shipping_full`, TRIM(CONCAT_WS(' ', IF(`billing`.`street` <> '', `billing`.`street`, NULL), IF(`billing`.`cit"...,<br />
 1840, MSG_DONTWAIT, NULL, 0) = 1840

The problem, in this case, is the customer_visitor table. By inspection, if the table has several hundred thousands of rows, it should be emptied and reindexing again attempted.

Stratus Magento 2 Guides - Deploying static files

Mon, 01 Jan 0001 00:00:00 +0000

Before deploying static files, remove any files — except the .htaccess file — in pub/static.

The following should also be removed, especially when doing a production deployment.

All folders under pub/static
var/cache
var/composer_home
var/generation
var/page_cache
var/view_preprocessed
var/di (if present)

Then the static files can be deployed using the following command (run from the bin directory in the Magento install).

php bin/magento setup:static-content:deploy

Stratus Magento 2 Guides - Email Sender Incorrect

Mon, 01 Jan 0001 00:00:00 +0000

For example,

2.2.3 — sales@example.com

may become,

2.2.4 — www-data@…mojostratus.io

A github issue is tracking this. MageMojo has tested and confirmed the bug and a fix is to disable all the Amazon modules:

Amazon_Core
Amazon_Login
Amazon_Payment

To disable these modules, run:

php bin/magento module:disable Amazon_Login
php bin/magento module:disable Amazon_Payment
php bin/magento module:disable Amazon_Core

Then redeploy production mode for the Magento 2 store.

Stratus Magento 2 Guides - Site Changes Not Appearing

Mon, 01 Jan 0001 00:00:00 +0000

Caches

If product or theme changes on a Magento 2 site are not showing, there are numerous caches that might need to be cleared. In no particular order, check all of these sources:

Re-deploy static files (clear pub/static, then deploy)
Re-compile or reset production mode (this also clears static files)
Flush and clean the Magento 2 cache
Clear the local browser cache or test with an incognito tab in Chrome or private tab in Firefox
Use [/usr/share/stratus/cli cache.all.clear][1]

Clearing Varnish

The easiest way to do clear Vanish without root access:

Stratus Magento 2 Guides - Purge the Varnish FPC

Mon, 01 Jan 0001 00:00:00 +0000

/usr/share/stratus/cli cache.varnish.clear

Curl also works if you are using SSH. The Varnish hostname is varnish:

curl -X 'PURGE' -H'X-Magento-Tags-Pattern: .*' varnish

Magento 2 users should set their http-cache-host accordingly:

php bin/magento setup:config:set --http-cache-hosts=varnish

Once the above is set, a typical cache clear via the Magento 2 admin or Magento commands is possible:

php bin/magento cache:clean

Varnish can also be purged via the Flush Cache button in the Varnish > Info Webscale STRATUS Admin panel.

Stratus Magento 2 Guides - Send store mail via SMTP

Mon, 01 Jan 0001 00:00:00 +0000

While this works fine in most cases, we do recommend using an SMTP module or plugin for either version of Magento to improve deliverability. Especially for high traffic stores. Sending a lot of emails daily runs the risk of having the server blocked by the major email providers such as Gmail or Hotmail due to volume. Sending out through dedicated services like Mandrill or Sendgrid allows the sending of higher volumes without the risk of blacklisting.

Stratus Magento 2 Guides - Set Magento 2 modes

Mon, 01 Jan 0001 00:00:00 +0000

Please read the development documentation on Magento 2 modes for in-depth information.

Default mode

This mode is “halfway” between development and production. Static files are enabled, but compilation is not.
Production mode

All the caching and compilation features are enabled for performance. Updates to your site theme or other content may not appear without re-deploying this mode. Caching will be used for all requests which are why updates are ignored until this content is refreshed via the Magento 2 cache, static files, and compilation.

Stratus Magento 2 Guides - Cron Explained

Mon, 01 Jan 0001 00:00:00 +0000

/usr/local/bin/php /srv/public_html/bin/magento cron:run >> /srv/public_html/var/log/cron.log
/usr/local/bin/php /srv/public_html/update/cron.php >> /srv/public_html/var/log/mcron.log
/usr/local/bin/php /srv/public_html/bin/magento setup:cron:run >> /srv/public_html/var/log/mcron.log

WARNING: DO not use stdout/stderr redirection “2>&1” as this is already applied with the nice command during execution time. Adding it may prevent the cron from running entirely.

EXAMPLE: If you have set this cron:

/usr/local/bin/php /srv/public_html/bin/magento cron:run >> /srv/public_html/var/log/cron.log

the cron that will actually run at execution time will be:

/bin/bash -c /usr/share/stratus/cron.sh "nice -n 19 /usr/local/bin/php /srv/public_html/bin/magento cron:run >> /srv/public_html/var/log/cron.log" 2>&1

Stratus Magento 2 Guides - Upgrade Recommendations

Mon, 01 Jan 0001 00:00:00 +0000

The following are helpful guides for upgrading Magento 2.x.

Support for upgrading Magento 2 is outside the scope of regular support.

Before Upgrading

Perform a local backup of the files and database before upgrading. Test the upgrade first on a development environment before performing the same steps on production.

Disable crons temporarily
Put the site in maintenance mode

Notes about Upgrading higher than Magento 2.4.3+

During setup:upgrade you may get an error related to ServiceManager.php: Service with name "Magento\Setup\Console\Command\DbStatusCommand" could not be created. Reason: Class "Vertex\Tax\Setup\Schema\Triggers\MigrateVertexInvoiceSent" does not exist. This is because the Vertex module does not exist in Magento 2.4.4 & higher. You can solve this issue by clearing caches and running setup:upgrade again.

redis-cli -h redis flushall && redis-cli -h redis-session -p 6380 flushall && redis-cli -h redis-config-cache -p 6381 flushall;stratus cache.all.clear

During setup:upgrade you may get an error in logs related to DataObject.php: main.CRITICAL: Deprecated Functionality: Return type of Magento\Framework\DataObject::offsetExists($offset) should either be compatible with ArrayAccess::offsetExists(mixed $offset): bool, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice in /cache/vendor/magento/framework/DataObject.php In this case you will need to do the following:

While PHP version is set to 7.4 : composer require magento/composer-root-update-plugin ~2.0 --no-update
composer update
rm -rf var/cache/* ; rm -rf var/page_cache/* ; rm -rf generated/code/* ; php bin/magento setup:upgrade
composer require-commerce magento/product-community-edition 2.4.4 --no-update
composer update
CHANGE TO PHP 8.1 : rm -rf var/cache/* ; rm -rf var/page_cache/* ; rm -rf generated/code/* ; php bin/magento setup:upgrade

Upgrading to a Major Release

To upgrade to 2.2.7 (in this example), run:

Stratus Magento 2 Guides - Using Baler to Speed Javascript Delivery

Mon, 01 Jan 0001 00:00:00 +0000

The result of this bundling is faster page speed times, which can improve customer experiences and Google rankings.

Bundling can only be activated on a Production environment.

Installing Baler

To install Baler:

Clone the current Baler Repository.

git clone https://github.com/magento/baler.git
Change to the Baler directory and install using npm.

npm install
Check to confirm you have node.js version 10.12.0 or later.

~/baler/bin$ ./baler baler requires a version of node.js >= 10.12.0. You're currently using v8.16.0

Stratus Magento 2 Guides - Using MagePack to Speed JS Delivery

Mon, 01 Jan 0001 00:00:00 +0000

To successfully utilize MagePack , a well-known JavaScript bundling tool on Webscale Stratus, please generate magepack.config.js file on your local computer by running a command.

docker run -t -i --rm nemke82/magepack-generator bash

You can use Play with Docker and run docker image directly in your browser tab to generate magepack.config.js file as well.

Run the following to generate magepack.config.js file (Replace https://mystore.com with your domain url ):

magepack generate --cms-url="https://mystore.com" --category-url="https://mystore.com/category-2/category-2-1/category-2-1-1.html" --product-url="https://mystore.com/category-2/category-2-1/category-2-1-1/simple-product-122.html"

When the file is generated, please upload the file to the docroot of your’s Magento 2 installation, login to the SSH container on Webscale STRATUS environment, and execute:

Stratus Magento 2 Guides - Terser installation

Mon, 01 Jan 0001 00:00:00 +0000

Terser processes JavaScript files as well as the compiled output from other languages like CoffeeScript, and TypeScript and transpilers like Babel.

First, make sure you have installed the latest version of node.js (You may need to restart your computer after this step).

From NPM for use as a command-line app:

npm install terser -g

Output:

$ node -v
v17.3.0

$ npm install terser -g
added 6 packages, and audited 7 packages in 687ms
found 0 vulnerabilities

$ whereis terser
terser: /usr/local/nvm/versions/node/v17.3.0/bin/terser

Usage is simple: GitHub - terser/terser: JavaScript parser, mangler and compressor toolkit for ES6+

Stratus Magento 2 Guides - Consumer Brokers MySQL to RabbitMQ.

Mon, 01 Jan 0001 00:00:00 +0000

RabbitMQ vs MySQL

Starting with Magento 2.4.5 Queue Consumers are utilizing RabbitMQ automatically. Any previous versions, when possible, Webscale Stratus recommends using RabbitMQ as the broker instead of MySQL. The Magento Dev docs explain how this can be changed in the env.php file. The RabbitMQ broker provides much better performance than MySQL. We recommend that high traffic sites utilize RabbitMQ for the most often used consumers.

Webscale Patch Repo

Please check the Webscale Patch Repo for easy-to-install patches to switch brokers for Magento consumers to RabbitMQ.

Stratus Magento 2 Guides - Manually Uninstalling an Extension or Module

Mon, 01 Jan 0001 00:00:00 +0000

NOTE: Before starting any modification that may affect your store, always [backup your store and database](/docs/reference/stratus/guides/general/backup-strategies/ “Backup Strategies”/) first. Preferably, you will be performing this action on a Development environment before attempting it on a Production environment.

To remove an extension/module manually:

Log into the environment via SSH.
Go to the root of the Magento 2 installation and remove the folder, app/code/<Vendor>/<Module>.
Run n98-magerun2 db:console to access the database.
Drop the module tabels from the database:

Stratus Magento 2 Guides - Configuring a Sitemap

Mon, 01 Jan 0001 00:00:00 +0000

To generate a sitemap in Magento 2:

Go to Marketing > Site Map in the backend of your Magento 2 store.
If you don’t already have a sitemap showing in the list, click Add Sitemap.
Enter the filename you wish to use (e.g. “sitemap.xml”).
Enter the file path from the root of the Magento install you wish to have Magento generate the sitemap. Most will simply enter in “/” for the root directory.
Click Save & Generate to have Magento create your initial sitemap.

To configure the parameters of the sitemap:

Stratus Magento 2 Guides - Magento 2.4.x Media Gallery

Mon, 01 Jan 0001 00:00:00 +0000

You can read more about using the gallery here .

Consumer Setup

Full functionality for new Media Gallery requires media.gallery.synchronization and media.content.synchronization queue consumers to be started for initial synchronization. Configuration in your env.php should look similar to this in order to run these consumers.

'cron_consumers_runner' => [
 'cron_run' => true,
 'max_messages' => 0,
 'consumers' => [
 'async.operations.all',
 'product_action_attribute.update',
 'product_action_attribute.website.update',
 'exportProcessor',
 'negotiableQuotePriceUpdate',
 'sharedCatalogUpdatePrice',
 'sharedCatalogUpdateCategoryPermissions',
 'quoteItemCleaner',
 'inventoryQtyCounter',
 'media.storage.catalog.image.resize',
 'media.content.synchronization',
 'media.gallery.renditions.update',
 'media.gallery.synchronization',
 'codegeneratorProcessor'
 ]
],

Broker

By default, Magento uses Mysql as a broker for processing consumers. You can gain a significant performance increase by configuring RabbitMQ as the broker for consumers instead. Please see the Webscale patch repo for instructions.