2016-07-25 07:36:55 -07:00
runcommand/profile
==================
2016-08-29 06:51:40 -07:00
Quickly identify what's slow with WordPress.
2016-07-25 07:36:55 -07:00
2016-08-29 07:20:58 -07:00
`wp profile` monitors key performance indicators of the WordPress execution process to help you quickly identify points of slowness.
2016-07-25 07:36:55 -07:00
2016-08-29 08:01:34 -07:00
Save tens of minutes diagnosing slow WordPress sites with `wp profile` . 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. And, because it's a WP-CLI command, using `wp profile` means you don't have to install a plugin and deal with the painful dashboard of a slow WordPress site.
2016-07-25 07:36:55 -07:00
2016-08-29 07:20:58 -07:00
First, run `wp profile` to see metrics for each stage of the WordPress load process:
2016-07-25 10:17:10 -07:00
```
$ wp profile
2016-08-29 06:51:40 -07:00
+------------+---------+------------+-------------+-------------+------------+--------------+-----------+------------+--------------+---------------+
| stage | time | query_time | query_count | cache_ratio | cache_hits | cache_misses | hook_time | hook_count | request_time | request_count |
+------------+---------+------------+-------------+-------------+------------+--------------+-----------+------------+--------------+---------------+
| bootstrap | 2.0408s | 0.0365s | 15 | 93.21% | 412 | 30 | 0.9299s | 3097 | 0s | 0 |
| main_query | 0.0123s | 0.0004s | 3 | 94.29% | 33 | 2 | 0.0098s | 79 | 0s | 0 |
| template | 0.305s | 0.0175s | 179 | 91.02% | 2636 | 260 | 0.1125s | 7777 | 0s | 0 |
+------------+---------+------------+-------------+-------------+------------+--------------+-----------+------------+--------------+---------------+
| total | 2.3582s | 0.0544s | 197 | 92.84% | 3081 | 292 | 1.0522s | 10953 | 0s | 0 |
+------------+---------+------------+-------------+-------------+------------+--------------+-----------+------------+--------------+---------------+
2016-07-25 10:17:10 -07:00
```
2016-08-29 07:20:58 -07:00
Then, use `--stage=<stage>` to dive into higher fidelity of a particular stage:
```
$ wp profile --stage=bootstrap
+-------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
| hook | time | query_time | query_count | cache_ratio | cache_hits | cache_misses | request_time | request_count |
+-------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
| | 0.3558s | 0.0014s | 1 | 25% | 1 | 3 | 0s | 0 |
| muplugins_loaded | 0.0002s | 0s | 0 | 50% | 1 | 1 | 0s | 0 |
| | 0.8075s | 0.0007s | 6 | 73.68% | 56 | 20 | 0s | 0 |
| plugins_loaded | 0.4271s | 0s | 0 | 100% | 138 | 0 | 0s | 0 |
| | 0.0046s | 0s | 0 | 100% | 6 | 0 | 0s | 0 |
| setup_theme | 0s | 0s | 0 | | 0 | 0 | 0s | 0 |
| | 0.2401s | 0s | 0 | 100% | 26 | 0 | 0s | 0 |
| after_setup_theme | 0.0007s | 0s | 0 | 100% | 4 | 0 | 0s | 0 |
| | 0.0001s | 0s | 0 | 100% | 2 | 0 | 0s | 0 |
| init | 0.2922s | 0.0016s | 8 | 96.3% | 156 | 6 | 0s | 0 |
| | 0.0277s | 0s | 0 | 100% | 2 | 0 | 0s | 0 |
| wp_loaded | 0.01s | 0s | 0 | | 0 | 0 | 0s | 0 |
+-------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
| total | 2.166s | 0.0037s | 15 | 84.5% | 392 | 30 | 0s | 0 |
+-------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
```
Lastly, when you've found a specific hook you'd like to assess, use `--hook=<hook>` :
```
$ wp profile --hook=plugins_loaded
+------------------------------------------------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
| callback | time | query_time | query_count | cache_ratio | cache_hits | cache_misses | request_time | request_count |
+------------------------------------------------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
| wp_maybe_load_widgets() | 0.0309s | 0s | 0 | | 0 | 0 | 0s | 0 |
| wp_maybe_load_embeds() | 0.0001s | 0s | 0 | | 0 | 0 | 0s | 0 |
| VaultPress_Hotfixes->protect_jetpack_402_from_oembed_xss() | 0s | 0s | 0 | | 0 | 0 | 0s | 0 |
| _wp_customize_include() | 0s | 0s | 0 | | 0 | 0 | 0s | 0 |
| Debug_Bar_Remote_Requests() | 0s | 0s | 0 | | 0 | 0 | 0s | 0 |
| EasyRecipePlus->pluginsLoaded() | 0.0029s | 0s | 0 | 100% | 4 | 0 | 0s | 0 |
| Gamajo\GenesisHeaderNav\genesis_header_nav_i18n() | 0.0007s | 0s | 0 | | 0 | 0 | 0s | 0 |
| DS_Public_Post_Preview::init() | 0s | 0s | 0 | | 0 | 0 | 0s | 0 |
| wpseo_load_textdomain() | 0.0006s | 0s | 0 | | 0 | 0 | 0s | 0 |
| load_yoast_notifications() | 0.003s | 0s | 0 | | 0 | 0 | 0s | 0 |
| wpseo_init() | 0.101s | 0s | 0 | 100% | 70 | 0 | 0s | 0 |
| wpseo_frontend_init() | 0.0003s | 0s | 0 | 100% | 2 | 0 | 0s | 0 |
| Black_Studio_TinyMCE_Plugin->load_compatibility() | 0.0122s | 0s | 0 | | 0 | 0 | 0s | 0 |
| Jetpack::load_modules() | 0.2706s | 0s | 0 | 100% | 62 | 0 | 0s | 0 |
| function(){} | 0s | 0s | 0 | | 0 | 0 | 0s | 0 |
+------------------------------------------------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
| total | 0.4226s | 0s | 0 | 100% | 138 | 0 | 0s | 0 |
+------------------------------------------------------------+---------+------------+-------------+-------------+------------+--------------+--------------+---------------+
```
Et voila! You've identified some of the sources of slowness.
2016-08-29 08:17:18 -07:00
[](https://circleci.com/gh/runcommand/profile/tree/master)
2016-08-29 07:20:58 -07:00
Quick links: [Using ](#using ) | [Installing ](#installing ) | [Contributing ](#contributing )
## Using
~~~
wp profile [--url=< url > ] [--stage=< stage > ] [--hook=< hook > ] [--fields=< fields > ] [--format=< format > ]
~~~
2016-07-25 08:14:12 -07:00
**OPTIONS**
[--url=< url > ]
Execute a request against a specified URL. Defaults to the home URL.
2016-08-29 06:51:40 -07:00
[--stage=< stage > ]
Drill down into a specific stage.
---
options:
- bootstrap
- main_query
- template
---
[--hook=< hook > ]
Drill down into a specific hook.
2016-07-25 10:17:10 -07:00
[--fields=< fields > ]
Display one or more fields.
2016-07-25 08:14:12 -07:00
[--format=< format > ]
Render output in a particular format.
---
default: table
options:
- table
- json
- yaml
- csv
---
2016-07-25 07:36:55 -07:00
## Installing
2016-08-29 08:42:52 -07:00
[Get early access to `wp profile` for only $49 per year ](https://runcommand.memberful.com/checkout?plan=15360 ). Purchasing an early access subscription locks you into this price for as long as you stay subscribed. Subscriptions include unlimited downloads of the command, plus support and updates for the length of your subscription.
2016-08-29 08:01:34 -07:00
Once you've purchased a subscription, installing the `wp profile` command is a three-step process:
2016-07-25 07:36:55 -07:00
2016-08-29 07:20:58 -07:00
1. Download the package from the URL in the purchase email.
2. Extract the package files.
3. Run `wp --require=command.php profile` to execute the profiler.
2016-07-25 07:36:55 -07:00
## Contributing
2016-08-29 07:20:58 -07:00
Support (bug reports, feature requests, and general usage questions) is available to those with an active runcommand subscription.
2016-07-25 07:36:55 -07:00
2016-08-29 07:20:58 -07:00
Send an email to [support@runcommand.io ](mailto:support@runcommand.io ).
2016-07-25 07:36:55 -07:00
*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc ](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme )). To suggest changes, please submit a pull request against the corresponding part of the codebase.*
