Runbooks for hosts: overview #

A runbook is the page on-call staff open when something is wrong. Each one starts with the symptoms, then the first minutes, then diagnosis and fix, and ends with what to do afterwards. The commands are those of the installation book's troubleshooting chapter (Chapter 12), arranged for an incident.

Pages in this section #

Rules for every incident #

1. Write down the time you started and every step you take. The log viewer and the audit trail use exact times.
2. Read before you change. The first look is always var/log/error.log and the engine's or web server's log (12.2 Where the logs are).
3. Change one thing at a time, and clear the smallest cache that covers it.
4. Run commands as the installation's owner, not as root; a script run as root leaves files the site cannot change (12.3).
5. Tell the customer early, with what you know and when you will update them.

The commands you will use most #

./console exp:logs --tail=var/log/error.log --lines=50     # the last 50 errors
./console exp:logs --reference=ERR-0123456789               # one error page's details
php bin/php/console exp:velocity status --allow-root-user   # is Velocity running and answering?
php bin/php/maintenance.php status --allow-root-user        # is maintenance mode on?
php bin/php/ezcache.php --clear-all --allow-root-user       # when unsure which cache
php bin/php/console exp:velocity cache clear --apply --allow-root-user  # Velocity's response cache, after a restart

Related pages #

• Checklists for hosts
• Monitoring overview
• When something goes wrong
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.