WordPress.org
Get WordPress

Plugin Directory

Changeset 3432288


Ignore:
Timestamp:
01/04/2026 09:34:09 PM (3 months ago)
Author:
A5hleyRich
Message:

Update readme.txt in stable tag 1.1.1 for WordPress.org display

File:
1 edited

Legend:

Unmodified
Added
Removed

  • debughawk/tags/1.1.1/readme.txt

    r3394893 r3432288  
    1 === DebugHawk ===
     1=== DebugHawk - WordPress Performance Monitoring & Debugging ===
    22Contributors: A5hleyRich
    3 Tags: performance, monitoring, debug, debugging, query monitor
    4 Tested up to: 6.8.3
     3Tags: performance, monitoring, debug, slow, speed, database, queries, core web vitals, optimization, profiling, cache, site health
     4Tested up to: 6.9
    55Stable tag: 1.1.1
    66Requires at least: 6.3
    … …  
    99License URI: https://www.gnu.org/licenses/gpl-3.0.html
    1010
    11 WordPress performance debugging and monitoring, simplified.
     11Monitor WordPress performance, debug slow sites, track Core Web Vitals, database queries, memory usage, and cache effectiveness. Performance monitoring built specifically for WordPress.
    1212
    1313== Description ==
    1414
    15 WordPress performance debugging and monitoring, simplified. [DebugHawk](https://debughawk.com) gives you deep insight into your WordPress site's front-end and back-end performance, with the clarity only a tool purpose-built for WordPress can offer.
     15**Monitor and debug WordPress performance issues with DebugHawk** - the performance monitoring tool built specifically for WordPress developers and site owners who need to identify what's slowing down their site.
    1616
    17 Here's an overview of what's tracked:
     17= Why WordPress Sites Are Slow =
    1818
    19 **Front-end Performance**
     19Slow WordPress sites lose visitors, conversions, and search rankings. But identifying the root cause is difficult when frontend tools like Google PageSpeed Insights only show part of the picture.
    2020
    21 * Core Web Vitals (LCP, INP, CLS, TTFB, FCP)
    22 * Network performance metrics (DNS lookup, connection time)
    23 * Browser resource tracking (requests, page weight, transfer sizes)
     21DebugHawk monitors both frontend and backend performance so you can see exactly what's slowing down your WordPress site - whether it's slow database queries, external API calls, or frontend Core Web Vitals problems.
    2422
    25 **Back-end Performance**
     23= What DebugHawk Monitors =
    2624
    27 * PHP execution time and memory usage
    28 * Database query performance and count
    29 * External HTTP request timing
    30 * Object cache performance
    31 * Page cache effectiveness
    32 * Redirects
     25**Frontend Performance Metrics:**
     26
     27* **Core Web Vitals** - LCP (Largest Contentful Paint), INP (Interaction to Next Paint), CLS (Cumulative Layout Shift), TTFB (Time to First Byte), FCP (First Contentful Paint)
     28* **Network Performance** - DNS lookup time, connection time
     29* **Browser Resources** - HTTP requests, page weight, transfer sizes
     30
     31**Backend Performance Tracking:**
     32
     33* **Database Query Performance** - Slow queries, query count, total database time
     34* **PHP Execution** - Execution time, memory usage
     35* **External HTTP Requests** - API call timing, external service performance
     36* **Object Cache Performance** - Hit ratio, cache effectiveness
     37* **Page Cache Effectiveness** - Cache hits vs misses
     38* **Redirect Detection** - Unnecessary redirects slowing page loads
     39
     40= Debug Slow WordPress Sites =
     41
     42Unlike generic performance tools, DebugHawk understands WordPress architecture. It shows you:
     43
     44* Which plugins are causing slow database queries
     45* Which external APIs are timing out
     46* Whether your caching is working effectively
     47
     48Perfect for WordPress developers, agencies managing multiple sites, and site owners who need to diagnose performance issues quickly.
     49
     50= How It Works =
     51
     521. **Automatic Monitoring** - Once configured, DebugHawk tracks performance on every page load
     532. **Real User Monitoring (RUM)** - See actual performance data from your real visitors, not synthetic tests
     543. **Historical Data** - Track performance over time, identify when issues started
     554. **Encrypted Transmission** - All data is encrypted before sending to DebugHawk's dashboard
     56
     57No impact on site performance - the monitoring overhead is negligible.
     58
     59= Perfect For =
     60
     61* **WordPress Developers** debugging slow queries and performance bottlenecks
     62* **Agencies** monitoring client site performance across multiple WordPress sites
     63* **Site Owners** who need to understand why their WordPress site is slow
     64* **WooCommerce Stores** tracking checkout performance and database optimization
     65* **Membership Sites** monitoring server load and query performance
     66
     67= Get Started =
     68
     691. Sign up for a free trial at [DebugHawk.com](https://debughawk.com)
     702. Install and activate this plugin
     713. Add your site configuration to `wp-config.php`
     724. Start monitoring your WordPress performance
    3373
    3474== Installation ==
    3575
    36 1. Sign up for a [DebugHawk](https://debughawk.com) account.
    37 1. Upload the plugin files to the `/wp-content/plugins/debughawk` directory, or install the plugin through the 'Plugins' screen.
    38 1. Activate the plugin through the 'Plugins' screen.
    39 1. Configure the plugin by adding the configuration provided by DebugHawk to your `wp-config.php` file, above the line that says `/* That's all, stop editing! */`.
     76**Automatic Installation:**
    4077
    41 == How It Works ==
     781. Log in to your WordPress admin dashboard
     792. Go to Plugins > Add New
     803. Search for "DebugHawk"
     814. Click "Install Now" and then "Activate"
    4282
    43 Once configured, DebugHawk automatically:
     83**Manual Installation:**
    4484
    45 1. **Monitors Performance** - Tracks PHP execution time, database queries, and memory usage on each page load
    46 2. **Collects Browser Metrics** - Injects a lightweight JavaScript beacon to collect Core Web Vitals and resource timing
    47 3. **Encrypts Data** - All collected data is encrypted before transmission
     851. Download the plugin ZIP file
     862. Upload to `/wp-content/plugins/debughawk` directory
     873. Activate the plugin through the 'Plugins' screen in WordPress
    4888
    49 The plugin works transparently without any additional user interaction after configuration.
     89**Configuration:**
     90
     911. Sign up for a [DebugHawk account](https://debughawk.com) (free trial available)
     922. Copy your site configuration from the DebugHawk dashboard
     933. Add the configuration to your `wp-config.php` file, above the line `/* That's all, stop editing! */`
     94
     95Example configuration:
     96
     97```php
     98define( 'DEBUGHAWK_CONFIG', [
     99    'enabled'  => true,
     100    'endpoint' => 'https://ingest.debughawk.com/your-endpoint',
     101    'secret'   => 'your-secret-key',
     102] );
     103```
     104
     105That's it! DebugHawk will now monitor your WordPress site's performance automatically.
     106
     107== Frequently Asked Questions ==
     108
     109= How does DebugHawk help debug slow WordPress sites? =
     110
     111DebugHawk monitors both frontend and backend performance. While tools like Google PageSpeed Insights only show frontend metrics, DebugHawk also tracks slow database queries, PHP execution time, external API calls, and memory usage - the backend issues that often cause WordPress sites to be slow.
     112
     113= Will DebugHawk slow down my WordPress site? =
     114
     115No. DebugHawk has negligible performance impact. The monitoring code is lightweight and optimized to avoid affecting your site speed.
     116
     117= What's the difference between DebugHawk and Query Monitor? =
     118
     119Query Monitor shows performance data for your current admin session only. DebugHawk tracks performance across all visitors over time, stores historical data, and lets you identify patterns and trends. Think of Query Monitor as a debugger, and DebugHawk as production monitoring.
     120
     121= Can DebugHawk identify which plugins are slowing down my site? =
     122
     123Yes. DebugHawk tracks database queries, HTTP requests, and execution time, showing you which plugins are creating performance bottlenecks.
     124
     125= Does DebugHawk work with WooCommerce? =
     126
     127Absolutely. DebugHawk is perfect for WooCommerce sites where slow checkout pages can cost you sales. Monitor database query performance, external payment gateway API calls, and Core Web Vitals on your product and checkout pages.
     128
     129= How is Core Web Vitals data collected? =
     130
     131DebugHawk uses Real User Monitoring (RUM) to collect Core Web Vitals from actual visitors' browsers, giving you accurate field data instead of synthetic lab tests.
     132
     133= Do I need a DebugHawk account? =
     134
     135Yes. The plugin sends performance data to DebugHawk's dashboard where you can analyze trends, set up alerts, and monitor multiple WordPress sites. Start with a free trial at [debughawk.com](https://debughawk.com).
     136
     137= Can I monitor multiple WordPress sites? =
     138
     139Yes. DebugHawk is designed for agencies and developers managing multiple WordPress sites. Monitor all your sites from one dashboard.
     140
     141= What data does DebugHawk collect? =
     142
     143DebugHawk collects performance metrics only: page load times, database query times, memory usage, Core Web Vitals, etc. No personal user data or content is collected. All data is encrypted during transmission.
     144
     145= How do I debug slow database queries? =
     146
     147DebugHawk automatically tracks all database queries, showing you slow queries, duplicate queries, and total database time. View this data in your DebugHawk dashboard to identify optimization opportunities.
    50148
    51149== Changelog ==
    … …  
    55153
    56154= 1.1.0 =
    57 * Beacon script now served from global CDN instead of locally from WordPress
     155* Beacon script now served from global CDN for faster performance
    58156* Send DebugHawk plugin version as part of telemetry payload
     157* Improved performance monitoring accuracy
    59158
    60159= 1.0.1 =
    61160* Only track redirects originating from the same domain
     161* Enhanced redirect detection accuracy
    62162
    63163= 1.0.0 =
    64 * Don't track /wp-login.php redirects
    65164* Official stable release
     165* Don't track /wp-login.php redirects to reduce noise
    66166
    67167= 0.8.2 =
    68 * Fixed PHP 8.4 deprecation warning
     168* Fixed PHP 8.4 deprecation warning for better compatibility
    69169
    70170= 0.8.1 =
    71171* Initial release on WordPress.org
     172* Production-ready performance monitoring
     173* Core Web Vitals monitoring
     174* Database query performance tracking
     175* PHP execution time and memory monitoring
     176* External HTTP request timing
     177* Object cache and page cache effectiveness
     178
     179== Upgrade Notice ==
     180
     181= 1.1.1 =
     182Important update: Ensures db.php drop-in is properly managed during plugin deactivation.
Note: See TracChangeset for help on using the changeset viewer.