DecaLog

Description

Capture and log events on your site. View them in your dashboard and send them to logging services.

DecaLog is a tool that aims to:

  • capture events generated by the core of WordPress and themes / plugins;
  • enrich these events with many details regarding their triggering;
  • record these events in the WordPress database and/or send them to external services for logging, monitoring and alerting;
  • view (and filter) events recorded in the WordPress database.

It supports multisite logs delegation (see FAQ) and contains many features to help to protect personal information (user pseudonymization, IP obfuscation, etc.).

It can be used in dev/debug phases or on production sites: it has nearly no resource impact on the server.

At this time, DecaLog can send events:

  • by mail (alerting);
  • in the browser console (for debugging purpose);
  • to its internal logging storage and viewer;
  • to external logger, like Syslog or Fluentd;
  • to external logging services, like Logentries / insightOps or Loggly;
  • to ELK stacks like Sematext or Elastic Cloud;
  • to external alerting services, like Pushover or Slack;
  • to local or network storage (with file rotation);
  • to WP-CLI console.

In addition to the events generated by your site (PHP, database, WordPress core), DecaLog logs all events from:

Your favorite plugin is not in this list? You want to send your logs to another service? Just tell me, and I will see how to add it.

DecaLog supports an extensive set of WP-CLI commands to:

  • display (past or current) events in console – see wp help log tail for details;
  • send messages to running loggers – see wp help log send for details;
  • toggle on/off main settings – see wp help log settings for details;
  • manage loggers (list, start, pause, clean, purge, remove, add and set) – see wp help log logger for details;
  • view available logger types (list and describe) – see wp help log type for details;
  • manage listeners (list, enable, disable and auto-listening toggle) – see wp help log listener for details.

For a full help on WP-CLI commands in DecaLog, please read this guide.

DecaLog is a free and open source plugin for WordPress. It integrates many other free and open source works (as-is or modified). Please, see ‘about’ tab in the plugin settings to see the details.

Developers

If you’re a plugins / themes developer and want to take advantage of the logging features of DecaLog, visit the GitHub repository of the plugin to learn how to develop a listener for your plugins / themes. Ah, and yes, it’s PSR-3 compliant 😉

Support

This plugin is free and provided without warranty of any kind. Use it at your own risk, I’m not responsible for any improper use of this plugin, nor for any damage it might cause to your site. Always backup all your data before installing a new plugin.

Anyway, I’ll be glad to help you if you encounter issues when using this plugin. Just use the support section of this plugin page.

Privacy

This plugin, as any piece of software, is neither compliant nor non-compliant with privacy laws and regulations. It is your responsibility to use it – by activating the corresponding options or services – with respect for the personal data of your users and applicable laws.

This plugin doesn’t set any cookie in the user’s browser.

This plugin may handle personally identifiable information (PII). If the GDPR or CCPA or similar regulation applies to your case, you must use the anonymization options embedded in the plugin and/or adapt your processes (consent management, security measure, treatment register, etc.).

Donation

If you like this plugin or find it useful and want to thank me for the work done, please consider making a donation to La Quadrature Du Net or the Electronic Frontier Foundation which are advocacy groups defending the rights and freedoms of citizens on the Internet. By supporting them, you help the daily actions they perform to defend our fundamental freedoms!

Screenshots

  • Set Loggers
  • Internal Viewer
  • Event Details in Internal Viewer

Installation

From your WordPress dashboard

  1. Visit ‘Plugins > Add New’.
  2. Search for ‘DecaLog’.
  3. Click on the ‘Install Now’ button.
  4. Activate DecaLog.

From WordPress.org

  1. Download DecaLog.
  2. Upload the decalog directory to your /wp-content/plugins/ directory, using your favorite method (ftp, sftp, scp, etc…).
  3. Activate DecaLog from your Plugins page.

Once Activated

  1. Visit ‘Settings > DecaLog’ in the left-hand menu of your WP Admin to adjust settings.
  2. Enjoy!

FAQ

What are the requirements for this plugin to work?

You need at least WordPress 5.2 and PHP 7.2.

Can this plugin work on multisite?

Yes. It is designed to work on multisite too. Network Admins can configure the plugin and have access to all events logs. Sites Admins have access to the events logs of their sites.

Where can I get support?

Support is provided via the official WordPress page.

Where can I find documentation?

Documentation for users is provided as the form of inline help in the plugin.

Developer’s documentation can be found in the GitHub repository of the plugin.

Where can I report a bug?

You can report bugs and suggest ideas via the GitHub issue tracker of the plugin.

Reviews

Ogwomwenda (Mutunda) 30, 2020
Very quick and effective plugin. Works great with custom SIEM integrations and forwarding services of all kinds. Highly recommend this, it's been invaluable to us.
Ogwekkumi (Mukulukusa) 24, 2019
Clear, efficient and fully customizable plugin. Will certainly install it on all my new WP projects on dev/debug and prod site state.
Ogwomwenda (Mutunda) 27, 2019
As usual with Pierre's plugins, the plugin is simple but powerful and does what it claims to do. As a website maintainer I clearly see the use of this plugin.
Read all 4 reviews

Contributors & Developers

“DecaLog” is open source software. The following people have contributed to this plugin.

Contributors

“DecaLog” has been translated into 3 locales. Thank you to the translators for their contributions.

Translate “DecaLog” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

Please, see full changelog on GitHub.