Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wp-cli/profile-command
Quickly identify what's slow with WordPress
https://github.com/wp-cli/profile-command
bottleneck cli hacktoberfest measure performance profile wordpress wp-cli wp-cli-package
Last synced: 5 days ago
JSON representation
Quickly identify what's slow with WordPress
- Host: GitHub
- URL: https://github.com/wp-cli/profile-command
- Owner: wp-cli
- License: mit
- Created: 2016-07-25T14:37:50.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T08:38:32.000Z (2 months ago)
- Last Synced: 2025-01-20T12:06:32.601Z (12 days ago)
- Topics: bottleneck, cli, hacktoberfest, measure, performance, profile, wordpress, wp-cli, wp-cli-package
- Language: PHP
- Homepage:
- Size: 347 KB
- Stars: 272
- Watchers: 20
- Forks: 29
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
wp-cli/profile-command
======================
Quickly identify what's slow with WordPress.
[](https://github.com/wp-cli/profile-command/actions/workflows/testing.yml)
Quick links: [Overview](#overview) | [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
## Overview
`wp profile` monitors key performance indicators of the WordPress execution process to help you quickly identify points of slowness.
Save hours diagnosing slow WordPress sites. Because you can easily run it on any server that supports WP-CLI, `wp profile` compliments Xdebug and New Relic by pointing you in the right direction for further debugging. Because it runs on the command line, using `wp profile` means you don't have to install a plugin and deal with the painful dashboard of a slow WordPress site. And, because it's a WP-CLI command, `wp profile` makes it easy to perform hard tasks (e.g. [profiling a WP REST API response](https://danielbachhuber.com/tip/profile-wp-rest-api/)).
[Identify why WordPress is slow in just a few steps](https://danielbachhuber.com/tip/identify-wordpress-slowness/) with `wp profile`.
## Using
This package implements the following commands:
### wp profile stage
Profile each stage of the WordPress load process (bootstrap, main_query, template).
~~~
wp profile stage [] [--all] [--spotlight] [--url=] [--fields=] [--format=] [--order=] [--orderby=]
~~~
When WordPress handles a request from a browser, it’s essentially
executing as one long PHP script. `wp profile stage` breaks the script
into three stages:
* **bootstrap** is where WordPress is setting itself up, loading plugins
and the main theme, and firing the `init` hook.
* **main_query** is how WordPress transforms the request (e.g. `/2016/10/21/moms-birthday/`)
into the primary WP_Query.
* **template** is where WordPress determines which theme template to
render based on the main query, and renders it.
**OPTIONS**
[]
Drill down into a specific stage.
[--all]
Expand upon all stages.
[--spotlight]
Filter out logs with zero-ish values from the set.
[--url=]
Execute a request against a specified URL. Defaults to the home URL.
[--fields=]
Limit the output to specific fields. Default is all fields.
[--format=]
Render output in a particular format.
---
default: table
options:
- table
- json
- yaml
- csv
---
[--order=]
Ascending or Descending order.
---
default: ASC
options:
- ASC
- DESC
---
[--orderby=]
Set orderby which field.
**EXAMPLES**
# See an overview for each stage of the load process.
$ wp profile stage --fields=stage,time,cache_ratio
+------------+---------+-------------+
| stage | time | cache_ratio |
+------------+---------+-------------+
| bootstrap | 0.7994s | 93.21% |
| main_query | 0.0123s | 94.29% |
| template | 0.792s | 91.23% |
+------------+---------+-------------+
| total (3) | 1.6037s | 92.91% |
+------------+---------+-------------+
# Dive into hook performance for a given stage.
$ wp profile stage bootstrap --fields=hook,time,cache_ratio --spotlight
+--------------------------+---------+-------------+
| hook | time | cache_ratio |
+--------------------------+---------+-------------+
| muplugins_loaded:before | 0.2335s | 40% |
| muplugins_loaded | 0.0007s | 50% |
| plugins_loaded:before | 0.2792s | 77.63% |
| plugins_loaded | 0.1502s | 100% |
| after_setup_theme:before | 0.068s | 100% |
| init | 0.2643s | 96.88% |
| wp_loaded:after | 0.0377s | |
+--------------------------+---------+-------------+
| total (7) | 1.0335s | 77.42% |
+--------------------------+---------+-------------+
### wp profile hook
Profile key metrics for WordPress hooks (actions and filters).
~~~
wp profile hook [] [--all] [--spotlight] [--url=] [--fields=] [--format=] [--order=] [--orderby=]
~~~
In order to profile callbacks on a specific hook, the action or filter
will need to execute during the course of the request.
**OPTIONS**
[]
Drill into key metrics of callbacks on a specific WordPress hook.
[--all]
Profile callbacks for all WordPress hooks.
[--spotlight]
Filter out logs with zero-ish values from the set.
[--url=]
Execute a request against a specified URL. Defaults to the home URL.
[--fields=]
Display one or more fields.
[--format=]
Render output in a particular format.
---
default: table
options:
- table
- json
- yaml
- csv
---
[--order=]
Ascending or Descending order.
---
default: ASC
options:
- ASC
- DESC
---
[--orderby=]
Set orderby which field.
**EXAMPLES**
# Profile a hook.
$ wp profile hook template_redirect --fields=callback,cache_hits,cache_misses
+--------------------------------+------------+--------------+
| callback | cache_hits | cache_misses |
+--------------------------------+------------+--------------+
| _wp_admin_bar_init() | 0 | 0 |
| wp_old_slug_redirect() | 0 | 0 |
| redirect_canonical() | 5 | 0 |
| WP_Sitemaps->render_sitemaps() | 0 | 0 |
| rest_output_link_header() | 3 | 0 |
| wp_shortlink_header() | 0 | 0 |
| wp_redirect_admin_locations() | 0 | 0 |
+--------------------------------+------------+--------------+
| total (7) | 8 | 0 |
+--------------------------------+------------+--------------+
### wp profile eval
Profile arbitrary code execution.
~~~
wp profile eval [--hook[=]] [--fields=] [--format=] [--order=] [--orderby=]
~~~
Code execution happens after WordPress has loaded entirely, which means
you can use any utilities defined in WordPress, active plugins, or the
current theme.
**OPTIONS**
The code to execute, as a string.
[--hook[=]]
Focus on key metrics for all hooks, or callbacks on a specific hook.
[--fields=]
Display one or more fields.
[--format=]
Render output in a particular format.
---
default: table
options:
- table
- json
- yaml
- csv
---
[--order=]
Ascending or Descending order.
---
default: ASC
options:
- ASC
- DESC
---
[--orderby=]
Set orderby which field.
**EXAMPLES**
# Profile a function that makes one HTTP request.
$ wp profile eval 'wp_remote_get( "https://www.apple.com/" );' --fields=time,cache_ratio,request_count
+---------+-------------+---------------+
| time | cache_ratio | request_count |
+---------+-------------+---------------+
| 0.1009s | 100% | 1 |
+---------+-------------+---------------+
### wp profile eval-file
Profile execution of an arbitrary file.
~~~
wp profile eval-file [--hook[=]] [--fields=] [--format=] [--order=] [--orderby=]
~~~
File execution happens after WordPress has loaded entirely, which means
you can use any utilities defined in WordPress, active plugins, or the
current theme.
**OPTIONS**
The path to the PHP file to execute and profile.
[--hook[=]]
Focus on key metrics for all hooks, or callbacks on a specific hook.
[--fields=]
Display one or more fields.
[--format=]
Render output in a particular format.
---
default: table
options:
- table
- json
- yaml
- csv
---
[--order=]
Ascending or Descending order.
---
default: ASC
options:
- ASC
- DESC
---
[--orderby=]
Set orderby which field.
**EXAMPLES**
# Profile from a file `request.php` containing `