Terminus Site Debug Plugin

Terminus plugin that:

• download site logs from a specific environment of a Pantheon sites
• parse the logs for debugging purposes

This will also pull logs on an environment with multiple containers.

Learn more about Terminus and Terminus Plugins at: https://pantheon.io/docs/terminus/plugins/

Examples

Download all logs from dev.

terminus logs:get site_name.dev

Only download nginx-access.log and nginx-error.log logs.

terminus logs:get site_name.dev --nginx-access --nginx-error

Exclude nginx-access.log and nginx-error.log from download.

terminus logs:get site_name.dev --exclude --nginx-access --nginx-error

Parsing Nginx Access Logs

Search nginx-access logs with 301 status code via PHP.

terminus logs:parse site_name.env --type=nginx-access --filter="301" --php

Show how many times the IP visited the site.

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=ip

Top response by HTTP status.

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=response-code

Top 403 requests

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=403

Top 404 requests

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=404

Top PHP 404 requests.

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=php-404

Top PHP 404 requests in full details.

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=php-404-detailed

Top 502 requests

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=502

Top IPs accessing 502.

To get 502 URIs run this command first: terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=502

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=ip-accessing-502 --uri={SITE_URI}

Count the request that hits the appserver per second.

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=request-per-second

Top request methods.

terminus logs:parse site_name.env --type=nginx-access --shell --grouped-by=request-method --code=[200|403|404|502]

Parsing Nginx Error Logs

Search nginx-error.log for access forbidden error.

terminus logs:parse site_name.env --type=nginx-error --filter="access forbidden" --shell

Search nginx-error.log for SSL_shutdown error.

terminus logs:parse site_name.env --type=nginx-error --filter="SSL_shutdown" --shell

Parsing PHP Error Logs

Search php-error logs with 301 "Uncaught PHP Exception" error.

terminus logs:parse site_name.env --type=php-error --filter="Uncaught PHP Exception" --php

Search to all the logs.

terminus logs:parse site_name.env --type=all --filter="error" --php

Parsing PHP Slow Logs

Search for the latest entries.

terminus logs:parse site_name.env --type=php-slow --shell --grouped-by=latest 

Top functions by number of times they called.

terminus logs:parse site_name.env --type=php-slow --shell --grouped-by=function

Slow requests grouped by minute

terminus logs:parse site_name.env --type=php-slow --shell --grouped-by=minute

Parsing MySQL Slow Log

Display everything.

terminus logs:parse site_name.env --type=mysql --shell

Count of queries based on their time of execution.

terminus logs:parse site_name.env --type=mysql --shell --grouped-by=time

Logs listing

To list all the log files.

terminus logs:list site_name.env

Support

This plugin is not working on Windows environment. You may want to Dockerized your Terminus to use this kind of plugin that uses nix commands to parse the logs.

Installation

For help installing, see Manage Plugins

mkdir -p ~/.terminus/plugins
cd ~/.terminus/plugins
git clone https://github.com/geraldvillorente/terminus-site-debug.git

Credits

• To https://github.com/jfussion for the idea and initial codebase.