View employee performance metrics.
ProcessMaker Platform is built on the Laravel framework. Laravel Horizon is a robust queue monitoring solution. Use Laravel Horizon to monitor key metrics of your queue system such as job throughput, runtime, and job failures.
In context with ProcessMaker Platform, a job is any action in which ProcessMaker must perform. A job is something that ProcessMaker Platform must run for it to function properly.
Below are examples of jobs:
A Request is started.
A queue manages and monitors the sequence of jobs that ProcessMaker Platform must run. When a job is called, that job enters the queue. If there is no delay to run the job, the queue loads that job to run as soon as possible. However, some jobs are intentionally delayed from running immediately such as a Start Timer Event element in a Request.
The queue has the following functions:
The queue manages pending jobs regardless of whether a job is to run as soon as possible or at a later time.
The queue monitors how efficiently jobs run. Queue Management indicates via dashboard metrics job throughput in the queue.
A failed job is one in which ProcessMaker Platform has unsuccessfully attempted to run a job three (3) times. Thereafter, the job has failed. Queue Management displays failed jobs in both the Dashboard and the Failed page.
Assign “tags” to jobs to more easily search for and monitor jobs. At this time, tags are not enabled in ProcessMaker Platform's implementation of Laravel Horizon.
View recent ProcessMaker Platform jobs.
Queue Management displays a table of recently run jobs in the Recent Jobs panel.
Follow these steps to view the Recent Jobs panel in Queue Management:
View Queue Management. The Dashboard displays.
Select the Recent Jobs link. The Recent Jobs panel displays.
The Recent Jobs panel displays the following information about recently run jobs:
Job: The Job column displays the name of the recently run job.
On: The On column displays the name of the queue from which the job ran.
Tags: The Tags column displays the tag(s) associated with the job.
Queued At: The Queued At column displays the date and time in which the job entered its queue.
Runtime: The Runtime column displays how much time in seconds the recently run job took to complete.
If more than 25 jobs display in the Recent Jobs panel, then the following occurs:
The Next navigation button displays.
The Previous navigation button enables.
Use the Next and Previous navigation buttons to navigate multiple pages of recently run jobs.
The Queue Management Dashboard provides an overview of your ProcessMaker Platform instance's status, throughput, and workload.
The Queue Management Dashboard displays an overview of your ProcessMaker Platform instance's status. The Dashboard displays by default in Queue Management.
Follow these steps to view the Queue Management Dashboard:
Log on to ProcessMaker Platform.
Click the Admin option from the top menu. The Users page displays.
Click Dashboard to view the Dashboard from another Queue Management page.
The Dashboard displays in the Overview panel the following metrics about your ProcessMaker Platform instance:
Jobs Past Hour: The Jobs Past Hour metric displays how many jobs ran in the queue in the past hour.
Failed Jobs Past Hour: The Failed Jobs Past Hour metric displays how many queued jobs failed in the past hour. See View Recently Failed Jobs.
Status: The Status metric displays the status of the ProcessMaker Platform instance. The following status types are possible:
Active: The ProcessMaker Platform instance is active.
Inactive: The ProcessMaker Platform instance is inactive.
Error: The ProcessMaker Platform instance has an error.
Total Processes: The Total Processes metric displays how many processes the job queue is using.
Max Wait Time: The Max Wait Time metric displays the maximum wait time the queue has required to run a recent job in real-time. If there is no wait time, then this metric displays the following: -.
Max Runtime: The Max Runtime metric displays the name of the job queue that has the maximum runtime. default
is the name of the default queue.
Max Throughput: The Max Throughput metric displays the name of the job queue that has the maximum throughput. default
is the name of the default queue.
The Dashboard displays in the Current Workload panel the following information about the jobs queue:
Queue: The Queue column displays the name of the jobs queue.
Processes: The Processes column displays how many processes the job queue is using.
Jobs: The Jobs column displays how many jobs are active presently.
Wait: The Wait column displays an indicator of how much time is required to run all jobs in the queue.
The Dashboard displays a panel labeled with the name of the ProcessMaker Platform instance that contains the following information:
Supervisor: The Supervisor column displays the supervisor name. The supervisor monitors the default queue.
Processes: The Processes column displays how many processes the job queue is using.
Queues: The Queues column displays the name(s) of the job queue(s).
Balancing: The Balancing column displays the balancing strategy to manage jobs in the queue(s). The Simple strategy splits incoming jobs evenly between processes.
Click the Queue Management icon from the left sidebar. The Queue Management Dashboard displays.
View metrics for ProcessMaker Platform jobs and queues.
Queue Management displays job and queue metrics in the Metrics panel.
Follow these steps to view the Metrics panel in Queue Management:
View Queue Management. The Dashboard displays.
Select the Metrics link. The Metrics panel displays.
Follow these steps to view job metrics in Queue Management:
View the Metrics panel in Queue Management. The Jobs tab displays recently run jobs.
Click a recently run job to view throughput and run-time metrics for that job.
Follow these steps to view queue metrics in Queue Management:
View the Metrics panel in Queue Management. The Jobs tab displays.
Click the Queues tab to display all queues in ProcessMaker.
Click a queue to view throughput and run-time metrics for that queue.
View recently failed ProcessMaker Platform jobs.
Queue Management displays a table of the last seven (7) days of failed jobs in the Failed Jobs panel. After a failed job is older than seven days, that failed job disappears from the Failed Jobs panel.
Follow these steps to view the Failed Jobs panel in Queue Management:
View Queue Management. The Dashboard displays.
Select the Failed link. The Failed Jobs panel displays.
The Failed Jobs panel displays the following information about failed jobs:
On: The On column displays the name of the queue from which the job failed.
Tags: The Tags column displays the tag(s) associated with the job.
Runtime: The Runtime column displays how much time in seconds the failed job ran.
Failed At: The Failed At column displays the date and time the job failed.
If more than 25 failed jobs display in the Failed Jobs panel, then the Next and Previous navigation buttons enable. Use the Next and Previous navigation buttons to navigate multiple pages of failed jobs.
Job: The Jobs column displays the name of the failed job. Click the failed job's name to view the error(s) associated with the failed job. Optionally, click the Retry iconto retry running the failed job.
Retry: Click the Retry iconfor the failed job to retry running it.