https://github.com/os2web/os2web_audit
https://github.com/os2web/os2web_audit
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/os2web/os2web_audit
- Owner: OS2web
- Created: 2024-04-25T08:52:19.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-10-29T08:56:33.000Z (5 months ago)
- Last Synced: 2026-01-15T13:41:40.681Z (2 months ago)
- Language: PHP
- Size: 219 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 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/`.
```shell
composer require os2web/os2web_audit
drush pm:enable os2web_audit
```
## 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.
```shell
drush audit:log 'This is a test message'
```
### Retry jobs
The module also comes with methods for retrying failed jobs in the
`os2web_audit` queue.
```shell
drush audit:retry-failed-jobs
```
Per default, it simply retries all failed jobs however it comes with
the following options:
```shell
--id[=ID] Retry a specific job by ID (e.g. 1245.)
--ignore-state Retry job regardless of state. This only effects the --id option.
--limit[=LIMIT] Retry (up to) a limited number of jobs. Minimum: 1, Maximum: 5000, Default 1000.
```
## 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:
```php
$msg = sprintf('Fetch personal data from service with parameter: %s', $param);
$this->auditLogger->info('Lookup', $msg);
```
### Queue
The actual logging is handled by jobs in an [Advanced
Queue](https://www.drupal.org/project/advancedqueue) queue.
The queue, OS2Web audit (`os2web_audit`), must be
processed by a server `cron` job, e.g.
```sh
drush advancedqueue:queue:process os2web_audit
```
List the queue (and all other queues) with
```sh
drush advancedqueue:queue:list
```
or go to `/admin/config/system/queues/jobs/os2web_audit` for a
graphical overview of jobs in the queue.
### Coding standards
#### PHP files (PHP_CodeSniffer)
Check PHP coding standards
```shell
docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer install
docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer coding-standards-check
```
Apply coding standard changes
```shell
docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer install
docker run --interactive --rm --volume ${PWD}:/app itkdev/php8.3-fpm:latest composer coding-standards-apply
```
### Code analysis
phpstan is used to perform static analysis of the code. Run the following script:
```sh
./scripts/code-analysis
```
#### Markdown files
```shell
docker run --interactive --rm --volume "$PWD:/md" itkdev/markdownlint markdownlint '**/*.md' --fix
docker run --interactive --rm --volume "$PWD:/md" itkdev/markdownlint markdownlint '**/*.md'
```