Personal tools
Namespaces

Variants
Actions

Logs

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Logs)
(→‎About Logs Tool)
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
=About Logs=
+
<meta name="keywords" content="modulesgarden logs tool, modulesgarden logs tool configuration, modulesgarden logs tool management, modulesgarden logs tool common problems, about modulesgarden logs tool, modulesgarden logs tool documentation, modulesgarden logs tool faq, modulesgarden logs tool help, modulesgarden logs tool guide, modulesgarden logs tool wiki, modulesgarden logs tool tutorial, modulesgarden logs tool tips, whmcs logs tool docs , logs tool whmcs docs"></meta>
 +
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The ModulesGarden Logs Tool."></meta>
 +
 
 +
=About Logs Tool=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|The '''Logs''' tool offers a system for monitoring and maintaining module activity records.<br/>
+
|style="padding: 10px 0px 10px 0px;"|The '''Logs''' tool is an integral feature of ModulesGarden addons, designed to monitor and manage module activity records.<br/> With categorized log types, filters, and detailed views, the review process of module activities is simplified. Administrators can adjust logging settings, export logs, or automate log deletion using configurable rules. <br/>
−
With categorized log types, filters, and detailed views, it simplifies reviewing module activities.<br/>
+
Utilize the rule-based deletion feature or bulk delete option to help keep logs organized and manageable.<br/>
−
Administrators can adjust logging settings, export logs, or automate log deletion based on rules. <br/>
+
−
Features like rule-based deletion and mass-delete options help keep logs organized and manageable.<br/>
+
−
Important: Some modules do not feature up-to-date versions of the tool, future updates will include the newest version.
+
 
|}
 
|}
 +
 
*'''Available in Addon Modules:'''
 
*'''Available in Addon Modules:'''
 
{|
 
{|
Line 19: Line 20:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ cPanel Manage2 For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ cPanel Manage2 For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Discount Center For WHMCS
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ DNS Manager For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ DNS Manager For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Domain & Email Forwarding For WHMCS
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Domain Orders Extended For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ Domain Orders Extended For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Domains Reseller For WHMCS
 
|}
 
|}
 
{|
 
{|
Line 49: Line 59:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ IP Manager For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ IP Manager For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Marketing Triggers Automation For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Multibrand For WHMCS
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ OVHcloud VPS & Dedicated Servers For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ OVHcloud VPS & Dedicated Servers For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Password Manager For WHMCS
 
|}
 
|}
 
{|
 
{|
Line 67: Line 86:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Products Reseller For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ Products Reseller For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ QuickBooks Desktop For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ QuickBooks Online For WHMCS
 
|}
 
|}
 
{|
 
{|
Line 76: Line 101:
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ Report Generator For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ Report Generator For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Resellers Center For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Server Monitoring For WHMCS
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 0px 30px;"|✔ SMS Center For WHMCS
 
|style="padding: 0px 0px 0px 30px;"|✔ SMS Center For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Social Media Login For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Support Tickets Allocator For WHMCS
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Time & Task Manager For WHMCS
 
|}
 
|}
 
{|
 
{|
Line 95: Line 135:
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|The '''Logs''' can be located in one of two places, depending on the layout of the addon module menu.<br/> It may either appear directly in the main menu or under the '' "Other" '' section, grouped with a few additional features. ''(This placement is typically used when the addon includes a large number of menu entries).''
+
|style="padding: 10px 0px 30px 15px;"|The '''Logs''' section can be found in one of two locations, depending on the layout of the addon module menu.<br/> It may appear directly in the main menu, or, it can be located under the '' "Other" '' section, grouped with a few additional features, this solution is visualized on the exemplary Vultr For WHMCS module below.<br/> '''''Note:''' This placement is typically used when the addon includes a large number of menu entries.''<br/>
 +
 
 +
'''''Important:''' Certain modules may not yet include the latest version of this tool, but upcoming updates will ensure access to the most current features.''
 
|}
 
|}
 +
 +
==Log Details==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Depending on the module, logs can be categorized into several types.<br/>You can filter the module logs by type with the '' 'Show' '' buttons:
+
|style="padding: 10px 0px 15px 15px;"|Depending on the module, logs can be categorized into several types.<br/>  
 +
You can filter the module logs by type with the '' 'Show' '' buttons:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:L_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:L_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can see log details by clicking on the '' 'Details' '' button.<br/>
+
|style="padding: 10px 0px 15px 15px;"|You can see log details by clicking on the '' 'Details' '' button.<br/>
 
Some logs might not include details.
 
Some logs might not include details.
 
|}
 
|}
Line 120: Line 165:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:L_4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:L_4.png]]
 
|}
 
|}
 +
 +
