erik-perri/m2-event-log

This package is abandoned and no longer maintained. No replacement package was suggested.

Magento 2 plugin to log events.

dev-master 2020-10-29 05:23 UTC

Requires

• php: ~7.1.3||~7.2.0||~7.3.0||~7.4.0
• ext-dom: *
• ext-intl: *
• ext-libxml: *
• magento/module-backend: 100.2.*||101.0.*||102.0.*
• magento/module-catalog: 102.0.*||103.0.*||104.0.*
• magento/module-eav: 101.0.*||102.0.*||102.1.*
• pelago/emogrifier: v2.2.0||v3.1.0

MIT

README

Magento 2 plugin to log events.

It currently only logs a limited set of the stock Magneto 2 admin actions and is mostly intended for use by developers creating sites that have background tasks which need a visible log in the admin.

Logging Example

/** @var \Magento\Framework\Event\ManagerInterface $eventManager */

// Add an info event.  This would be rendered in the "Admin Log" group admin events get logged to.
$eventManager->dispatch('event_log_info', [
    'group' => 'admin',
    'message' => 'Banner {banner} {action}.',
    'context' => [
        'banner' => [
            'text' => $banner->getName(),
            'id' => $banner->getId(),
        ],
        'action' => $banner->isObjectNew() ? 'created' : 'modified',
    ],
]);

Placeholders are used in the message for translatability (not yet implemented). When the processor encounters an array as the placeholder value it will use the text array value for the replace text. In the above example only the banner name will be displayed in the log unless a custom handler is created to make use of the id field.

See custom-placeholders for a placeholder handler example.

Your code should not rely on Event Log plugin code to add events or it will fail if the Event Log plugin is removed or disabled. For that reason you should always call the generic Magento 2 event dispatcher to add logs.

Events

event_log_info

Logs a standard entry.

event_log_error

Logs an error which will be rendered with a red background.

event_log_warning

Logs a warning which will be rendered with a yellow background.

event_log_security

Logs a security entry which renders the same as warning but will always render all entries, regardless of the hide duplicates setting.

Event Options

group

Type: String

The group id to render the message with. If the group is not handled by a custom renderer it will use the standard renderer with the supplied group id converted to title case.

message

Type: String

The event log message. Dynamic portions, or HTML, should use {curly-brackets} and the context array. The string is passed through an HTML escaper before processing the placeholders.

context

Type: Array

The context for the event log message. The context can include non-string values (as long as they can be encoded in json) but any keys referenced in the message string must either be strings or arrays that contain a text key. If they do not the message will not be recorded.

user-context

Type: Array|Boolean

The user context to include with the event log message. If included or set to true the code will attempt to find the current user and attach it to a hidden context field. This will be used to render the user column in the log view.

License

MIT