Child pages
  • Log Monitoring and Notification - Magento 2
Skip to end of metadata
Go to start of metadata

Icon

Firefox user notice:

Please use different web browser to view this document.

Sorry for the inconvenience.


Log Monitoring and Notification for Magento 2

Magento 2 Log Monitoring and Notification tracks and analyzes log errors and reports and provides enhanced email notification and cron configuration parameters.

Compatibility: Magento Open Source 2.2.X, Magento Commerce 2.2.X

   Product Page

Thank you for choosing Aheadworks!


Installing Log Monitoring and Notification

1. Unpack the zip file provided in the root folder of your Magento 2 installation.

2. From the command prompt, run the following:
bin/magento module:enable Neklo_Core
bin/magento module:enable Neklo_LogMonitoring
bin/magento setup:upgrade
bin/magento setup:static-content:deploy

 


Introducing Log Monitoring and Notification

The Magento 2 Log Monitoring and Notification module is an advanced analytical and management solution that monitors Magento logs and reports right from the admin panel.

Extension Logic

The extension introduces the var/log and var/report grids listing all the necessary log error and report data. Besides monitoring, it provides the following features:

  • Email notifications with adjustable log error levels;
  • Enhanced Cron settings for data control (flushing, archiving, fetching, removing).


Backend Configuration

Extension Settings

To enable this Magento log monitoring extension in your store:

  1. Log in to your Admin Panel;
  2. Go to Stores > Configuration > Neklo and choose 'Log Monitoring';
  3. In the 'General Settings' section, choose Yes in the 'Monitoring Enabled' field;
  4. Click to apply the changes.

General Settings

Email Settings

Email settings configure notifications about new and repeated errors accumulated into the var/reports and var/log folders, email notification recipients and sending frequency.

Email Settings

To enable automatic email notifications of var/report and var/log errors:

  • Go to Configuration > Email settings;
  • Choose Yes in the 'Enable Notification' field;
  • Click to apply the changes.

New Log Notification Example

New Report Notification Example

If you want to get reminder notifications about the errors after a certain period of time, choose Yes in the 'Enable Repeated Notification' field.

You can set the preferred period of time (in days) to receive repeated error notifications in the 'Send Repeated Email in' field. By default, the value is set to 7.

Click to apply the changes.

Repeated Log Notification Example

Repeated Report Notification Example

You can specify users who will get notifications in the 'Email Recipients' field.

To add a new recipient, click and enter an email address. You can add more than one email.

To delete the email address, click the trash bin box next to the email field.

To select one or several levels of errors you want to be notified of, mark them in the 'Select var/log Error Level to Send Notification Email' multi-select field.

Click to apply the changes.

To select one or several levels of errors you want to be notified of, mark error levels in the 'Select var/log Error Level to Send Notification Email' multi-select field.

Click to apply the changes.

Cron Settings

With the Cron settings, you can assign time and frequency of cron jobs for managing data in the var/ report and var/log grids and DB tables.

Cron Settings

The 'Flush Log Data Table' option sets the frequency of data flush from the 'var/log' grid and the connected database table. By default, table flush launches once a day.

In the 'Archive Log Data Table After Flushing' field, you can enable the archiving for the var/log data. If enabled, the data from the 'var/log' grid will be saved to the separate database table.

The 'Flush Archive Log Data Table' option defines the frequency of data flush in the 'Archive Log Data' table

In the 'var/report Folder Data Fetching Frequency' field, you can set how often the data from the var/report folder should be fetched into the extension's specific database table.

The 'Flush Report Data Table' parameter sets the frequency of data flush in the 'var/report' grid and the connected database table. By default, table flush launches once a day.

If the 'Remove Report Files After Table Flushing' setting is enabled, there will be specific files removed from the var/report folder after the 'var/report' grid data flush. Use this option with caution. Deleted files cannot be restored.

Click to apply the changes.

var/log and var/report Grids

To view the 'var/log' and 'var/report' grids, log in to admin panel and go to Reports > Log Monitoring. Choose the grid you want to view: var/log or var/report.

The 'var/log' grid reflects the log error data, including the error ID, file, error type, message, and the time the error was created, updated, and notified to email recipients.

The 'var/report' grid reflects the report data, including the report title, the time it was created, updated and notified to email recipients.

To fetch the data into the grid manually, click .

Both grids are developed using the native Magento UI components so that you can export grid records in csv/xml and filter the data by grid properties. Also, you can remove records or email them:

  1. Indicate the items you need to be included in the email with a check mark in the first grid column;
  2. Expand the 'Actions' box;
  3. Choose the 'Send Email' option and specify the recipients: send to my email (currently logged in the user’s email), another recipient stated in the configuration, or all recipients.

To open a full log or report message, click 'View' in the 'Action' column.

Log Info Page

Report Info Page

To remove items from the grids:

  1. Indicate the items you want to delete with a check mark in the first grid column;
  2. Expand the 'Actions' box and choose Delete Logs'/'Delete Reports.

Support

Thank you for installing the extension. You can find more our great solutions for Magento 1 and Magento 2 here: store.neklo.com.

Product Page

Need Customization?

Magento 2 Custom Development Services by Aheadworks


You can always find the latest version of the software, full documentation, demos, screenshots, and reviews on http://ecommerce.aheadworks.com

License agreement: https://ecommerce.aheadworks.com/end-user-license-agreement/
Contact Us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2018 Aheadworks Co. http://www.aheadworks.com

  • No labels