https://github.com/os2web/os2web_audit

https://github.com/os2web/os2web_audit

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/os2web/os2web_audit
• Owner: OS2web
• Created: 2024-04-25T08:52:19.000Z (8 months ago)
• Default Branch: develop
• Last Pushed: 2024-10-21T10:24:57.000Z (2 months ago)
• Last Synced: 2024-10-23T11:53:56.029Z (2 months ago)
• Language: PHP
• Size: 48.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• 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.

## 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

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'

```

## 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);

```