==Additional Actions==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Additional actions include:
+
|style="padding: 10px 0px 15px 15px;"|In the top-right corner, after clicking the burger menu, you will find a list of available additional actions, including:
−
*'''Logging Settings'''
+
*'''[[#Settings|Settings]]'''
−
*'''Log Export'''
+
*'''[[#Exporting_Logs|Export CSV]]'''
−
*'''Rule Based Deletion'''
+
*'''[[#Rule_Based_Deletion|Delete]]'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:L_5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:L_5.png]]
 
|}
 
|}
 +
 +
===Settings===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|In the settings you may decide:
+
|style="padding: 10px 0px 15px 15px;"|In the settings, you can configure the following options:
 
*'''Log Types''' - specify which types of logs should be recorded.
 
*'''Log Types''' - specify which types of logs should be recorded.
 
*'''Clear Automatically''' - choose whether to automatically delete logs older than a defined number of days.
 
*'''Clear Automatically''' - choose whether to automatically delete logs older than a defined number of days.
Line 138: Line 187:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:L_6.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:L_6.png]]
 
|}
 
|}
 +
 +
===Exporting Logs===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|While exporting you will have to specify which logs to export:
+
|style="padding: 10px 0px 15px 15px;"|While exporting your logs to a CSV file, you will need to specify the following details:
−
*'''From''' - define the starting date for logs to export.
+
*'''From''' - define the starting date for the logs you wish to export.
−
*'''To''' - define the ending date for logs to export.
+
*'''To''' - define the ending datefor the logs you wish to export.
−
*'''Log Types''' - select which type of logs to export, this differs between modules.
+
*'''Log Types''' - choose the type of logs to export, which may vary depending on the module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:L_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:L_7.png]]
 
|}
 
|}
 +
 +
===Rule Based Deletion===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can also delete specific logs without finding them manually.<br/> Simply define:
+
|style="padding: 10px 0px 15px 15px;"|You can delete specific logs automatically without having to select them manually. To set this up, define the following:
−
*'''Log Types''' - specify which log types should be considered for removal.
+
*'''Log Types''' - choose which types of logs should be considered for deletion.
−
*'''Delete Logs Older Than''' - define the number of days after the log occurrence for automatic deletion.
+
*'''Delete Logs Older Than''' - set the number of days after the log's occurrence for automatic deletion.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:L_8.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:L_8.png]]
 
|}
 
|}

Latest revision as of 12:48, 10 February 2025

Contents

[edit] About Logs Tool

The Logs tool is an integral feature of ModulesGarden addons, designed to monitor and manage module activity records.
With categorized log types, filters, and detailed views, the review process of module activities is simplified. Administrators can adjust logging settings, export logs, or automate log deletion using configurable rules.

Utilize the rule-based deletion feature or bulk delete option to help keep logs organized and manageable.

  • Available in Addon Modules:
✔ Abandoned Cart For WHMCS
✔ Advanced Billing For WHMCS
✔ Cloud Billing For WHMCS
✔ cPanel Manage2 For WHMCS
✔ Discount Center For WHMCS
✔ DNS Manager For WHMCS
✔ Domain & Email Forwarding For WHMCS
✔ Domain Orders Extended For WHMCS
✔ Domains Reseller For WHMCS
✔ Email Notifications Organizer For WHMCS
✔ Emoji Picker For WHMCS
✔ Freshdesk For WHMCS
✔ Freshservice For WHMCS
✔ Google Analytics For WHMCS
✔ Hosting Quota Notifications For WHMCS
✔ Hosting Renewals For WHMCS
✔ IP Manager For WHMCS
✔ Marketing Triggers Automation For WHMCS
✔ Multibrand For WHMCS
✔ OVHcloud VPS & Dedicated Servers For WHMCS
✔ Password Manager For WHMCS
✔ Payment Gateway Charges For WHMCS
✔ Product Cross-Selling For WHMCS
✔ Product Free Trial Manager For WHMCS
✔ Product Linker For WHMCS
✔ Products Reseller For WHMCS
✔ QuickBooks Desktop For WHMCS
✔ QuickBooks Online For WHMCS
✔ Quotes Automation For WHMCS
✔ Recurring Contract Billing For WHMCS
✔ Report Generator For WHMCS
✔ Resellers Center For WHMCS
✔ Server Monitoring For WHMCS
✔ SMS Center For WHMCS
✔ Social Media Login For WHMCS
✔ Support Tickets Allocator For WHMCS
✔ Time & Task Manager For WHMCS
✔ Unban Center For WHMCS
✔ Vultr VPS For WHMCS
✔ WordPress Manager For WHMCS
✔ Zendesk For WHMCS

[edit] Management

The Logs section can be found in one of two locations, depending on the layout of the addon module menu.
It may appear directly in the main menu, or, it can be located under the "Other" section, grouped with a few additional features, this solution is visualized on the exemplary Vultr For WHMCS module below.
Note: This placement is typically used when the addon includes a large number of menu entries.

Important: Certain modules may not yet include the latest version of this tool, but upcoming updates will ensure access to the most current features.

[edit] Log Details

Depending on the module, logs can be categorized into several types.

You can filter the module logs by type with the 'Show' buttons:

L 1.png
You can see log details by clicking on the 'Details' button.

Some logs might not include details.

L 2.png
Log details might look like this:
L 3.png
You can delete logs either one by one or with the mass delete function.
L 4.png

[edit] Additional Actions

In the top-right corner, after clicking the burger menu, you will find a list of available additional actions, including:
L 5.png

[edit] Settings

In the settings, you can configure the following options:
  • Log Types - specify which types of logs should be recorded.
  • Clear Automatically - choose whether to automatically delete logs older than a defined number of days.
  • Delete Logs Older Than - define the number of days after which logs will be automatically deleted.
L 6.png

[edit] Exporting Logs

While exporting your logs to a CSV file, you will need to specify the following details:
  • From - define the starting date for the logs you wish to export.
  • To - define the ending datefor the logs you wish to export.
  • Log Types - choose the type of logs to export, which may vary depending on the module.
L 7.png

[edit] Rule Based Deletion

You can delete specific logs automatically without having to select them manually. To set this up, define the following:
  • Log Types - choose which types of logs should be considered for deletion.
  • Delete Logs Older Than - set the number of days after the log's occurrence for automatic deletion.
L 8.png
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Logs&oldid=74560"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community