umanit/trace-user-actions

A bundle to trace user actions.

1.0.1 2022-07-13 09:36 UTC

Requires

• php: >=7.1.3
• symfony/framework-bundle: ^4.4|^5.0|^6.0
• symfony/security-bundle: ^4.4|^5.0|^6.0

MIT

• user
• trace
• actions

README

This bundle allows you to trace your user actions in a log file. By default, login and logout are trace, but you can easily add your own actions through the dispatch of en event.

For example, login and logout will be logged as follows:

[2022-07-13T09:19:23.886319+02:00] umanit_trace_user_actions.INFO: User login {"user":"[e-mail]"} []
[2022-07-13T09:19:41.715806+02:00] umanit_trace_user_actions.INFO: User logout {"user":"[e-mail]"} []

By default, logs are stored in rotating files, with a retention of 180 files which is approximately 6 months.

Installation

Use the package manager composer to install the extension.

composer require umanit/trace-user-actions

Load the bundle into your Symfony project.

<?php

# config/bundles.php
return [
    // ...
    Umanit\TraceUserActions\UmanitTraceUserActionsBundle::class => ['all' => true],
];

Configuration

There is no need to configure the bundle, it just works. However, if you want, you can modify the Monolog's configuration by overriding the umanit_trace_user_actions handler.

For example, if you want to reduce the maximum number of files:

monolog:
    handlers:
        umanit_trace_user_actions:
            max_files: 10

Usage

All actions will be logged into rotating files (one per day). The filename mask is umanit-trace-user-actions-%kernel.environment%-YYYY-MM-DD.log.

If you want to log your own actions, you have to dispatch a new UserActionEvent, for example:

function deleteProductAction(Product $product, EventDispatcherInterface $eventDispatcher): Response
{
    // [...]
    $eventDispatcher->dispatch(new UserActionEvent(sprintf('Delete product "%s"', $product->getName()), $this->getUser()));
    // [...]
}

This action will be logged as follows:

[2022-07-13T10:15:27.962118+02:00] umanit_trace_user_actions.INFO: Delete product "Example product" {"user":"[e-mail]"} []

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT