Shah Alom

Micro Solutions Bangladesh

<h3>MSBD Logs is a WordPress plugin that allows developers to review and manage log files generated by plugins and themes.</h3>
<p><strong>MSBD Logs</strong> is a lightweight logging helper for WordPress plugin and theme developers.</p>
<p>It provides a simple PHP API to write log messages and an admin interface to view, filter, and manage log files stored in the WordPress installation root <code>logs/</code> directory.</p>
<p>The plugin is designed to be minimal, dependency-free, and safe for use on production sites.</p>
<h3>🎉 Key Features</h3>
<ul>
<li>Simple logging function for developers</li>
<li>Daily rotating log files</li>
<li>Separate log types: <code>debug</code> and <code>attention</code></li>
<li>Debug logging can be enabled or disabled from admin</li>
<li>Admin UI to view, and filter log files</li>
<li>Secure file handling (capability and nonce protected)</li>
<li>No database tables or external services</li>
<li>Translation-ready</li>
</ul>
<h3>Log Storage Location</h3>
<p>All log files are stored in: <code>logs/</code>. <code>logs</code> folder is created in the WordPress installation root on activating the plugin. An <code>index.html</code> file is automatically created to prevent directory browsing.</p>
<h3>Developer Usage</h3>
<p>Use the following helper function anywhere in your plugin or theme code:<br />
* <code>msbd_logs_create( 'Log something only when the debug mode is active' );</code><br />
* <code>msbd_logs_create( 'Unexpected issue detected, always log', 'attention' );</code><br />
* <code>debug</code> logs are written only when debug mode is enabled<br />
* <code>attention</code> logs are always written</p>
<h3>Admin Interface</h3>
<p>After single-site activation, a new menu item <strong>“MSBD Logs”</strong> appears in the WordPress admin dashboard. When activated network wide, the settings page appears under <strong>Network Admin <span aria-hidden="true" class="wp-exclude-emoji">→</span> Settings <span aria-hidden="true" class="wp-exclude-emoji">→</span> MSBD Logs</strong>.</p>
<p>From this screen, administrators can:</p>
<ul>
<li>View available log files</li>
<li>Filter log files by filename</li>
<li>Inspect log file contents</li>
<li>Enable or disable debug logging</li>
</ul>
<p>Only users with the proper admin capability can access the interface. Single-site activation requires <code>manage_options</code>; network-wide activation requires <code>manage_network_options</code>.</p>
<h3>Standalone & Compatible</h3>
<p>MSBD Logs works fully as a standalone plugin.</p>
<p>If other MSBD-related plugins are installed in the future, menu grouping can be handled automatically without affecting functionality.</p>


MSBD Logs

Simple logging helper for plugin and theme developers with an admin UI to view and manage log files.

Fumiki Takahashi

TAROSKY INC.

Kunoichi INC

<p>Have you ever seen an error log like the one below?</p>
<blockquote>
<p>PHP Fatal error: Allowed memory size of xxxxxx bytes exhausted (tried to allocate xxx bytes) in /var/www/wordpress/wp-includes/wp-db.php on line 2007</p>
</blockquote>
<p>This means that <a href="https://www.php.net/manual/en/ini.core.php#ini.memory-limit" rel="nofollow ugc">PHP memory limit</a> is exhausted while retrieving data from a database. In any case, this happens when your site has big data and makes insane loops inside.</p>
<p>But we want to know that <strong>which plugin tried to retrieve data?</strong></p>
<p>Hagakure adds extra information to error.log file when <code>wp-db.php</code> causes memory limit error:</p>
<pre>[08-May-2019 10:28:37 UTC] wpdb Error Backtrace:
#1      Kunoichi\Hagakure\DbLogger->filter_query()      /app/public/wp-includes/class-wp-hook.php       Line 286
#2      WP_Hook->apply_filters()        /app/public/wp-includes/plugin.php      Line 208
#3      apply_filters   /app/public/wp-includes/wp-db.php       Line 1871
#4      wpdb->query()   /app/public/wp-includes/wp-db.php       Line 2579
#5      wpdb->get_results()     /app/public/wp-includes/class-wp-query.php      Line 2979
#6      WP_Query->get_posts()   /app/public/wp-includes/class-wp-query.php      Line 3387
#7      WP_Query->query()       /app/public/wp-includes/post.php        Line 1961
#8      get_posts       /app/public/wp-content/plugins/hagakure/hagakure.php    Line 34
#9      {closure}       /app/public/wp-includes/class-wp-hook.php       Line 286
#10     WP_Hook->apply_filters()        /app/public/wp-includes/class-wp-hook.php       Line 310
#11     WP_Hook->do_action()    /app/public/wp-includes/plugin.php      Line 465
#12     do_action       /app/public/wp-includes/template-loader.php     Line 13
#13     require_once    /app/public/wp-blog-header.php  Line 19
#14     require /app/public/index.php   Line 17
#15     URI: /?p=1</pre>
<p>This log will always follow the memory limit Fatal Error by <code>wp-db.php</code>. Now you can find <code>#8</code> calls <code>get_posts</code> repeatedly.</p>
<p>We recommend watching logs with notification services like <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html" rel="nofollow ugc">CloudWatch Logs</a>.<br />
This error occurs in the productional environment, and you may not have a chance to see it occurs.<br />
We use Hagakure with our <a href="https://hosting.kunoichiwp.com/" rel="nofollow ugc">hosting service</a>, please look forward to seeing <a href="https://kunoichiwp.com/blog" rel="nofollow ugc">our blog published</a> and describing the integration!</p>
<p>This plugin also adds debug backtrace to error logs. To modify the error level to a detailed backtrace, define the constant in <code>wp-config.php</code> or somewhere else:</p>
<pre>define( 'HAGAKURE_ERROR_LEVEL', E_NOTICE | E_USER_WARNING | E_WARNING | E_USER_ERROR );</pre>
<p>Besides that, if <code>SAVEQUERIES</code> is set <code>true</code>, the slow query log will be logged with PHP debug backtrace. This helps you to debug.</p>
<h3>Acknowledgements</h3>
<p>The base text for dummy content is “Three Ghost Story” by Charles Dickens. The text file is modified the one of <a href="https://www.gutenberg.org/ebooks/1289" rel="nofollow ugc">Project Gutenberg</a>.</p>


Hagakure – Yet Another Error Reporter

This plugin makes it easy to find the root cause of PHP Fatal error: Allowed memory size of xxxxxx bytes exhausted error. AWESOME.


Great

Looks good

A WordPress plugin to clarify meaningless errors like "Allowed memory size of xxxxxxxx bytes exhausted".

MSBD Logs vs Hagakure – Yet Another Error Reporter