Download the PHP package os2web/os2web_audit without Composer
On this page you can find all versions of the php package os2web/os2web_audit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download os2web/os2web_audit
More information about os2web/os2web_audit
Files in os2web/os2web_audit
Package os2web_audit
Short Description Drupal OS2 module that provides audit logging for Danish Municipalities
License EUPL-1.2
Informations about the package os2web_audit
OS2Web Audit
This audit module can be used to track changes and perform audit logging on drupal sites.
Features
This module includes three plugins that facilitate logging information to Loki, files, or to the database through Drupal's watchdog logger.
These logging providers are designed using Drupal's plugin APIs. Consequently, it opens up possibilities for creating new AuditLogger plugins within other modules, thus enhancing the functionality of this audit logging.
For performance purposes we use a queue system. This avoids hindering performance more than necessary as the actual logging is done async. Furthermore, this allows for retries in case any audit log plugins should fail.
Installation
Enable the module and go to the modules setting page at
/admin/config/os2web_audit/settings/.
Drush
Test audit log
The module provides a Drush command named audit:log. This command enables you to log a test message to the configured logger. The audit:log command accepts a string that represents the message to be logged.
The message provided, will be logged twice, once as an informational message and once as an error message.
Retry jobs
The module also comes with methods for retrying failed jobs in the
os2web_audit queue.
Per default, it simply retries all failed jobs however it comes with the following options:
Usage
The module exposes a simple Logger service which can log an info and error
messages.
Inject the logger service named os2web_audit.logger and send messages into the
logger as shown below:
Implementations
See implementations for a list of modules that have audit logging integrated.
Queue
The actual logging is handled by jobs in an Advanced Queue queue.
The queue, OS2Web audit (os2web_audit), must be
processed by a server cron job, e.g.
List the queue (and all other queues) with
or go to /admin/config/system/queues/jobs/os2web_audit for a
graphical overview of jobs in the queue.
Purge successful jobs
It is possible to configure the queue to purge jobs based on the number of jobs or the number of days since processing.
Go to admin/config/system/queues/manage/os2web_audit to configure this.
Below is an example of purging successful jobs after 7 days.
Remember to export this to ensure it is not overridden upon config import.
Coding standards
PHP files (PHP_CodeSniffer)
Check PHP coding standards
Apply coding standard changes
Code analysis
phpstan is used to perform static analysis of the code. Run the following script:
Markdown files
All versions of os2web_audit with dependencies
php Version ^8.1
drupal/advancedqueue Version ^1.2
drush/drush Version ^11|^12|^13