Plugin Directory

Changeset 3466619


Ignore:
Timestamp:
02/21/2026 10:05:42 PM (16 hours ago)
Author:
inspiredplugins
Message:

Updated readme.txt file with additional information and FAQs

Location:
logtastic
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • logtastic/tags/1.0.0/readme.txt

    r3458281 r3466619  
    1515A comprehensive logging plugin for WordPress with big ambitions. Our initial release focuses on error logging in WordPress. Planned future features include email logging, http request logging, user activity logging, alerts and notifications, and more...
    1616
    17 = PHP Error Log =
     17### 👉 PHP Error Log
     18
     19Log PHP errors on your WordPress site, with configurable options for error levels, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and arguments, and display with the plugins stack trace visualiser. Log editing functions allow you to delete and ignore specific errors.
    1820
    1921https://www.youtube.com/watch?v=nZt-O15-KqM
    2022
    21 Log PHP errors on your WordPress site, with configurable options for error levels, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and arguments, and display with the plugins stack trace visualiser. Log editing functions allow you to delete and ignore specific errors.
    22 
    23 = JavaScript Error Log =
     23#### Features
     24
     25- Log all PHP errors on your site, including WordPress core, plugin and theme errors
     26- Capture stack traces with full arguments, and display with our unique stack trace visualiser
     27- Delete and ignore specific errors
     28- Configurable log retention settings
     29
     30#### Configurable Options
     31
     32- Error levels
     33- Scope (include/exclude WP core, specific plugins and themes)
     34- Capture stack traces
     35- Capture stack trace arguments
     36- Log retention time
     37
     38#### Documentation
     39
     40For more indepth guidance on how to configure and use the PHP error log, please take a look at our detailed plugin documentation:
     41
     42- [Configuring the PHP error log](https://logtastic.net/support/documentation/php-error-log/configuring-the-php-error-log/)
     43- [Viewing the PHP Error Log](https://logtastic.net/support/documentation/php-error-log/viewing-the-php-error-log/)
     44- [Understanding PHP Error Levels](https://logtastic.net/support/documentation/php-error-log/understanding-php-error-levels/)
     45
     46### 👉 JavaScript Error Log
     47
     48Log JavaScript errors on your WordPress site, with configurable options for error types, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and additional session information. Log editing functions allow you to delete and ignore specific errors.
    2449
    2550https://www.youtube.com/watch?v=un80Va1Xths
    2651
    27 Log JavaScript errors on your WordPress site, with configurable options for error types, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and additional session information. Log editing functions allow you to delete and ignore specific errors.
    28 
    29 = Security & Visibility =
     52#### Features
     53
     54- Log JavaScript runtime errors and uncaught promise rejections on your site, including WordPress core, plugin and theme errors
     55- Capture stack traces
     56- Capture session information
     57- Delete and ignore specific errors
     58- Configurable log retention settings
     59
     60#### Configurable Options
     61
     62- Error types
     63- Scope (include/exclude WP core, specific plugins and themes)
     64- Capture stack traces
     65- Capture session information
     66- Log retention time
     67
     68#### Documentation
     69
     70For more indepth guidance on how to configure and use the JavaScript error log, please take a look at our detailed plugin documentation:
     71
     72- [Configuring the JavaScript error log](https://logtastic.net/support/documentation/javascript-error-log/configuring-the-javascript-error-log/)
     73- [Viewing the JavaScript Error Log](https://logtastic.net/support/documentation/javascript-error-log/viewing-the-javascript-error-log/)
     74
     75### 👉 Security & Visibility
     76
    3077Configurable options to define which roles can view and edit logs.
    3178
     79#### Documentation
     80
     81For more indepth guidance on how to configure and the plugins access and visibility settings, please take a look at our detailed plugin documentation:
     82
     83- [Configuring Plugin Access & Visibility](https://logtastic.net/support/documentation/access-and-visibility-settings/configuring-plugin-access-and-visibility/)
     84
     85### 🔜 Coming Soon
     86
     87More exciting features are on the way...
     88
     89- __HTTP Request Log:__ Log HTTP requests, including page not found and redirect errors.
     90- __Email Log:__ Log HTTP requests, including page not found and redirect errors.
     91- __Email Log:__ Log sent emails with option to resend and forward.
     92- __Alerts & Notifications:__ Customizable email alerts for key events.
     93
     94Take a look at our [roadmap](https://logtastic.net/roadmap/) for more details of our planned future features.
     95
     96#### Have an idea?
     97
     98Have an idea for a new feature or enhancement? [Tell us](https://logtastic.net/support/submit-idea/), and if we like it we'll add it to the roadmap.
     99
     100### 🛟 Help & Support
     101
     102For further help and support with the Logtastic plugin, please take a look at our detailed [plugin documentation](https://logtastic.net/support/documentation/), or contact us via the [support forum](https://wordpress.org/support/plugin/logtastic/).
     103
     104- [Plugin Documentation](https://logtastic.net/support/documentation/)
     105- [Support Forum](https://wordpress.org/support/plugin/logtastic/)
     106
     107### ⭐ Leave Your Feedback
     108
     109Your feedback is really important to us. If you have the time, please [leave a review](https://wordpress.org/support/plugin/logtastic/reviews/) for the Logtastic plugin.
    32110
    33111== Screenshots ==
     
    371153. PHP Error Log - view stack trace modal.
    381164. JavaScript Error Log - main log page.
     117
     118== Installation ==
     119
     120= Minimum Requirements =
     121
     122* WordPress version 6.2 or higher
     123* PHP version 7.0 or higher
     124* MySQL version 5.7 or higher / MariaDB version 10.3 or higher
     125
     126= Installation =
     127
     1281. Install using the WordPress built-in plugin installer, or Extract the zip file and upload the contents to the `wp-content/plugins/` directory of your WordPress installation.
     1292. Activate the plugin through the 'Plugins' menu in WordPress.
     1303. Go to Logtastic > Settings.
     1314. Enable the logs you wish to use.
     1325. Configure the plugin's general settings and the settings for each invidual log to suit your requirements.
     133
     134For further help and support with the Logtastic plugin, including guidance on installing and configuring the plugin, please take a look at our detailed [plugin documentation](https://logtastic.net/support/documentation/). If you have any questions, you can contact us via the [support forum](https://wordpress.org/support/plugin/logtastic/).
     135
     136== Frequently Asked Questions ==
     137
     138**What will the Logtastic plugin log?**
     139
     140The first release of the Logtastic plugin focuses on error logging in WordPress, capturing PHP and JavaScript errors. Take a look at our roadmap for our planned future features, including HTTP request logging, email logging and more.
     141
     142**PHP Error Log: What type of errors can the PHP error log capture?**
     143
     144The PHP error log can capture all PHP errors, including fatal errors, uncaught exceptions and recoverable errors. You can configure which error types are captured from the log settings.
     145
     146**PHP Error Log: What data is recorded for each PHP error?**
     147
     148The PHP error log will capture the following data for each error:
     149
     150- Error message
     151- File
     152- Line number
     153- Error source (plugin, theme or WP core)
     154- First occurred date/time
     155- Last occurred date/time
     156- Number of occurrences
     157
     158For each occurrence of an error, the following additional data will be captured:
     159
     160- Date/time
     161- WordPress version
     162- PHP version
     163- Plugin/theme version (if applicable)
     164- Full stack trace (optional)
     165- Affected user (pro version only)
     166
     167**PHP Error Log: How are errors captured?**
     168
     169The Logtastic plugin uses 3 methods to capture PHP errors on your WordPress site:
     170
     171- __Custom Error Handler:__ The plugin defines a custom error handler that will capture all recoverable PHP errors on your site, for example warnings.
     172- __Custom Exception Handler:__ The plugin defines a custom error handler that will capture all uncaught exceptions on your WordPress site. Uncaught exceptions will proceed to generate a fatal error if left uncaught – as such, the plugin logs these uncaught exceptions as fatal errors.
     173- __Shutdown Function:__ The plugin defines a custom shutdown function, which will run after PHP has finished executing the current script. This captures any fatal errors which were not the result of uncaught exceptions.
     174
     175Each function will determine whether or not the error should be logged, based on your log settings, and log the error/occurrence if it meets your defined criteria.
     176
     177**JavaScript Error Log: What type of errors can the JavaScript error log capture?**
     178
     179The JavaScript error log can capture runtime errors (errors that occur while code is executing, e.g. calling an undefined function or accessing a missing variable) and unhandled promise rejections (failures from promises – async operations – that aren’t caught with a .catch() or try…catch).
     180
     181**JavaScript Error Log: What data is recorded for each JavaScript error?**
     182
     183The JavaScript error log will capture the following data for each error:
     184
     185- Error message
     186- Source
     187- Line and column number
     188- Error source (plugin, theme or WP core)
     189- First occurred date/time
     190- Last occurred date/time
     191- Number of occurrences
     192
     193For each occurrence of an error, the following additional data will be captured:
     194
     195- Date/time
     196- WordPress version
     197- Plugin/theme version (if applicable)
     198- Stack trace (optional)
     199- Additional session information, including the url where the error was encountered and the user agent (optional)
     200- Affected user (pro version only)
     201
     202
     203**JavaScript Error Log: How are errors captured?**
     204
     205The Logtastic plugin loads a lightweight JavaScript file (less than 4kb) on each page of your WordPress site. The JavaScript will listen for errors, and when encountered will capture the error, process the stack trace and send this via an Ajax request to the backend logging function.
     206
     207The backend logging function will determine whether or not the error should be logged, based on your log settings, and log the error/occurrence if it meets your defined criteria.
     208
     209**How is the log data stored?**
     210
     211Logtastic leverages custom database tables to efficiently store and manage data, ensuring faster queries, reduced bloat in default WordPress tables, and improved scalability. By separating logs from core WP data, it delivers better performance, cleaner organization, and greater flexibility for advanced reporting and data handling—making it ideal for high-traffic sites and large-volume workloads.
     212
     213**Will it impact my site performance?**
     214
     215Our plugin is designed to have minimal impact on performance. It stores log entries in optimized custom database tables rather than crowding WordPress core tables, allowing it to write and retrieve data efficiently even on high-traffic sites. Logging runs in the background with lightweight queries, meaning your site continues to operate smoothly while still capturing valuable information for debugging and monitoring.
     216
     217**I have another question not listed here...**
     218
     219For further help and support with the Logtastic plugin, please take a look at our detailed [plugin documentation](https://logtastic.net/support/documentation/), or contact us via the [support forum](https://wordpress.org/support/plugin/logtastic/).
     220
     221
     222== Changelog ==
     223
     224= 1.0.0 - 2026-02-10 =
     225* First Release: The first release of the Logtastic plugin.
  • logtastic/trunk/readme.txt

    r3458281 r3466619  
    1515A comprehensive logging plugin for WordPress with big ambitions. Our initial release focuses on error logging in WordPress. Planned future features include email logging, http request logging, user activity logging, alerts and notifications, and more...
    1616
    17 = PHP Error Log =
     17### 👉 PHP Error Log
     18
     19Log PHP errors on your WordPress site, with configurable options for error levels, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and arguments, and display with the plugins stack trace visualiser. Log editing functions allow you to delete and ignore specific errors.
    1820
    1921https://www.youtube.com/watch?v=nZt-O15-KqM
    2022
    21 Log PHP errors on your WordPress site, with configurable options for error levels, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and arguments, and display with the plugins stack trace visualiser. Log editing functions allow you to delete and ignore specific errors.
    22 
    23 = JavaScript Error Log =
     23#### Features
     24
     25- Log all PHP errors on your site, including WordPress core, plugin and theme errors
     26- Capture stack traces with full arguments, and display with our unique stack trace visualiser
     27- Delete and ignore specific errors
     28- Configurable log retention settings
     29
     30#### Configurable Options
     31
     32- Error levels
     33- Scope (include/exclude WP core, specific plugins and themes)
     34- Capture stack traces
     35- Capture stack trace arguments
     36- Log retention time
     37
     38#### Documentation
     39
     40For more indepth guidance on how to configure and use the PHP error log, please take a look at our detailed plugin documentation:
     41
     42- [Configuring the PHP error log](https://logtastic.net/support/documentation/php-error-log/configuring-the-php-error-log/)
     43- [Viewing the PHP Error Log](https://logtastic.net/support/documentation/php-error-log/viewing-the-php-error-log/)
     44- [Understanding PHP Error Levels](https://logtastic.net/support/documentation/php-error-log/understanding-php-error-levels/)
     45
     46### 👉 JavaScript Error Log
     47
     48Log JavaScript errors on your WordPress site, with configurable options for error types, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and additional session information. Log editing functions allow you to delete and ignore specific errors.
    2449
    2550https://www.youtube.com/watch?v=un80Va1Xths
    2651
    27 Log JavaScript errors on your WordPress site, with configurable options for error types, scope and log retention. View errors in an easy to digest, searchable and filterable report. Optionally capture full error stack traces and additional session information. Log editing functions allow you to delete and ignore specific errors.
    28 
    29 = Security & Visibility =
     52#### Features
     53
     54- Log JavaScript runtime errors and uncaught promise rejections on your site, including WordPress core, plugin and theme errors
     55- Capture stack traces
     56- Capture session information
     57- Delete and ignore specific errors
     58- Configurable log retention settings
     59
     60#### Configurable Options
     61
     62- Error types
     63- Scope (include/exclude WP core, specific plugins and themes)
     64- Capture stack traces
     65- Capture session information
     66- Log retention time
     67
     68#### Documentation
     69
     70For more indepth guidance on how to configure and use the JavaScript error log, please take a look at our detailed plugin documentation:
     71
     72- [Configuring the JavaScript error log](https://logtastic.net/support/documentation/javascript-error-log/configuring-the-javascript-error-log/)
     73- [Viewing the JavaScript Error Log](https://logtastic.net/support/documentation/javascript-error-log/viewing-the-javascript-error-log/)
     74
     75### 👉 Security & Visibility
     76
    3077Configurable options to define which roles can view and edit logs.
    3178
     79#### Documentation
     80
     81For more indepth guidance on how to configure and the plugins access and visibility settings, please take a look at our detailed plugin documentation:
     82
     83- [Configuring Plugin Access & Visibility](https://logtastic.net/support/documentation/access-and-visibility-settings/configuring-plugin-access-and-visibility/)
     84
     85### 🔜 Coming Soon
     86
     87More exciting features are on the way...
     88
     89- __HTTP Request Log:__ Log HTTP requests, including page not found and redirect errors.
     90- __Email Log:__ Log HTTP requests, including page not found and redirect errors.
     91- __Email Log:__ Log sent emails with option to resend and forward.
     92- __Alerts & Notifications:__ Customizable email alerts for key events.
     93
     94Take a look at our [roadmap](https://logtastic.net/roadmap/) for more details of our planned future features.
     95
     96#### Have an idea?
     97
     98Have an idea for a new feature or enhancement? [Tell us](https://logtastic.net/support/submit-idea/), and if we like it we'll add it to the roadmap.
     99
     100### 🛟 Help & Support
     101
     102For further help and support with the Logtastic plugin, please take a look at our detailed [plugin documentation](https://logtastic.net/support/documentation/), or contact us via the [support forum](https://wordpress.org/support/plugin/logtastic/).
     103
     104- [Plugin Documentation](https://logtastic.net/support/documentation/)
     105- [Support Forum](https://wordpress.org/support/plugin/logtastic/)
     106
     107### ⭐ Leave Your Feedback
     108
     109Your feedback is really important to us. If you have the time, please [leave a review](https://wordpress.org/support/plugin/logtastic/reviews/) for the Logtastic plugin.
    32110
    33111== Screenshots ==
     
    371153. PHP Error Log - view stack trace modal.
    381164. JavaScript Error Log - main log page.
     117
     118== Installation ==
     119
     120= Minimum Requirements =
     121
     122* WordPress version 6.2 or higher
     123* PHP version 7.0 or higher
     124* MySQL version 5.7 or higher / MariaDB version 10.3 or higher
     125
     126= Installation =
     127
     1281. Install using the WordPress built-in plugin installer, or Extract the zip file and upload the contents to the `wp-content/plugins/` directory of your WordPress installation.
     1292. Activate the plugin through the 'Plugins' menu in WordPress.
     1303. Go to Logtastic > Settings.
     1314. Enable the logs you wish to use.
     1325. Configure the plugin's general settings and the settings for each invidual log to suit your requirements.
     133
     134For further help and support with the Logtastic plugin, including guidance on installing and configuring the plugin, please take a look at our detailed [plugin documentation](https://logtastic.net/support/documentation/). If you have any questions, you can contact us via the [support forum](https://wordpress.org/support/plugin/logtastic/).
     135
     136== Frequently Asked Questions ==
     137
     138**What will the Logtastic plugin log?**
     139
     140The first release of the Logtastic plugin focuses on error logging in WordPress, capturing PHP and JavaScript errors. Take a look at our roadmap for our planned future features, including HTTP request logging, email logging and more.
     141
     142**PHP Error Log: What type of errors can the PHP error log capture?**
     143
     144The PHP error log can capture all PHP errors, including fatal errors, uncaught exceptions and recoverable errors. You can configure which error types are captured from the log settings.
     145
     146**PHP Error Log: What data is recorded for each PHP error?**
     147
     148The PHP error log will capture the following data for each error:
     149
     150- Error message
     151- File
     152- Line number
     153- Error source (plugin, theme or WP core)
     154- First occurred date/time
     155- Last occurred date/time
     156- Number of occurrences
     157
     158For each occurrence of an error, the following additional data will be captured:
     159
     160- Date/time
     161- WordPress version
     162- PHP version
     163- Plugin/theme version (if applicable)
     164- Full stack trace (optional)
     165- Affected user (pro version only)
     166
     167**PHP Error Log: How are errors captured?**
     168
     169The Logtastic plugin uses 3 methods to capture PHP errors on your WordPress site:
     170
     171- __Custom Error Handler:__ The plugin defines a custom error handler that will capture all recoverable PHP errors on your site, for example warnings.
     172- __Custom Exception Handler:__ The plugin defines a custom error handler that will capture all uncaught exceptions on your WordPress site. Uncaught exceptions will proceed to generate a fatal error if left uncaught – as such, the plugin logs these uncaught exceptions as fatal errors.
     173- __Shutdown Function:__ The plugin defines a custom shutdown function, which will run after PHP has finished executing the current script. This captures any fatal errors which were not the result of uncaught exceptions.
     174
     175Each function will determine whether or not the error should be logged, based on your log settings, and log the error/occurrence if it meets your defined criteria.
     176
     177**JavaScript Error Log: What type of errors can the JavaScript error log capture?**
     178
     179The JavaScript error log can capture runtime errors (errors that occur while code is executing, e.g. calling an undefined function or accessing a missing variable) and unhandled promise rejections (failures from promises – async operations – that aren’t caught with a .catch() or try…catch).
     180
     181**JavaScript Error Log: What data is recorded for each JavaScript error?**
     182
     183The JavaScript error log will capture the following data for each error:
     184
     185- Error message
     186- Source
     187- Line and column number
     188- Error source (plugin, theme or WP core)
     189- First occurred date/time
     190- Last occurred date/time
     191- Number of occurrences
     192
     193For each occurrence of an error, the following additional data will be captured:
     194
     195- Date/time
     196- WordPress version
     197- Plugin/theme version (if applicable)
     198- Stack trace (optional)
     199- Additional session information, including the url where the error was encountered and the user agent (optional)
     200- Affected user (pro version only)
     201
     202
     203**JavaScript Error Log: How are errors captured?**
     204
     205The Logtastic plugin loads a lightweight JavaScript file (less than 4kb) on each page of your WordPress site. The JavaScript will listen for errors, and when encountered will capture the error, process the stack trace and send this via an Ajax request to the backend logging function.
     206
     207The backend logging function will determine whether or not the error should be logged, based on your log settings, and log the error/occurrence if it meets your defined criteria.
     208
     209**How is the log data stored?**
     210
     211Logtastic leverages custom database tables to efficiently store and manage data, ensuring faster queries, reduced bloat in default WordPress tables, and improved scalability. By separating logs from core WP data, it delivers better performance, cleaner organization, and greater flexibility for advanced reporting and data handling—making it ideal for high-traffic sites and large-volume workloads.
     212
     213**Will it impact my site performance?**
     214
     215Our plugin is designed to have minimal impact on performance. It stores log entries in optimized custom database tables rather than crowding WordPress core tables, allowing it to write and retrieve data efficiently even on high-traffic sites. Logging runs in the background with lightweight queries, meaning your site continues to operate smoothly while still capturing valuable information for debugging and monitoring.
     216
     217**I have another question not listed here...**
     218
     219For further help and support with the Logtastic plugin, please take a look at our detailed [plugin documentation](https://logtastic.net/support/documentation/), or contact us via the [support forum](https://wordpress.org/support/plugin/logtastic/).
     220
     221
     222== Changelog ==
     223
     224= 1.0.0 - 2026-02-10 =
     225* First Release: The first release of the Logtastic plugin.
Note: See TracChangeset for help on using the changeset viewer.