ElasticPress Debugging Add-On
ElasticPress Debugging Add-On
Description
Allows you to examine every ElasticPress query running on any given request by adding an ElasticPress panel to Debug Bar and/or Query Monitor plugins.
Alternatively, go to ElasticPress > Query Log and set it to record ElasticPress queries.
Requirements:
- ElasticPress 4.4.0+
- PHP 7.4+
- Additional functionalities with Debug Bar 1.0+ or Query Monitor
Installation
- Install ElasticPress.
- Optionally install Debug Bar or Query Monitor.
- Install the plugin in WordPress.
Faq
Please report security bugs found in the source code of the ElasticPress Debugging Add-On plugin through the Patchstack Vulnerability Disclosure Program. The Patchstack team will assist you with verification, CVE assignment, and notify the developers of this plugin.
Reviews
It Does What It Says
By Daniel Hendricks (hendridm) on February 27, 2019
Indispensable if you're working on a site with ElasticPress integration
By J B (JohnPBloch) on September 3, 2016
The title says it all.
Changelog
4.0.0 – 2026-05-05
This version bumps the minimum PHP version to 7.4+.
Added:
- Compatibility with Query Monitor 4 (including styles when Query Monitor loads the frontend in the Shadow DOM). Props @burhandodhy.
- FAQ on reporting security bugs through the Patchstack Vulnerability Disclosure Program. Props @jeffpaul.
Changed:
- Bump
Requires PHPto 7.4. Props @burhandodhy and @felipeelia. - Remove the
Requires Pluginsplugin header so the plugin can be activated when ElasticPress is installed as an mu-plugin. Props @barryceelen. - Updated npm dependencies. Props @felipeelia.
Fixed:
- Icon styling on the Query Log admin page. Props @burhandodhy.
- Query Log “Keep Enabled” setting not working. Props @burhandodhy.
- Extra backslashes in copied cURL commands. Props @burhandodhy.
- Styling issues with Query Monitor Dark Mode. Props @burhandodhy and @felipeelia.
Security:
- Bumped
tar-fsfrom 2.1.1 to 3.1.0. Props @dependabot. - Bumped
http-proxy-middlewarefrom 2.0.7 to 2.0.9. Props @dependabot.
3.1.1 – 2024-12-11
Added:
- Display the number of queries in Query Monitor’s tab title. Props @felipeelia and @burhandodhy.
- ElasticPress as a plugin dependency. Props @jeffpaul.
Changed:
- More modern versions of GitHub Actions, node, and node packages. Props @felipeelia.
Fixed:
- Notices related to i18n calls. Props @felipeelia and @archon810.
- Use new plugin name in the admin notice. Props @burhandodhy.
3.1.0 – 2023-09-20
Added:
- New button to explain ES queries. Props @burhandodhy, @felipeelia, @MARQAS, and @brandwaffle.
- New button to Reload and retrieve raw ES document. Props @burhandodhy, @felipeelia, and @brandwaffle.
- Query types (and context when listing queries in the Query Log admin screen.) Props @felipeelia and @burhandodhy.
- Log query by context, status, and fixed time. Props @felipeelia.
- Official support to Query Monitor. Props @felipeelia.
Security:
- Bumped
tough-cookiefrom 4.1.2 to 4.1.3. Props @dependabot. - Bumped
word-wrapfrom 1.2.3 to 1.2.4. Props @dependabot.
3.0.0 – 2023-03-23
This release drops the support for older versions of ElasticPress and PHP.
Added:
- Instructions with error code for failed queries. Props @MARQAS and @felipeelia.
- Buttons to copy or download all requests info. Props @MARQAS, @felipeelia, and @burhandodhy.
- Compatibility with the WordPress localization system. Props @burhandodhy and @felipeelia.
- SECURITY.md file. Props @felipeelia.
Changed:
- Set minimum requirement for PHP to 7.0 and ElasticPress to 4.4.0. Props @burhandodhy and @felipeelia.
- CSS and JS code lint by 10up toolkit. Props @burhandodhy.
Fixed:
- Unnecessary
stripslashes()call when outputting JSON objects. Props @felipeelia, @goldenapples, and @mattonomics. - JS error on copy action. Props @burhandodhy.
Security:
- Bumped
minimatchfrom 3.0.4 to 3.1.2. Props @dependabot. - Bumped
json5from 2.2.0 to 2.2.3. Props @dependabot. - Bumped
webpackfrom 5.75.0 to 5.76.2. Props @dependabot.
2.1.1 – 2022-08-04
Security:
- Fix XSS vulnerability. Props @piotr-bajer and @felipeelia.
- Bumped
path-parsefrom 1.0.6 to 1.0.7. Props @dependabot. - Bumps
minimistfrom 1.2.5 to 1.2.6. Props @dependabot. - Bumps
ansi-regexfrom 5.0.0 to 5.0.1. Props @dependabot.
2.1.0
Added:
- ElasticPress and Elasticsearch versions. Props to @oscarssanchez and @felipeelia.
- Log of bulk_index requests. Props @felipeelia.
- Warning when ElasticPress is indexing. Props @nathanielks and @felipeelia.
Changed:
- Only load CSS and JS files for logged-in users. Props @cbratschi and @felipeelia.
2.0.0
This release drops the support for older versions of WordPress Core, ElasticPress and Debug Bar.
- Code refactoring. Props @felipeelia
- Fixed Query Logs in EP Dashboard @felipeelia
- Fixed typo from “clsas” to “class” in the query output. Props @Rahmon
1.4
- Support ElasticPress 3.0+
1.3
- Add query log
1.2
- Show query errors (i.e. cURL timeout)
- Add ?explain to query if GET param is set
1.1.1
- Only show query body if it exits
1.1
- Improve formatting
- Show original query args (EP 2.1+)
1.0
- Initial release