Log Cleaner Plugin

Introduction

This article features the Log Cleaner Plugin and sample app created by Mokxa Technologies, LLC. This plugin was created to add in a process tool or scheduler to clear the API logs, Scheduler logs and Audit trail logs from the Joget database with duration from 8 days to 90 days old. It is used to delete old log data from these tables to maintain the database size. This article showcases the functionality and capability of this plugin.

Prerequisite

This plugin requires Joget DX Enterprise version.

Plugin Information

Plugins Available in the Bundle:

1. Log Cleaner (Process Tool)

This plugin bundle is compatible with Joget DX 8 and onwards.

To download this plugin, visit the Joget Marketplace.

For any issues related to this plugin, visit the Log Cleaner Plugin Github page.

Steps to install

1. In the Joget App Center, navigate to Settings > Manage Plugins > Upload Plugin and click Choose File.
2.  Select the Log Clearner jar file and click Add. The plugin is listed in the Installed Plugins tab once uploaded.
3. In a new app or an existing app, create a new process in the App Composer page.
4. In Process Builder, add a Tool component to the participant and connect it to the Start component. 
5. Click the Tool component and in the Mapping tab, select Log Cleaner in the Tools drop-down list.

Usage

Log Cleaner Plugin Properties

Fields to configure:

• Log Type: Select the logs from the Joget database that will be deleted. The following are the available options:
  • API Logs: Deletes logs from the api_log table.
  • Schedule Logs: Deletes logs from the sch_job_log table.
  • Audit Logs: Deletes logs from the wf_audit_trail table.
• Duration: Select the number of days before a log is deleted. The following are the available options:
  • 8 days
  • 15 days
  • 30 days
  • 60 days
  • 90 days

Using the Log Cleaner Plugin with the Scheduler Plugin

After creating an app with the Log Cleaner Plugin, that app can also be used with the Scheduler Plugin to trigger the log cleaning process when a specific event occurs, for example, clear logs on the first day of each month. When configuring the Scheduler Plugin properties, select the app containing the Log Cleaner Plugin for the App field and the Log Cleaner Plugin for the Plugin field.

Fields to configure:

• Job Name: Specify a name for the scheduled job.
• Cron Expression: A cron expression is a string comprising five or six fields separated by white space that represents a set of times, normally as a schedule to execute some routine.
• App: Select the app containing the Log Cleaner Plugin
• Plugin: Select the Log Cleaner Plugin.

Expected Outcome

The selected log type database table will be cleared after the expected duration elapses. This is reflected in the Web App Log Viewer as displayed in the image below.

Download Sample App

Credits

This plugin, sample app and documentation are created by Mokxa Technologies, LLC.