FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caleeli merged 5 commits into from
Jan 17, 2025
Merged

FOUR-21035 Implement Task Execution Time by Customer #7894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f0133be
Add timestamps in milliseconds to process_request_tokens table
caleeli Jan 13, 2025
0f92336
Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…
caleeli Jan 13, 2025
12c28ec
Add Prometheus metric for activity execution time
caleeli Jan 13, 2025
2e6bfde
Update Main Dashboard to include Task Completion Timing report
caleeli Jan 13, 2025
b7375b8
Update MillisecondsToDateCast to specify return types for get and se…
caleeli Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions ProcessMaker/Casts/MillisecondsToDateCast.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
/**
* Cast the given value.
*
* @param Model $model
* @param string $key
* @param mixed $value
* @param array<string, mixed> $attributes
*
* @return Carbon|null
*/
public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
{
return $value ? Carbon::createFromTimestampMs($value) : null;
}

/**
* Prepare the given value for storage.
*
* @param Model $model
* @param string $key
* @param mixed $value
* @param array<string, mixed> $attributes
*
* @return float|null
*/
public function set(Model $model, string $key, mixed $value, array $attributes): float|null
{
return $value ? Carbon::parse($value)->valueOf() : null;
}
}
27 changes: 27 additions & 0 deletions ProcessMaker/Listeners/BpmnSubscriber.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
}
Log::info('Activity completed: ' . json_encode($token->getProperties()));

// Prometheus Metric: Activity Execution Time
$startTime = $token->created_at_ms;
$completedTime = $token->completed_at_ms;
$executionTime = $completedTime->diffInMilliseconds($startTime);
Metrics::histogram(
'activity_execution_time_seconds',
'Activity Execution Time',
[
'activity_id',
'activity_name',
'element_type',
'process_id',
'request_id',
],
[1, 10, 3600, 86400]
)->observe(
$executionTime,
[
'activity_id' => $token->element_id,
'activity_name' => $token->element_name,
'element_type' => $token->element_type,
'process_id' => $token->process_id,
'request_id' => $token->process_request_id,
]
);

if ($token->element_type == 'task') {
$notifiables = $token->getNotifiables('completed');
Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down
5 changes: 5 additions & 0 deletions ProcessMaker/Models/ProcessRequestToken.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
* @property Carbon $riskchanges_at
* @property Carbon $updated_at
* @property Carbon $created_at
* @property Carbon $created_at_ms
* @property Carbon $completed_at_ms
* @property ProcessRequest $processRequest
*
* @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
'token_properties' => 'array',
'is_priority' => 'boolean',
'is_actionbyemail' => 'boolean',
'created_at_ms' => MillisecondsToDateCast::class,
'completed_at_ms' => MillisecondsToDateCast::class,
];

/**
Expand Down
8 changes: 8 additions & 0 deletions ProcessMaker/Observers/ProcessRequestTokenObserver.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
}
}

public function creating(ProcessRequestToken $token)
{
$token->created_at_ms = now();
}

/**
* Once a token is saved, it also saves the version reference of the
* screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
public function saving(ProcessRequestToken $token)
{
$token->saveVersion();
if ($token->completed_at && $token->isDirty('completed_at')) {
$token->completed_at_ms = now();
}
}
}
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down
30 changes: 30 additions & 0 deletions database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
/**
* Run the migrations.
*/
public function up(): void
{
Schema::table('process_request_tokens', function (Blueprint $table) {
$table->bigInteger('created_at_ms')->nullable();
$table->bigInteger('completed_at_ms')->nullable();
});
}

/**
* Reverse the migrations.
*/
public function down(): void
{
Schema::table('process_request_tokens', function (Blueprint $table) {
$table->dropColumn('created_at_ms');
$table->dropColumn('completed_at_ms');
});
}
};
79 changes: 78 additions & 1 deletion resources/grafana/MainDashboard.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
],
"title": "Tasks Completed",
"type": "barchart"
},
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
},
"description": "Time a task was completed",
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"fieldMinMax": false,
"mappings": [],
"min": 0,
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
},
{
"color": "red",
"value": 80
}
]
},
"unit": "ms"
},
"overrides": []
},
"gridPos": {
"h": 8,
"w": 12,
"x": 0,
"y": 16
},
"id": 5,
"interval": "15s",
"options": {
"minVizHeight": 75,
"minVizWidth": 75,
"orientation": "auto",
"reduceOptions": {
"calcs": [],
"fields": "",
"values": false
},
"showThresholdLabels": false,
"showThresholdMarkers": true,
"sizing": "auto"
},
"pluginVersion": "11.4.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
},
"disableTextWrap": false,
"editorMode": "code",
"exemplar": false,
"expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
"format": "time_series",
"fullMetaSearch": false,
"includeNullMetadata": true,
"instant": false,
"interval": "",
"legendFormat": "{{activity_name}} (process={{process_id}})",
"range": true,
"refId": "A",
"useBackend": false
}
],
"title": "Task Execution Time",
"type": "gauge"
}
],
"schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
"timezone": "browser",
"title": "ProcessMaker Dashboard",
"uid": "be96wxsnlmn7kc",
"version": 23,
"version": 29,
"weekStart": ""
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

caleeli
merged 5 commits into

from

Jan 17, 2025
 Merged


FOUR-21035 Implement Task Execution Time by Customer
#7894
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
f0133be

Add timestamps in milliseconds to process_request_tokens table


caleeli Jan 13, 2025
0f92336

Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…


caleeli Jan 13, 2025
12c28ec

Add Prometheus metric for activity execution time


caleeli Jan 13, 2025
2e6bfde

Update Main Dashboard to include Task Completion Timing report


caleeli Jan 13, 2025
b7375b8

Update MillisecondsToDateCast to specify return types for get and se…


caleeli Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 40 additions & 0 deletions
ProcessMaker/Casts/MillisecondsToDateCast.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
 /**
 * Cast the given value.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return Carbon|null
 */
 public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
 {
 return $value ? Carbon::createFromTimestampMs($value) : null;
 }

 /**
 * Prepare the given value for storage.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return float|null
 */
 public function set(Model $model, string $key, mixed $value, array $attributes): float|null
 {
 return $value ? Carbon::parse($value)->valueOf() : null;
 }
}

27 changes: 27 additions & 0 deletions
ProcessMaker/Listeners/BpmnSubscriber.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
 }
 Log::info('Activity completed: ' . json_encode($token->getProperties()));

 // Prometheus Metric: Activity Execution Time
 $startTime = $token->created_at_ms;
 $completedTime = $token->completed_at_ms;
 $executionTime = $completedTime->diffInMilliseconds($startTime);
 Metrics::histogram(
 'activity_execution_time_seconds',
 'Activity Execution Time',
 [
 'activity_id',
 'activity_name',
 'element_type',
 'process_id',
 'request_id',
 ],
 [1, 10, 3600, 86400]
 )->observe(
 $executionTime,
 [
 'activity_id' => $token->element_id,
 'activity_name' => $token->element_name,
 'element_type' => $token->element_type,
 'process_id' => $token->process_id,
 'request_id' => $token->process_request_id,
 ]
 );

 if ($token->element_type == 'task') {
 $notifiables = $token->getNotifiables('completed');
 Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down

5 changes: 5 additions & 0 deletions
ProcessMaker/Models/ProcessRequestToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
 * @property Carbon $riskchanges_at
 * @property Carbon $updated_at
 * @property Carbon $created_at
 * @property Carbon $created_at_ms
 * @property Carbon $completed_at_ms
 * @property ProcessRequest $processRequest
 *
 * @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
 'token_properties' => 'array',
 'is_priority' => 'boolean',
 'is_actionbyemail' => 'boolean',
 'created_at_ms' => MillisecondsToDateCast::class,
 'completed_at_ms' => MillisecondsToDateCast::class,
 ];

 /**
Expand Down

8 changes: 8 additions & 0 deletions
ProcessMaker/Observers/ProcessRequestTokenObserver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
 }
 }

 public function creating(ProcessRequestToken $token)
 {
 $token->created_at_ms = now();
 }

 /**
 * Once a token is saved, it also saves the version reference of the
 * screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
 public function saving(ProcessRequestToken $token)
 {
 $token->saveVersion();
 if ($token->completed_at && $token->isDirty('completed_at')) {
 $token->completed_at_ms = now();
 }
 }
}

4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down

30 changes: 30 additions & 0 deletions
database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
 /**
 * Run the migrations.
 */
 public function up(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->bigInteger('created_at_ms')->nullable();
 $table->bigInteger('completed_at_ms')->nullable();
 });
 }

 /**
 * Reverse the migrations.
 */
 public function down(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->dropColumn('created_at_ms');
 $table->dropColumn('completed_at_ms');
 });
 }
};

79 changes: 78 additions & 1 deletion
resources/grafana/MainDashboard.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
 ],
 "title": "Tasks Completed",
 "type": "barchart"
 },
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "description": "Time a task was completed",
 "fieldConfig": {
 "defaults": {
 "color": {
 "mode": "thresholds"
 },
 "fieldMinMax": false,
 "mappings": [],
 "min": 0,
 "thresholds": {
 "mode": "absolute",
 "steps": [
 {
 "color": "green",
 "value": null
 },
 {
 "color": "red",
 "value": 80
 }
 ]
 },
 "unit": "ms"
 },
 "overrides": []
 },
 "gridPos": {
 "h": 8,
 "w": 12,
 "x": 0,
 "y": 16
 },
 "id": 5,
 "interval": "15s",
 "options": {
 "minVizHeight": 75,
 "minVizWidth": 75,
 "orientation": "auto",
 "reduceOptions": {
 "calcs": [],
 "fields": "",
 "values": false
 },
 "showThresholdLabels": false,
 "showThresholdMarkers": true,
 "sizing": "auto"
 },
 "pluginVersion": "11.4.0",
 "targets": [
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "disableTextWrap": false,
 "editorMode": "code",
 "exemplar": false,
 "expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
 "format": "time_series",
 "fullMetaSearch": false,
 "includeNullMetadata": true,
 "instant": false,
 "interval": "",
 "legendFormat": "{{activity_name}} (process={{process_id}})",
 "range": true,
 "refId": "A",
 "useBackend": false
 }
 ],
 "title": "Task Execution Time",
 "type": "gauge"
 }
 ],
 "schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
 "timezone": "browser",
 "title": "ProcessMaker Dashboard",
 "uid": "be96wxsnlmn7kc",
 "version": 23,
 "version": 29,
 "weekStart": ""
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

caleeli
merged 5 commits into

from

Jan 17, 2025
 Merged


FOUR-21035 Implement Task Execution Time by Customer
#7894
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
f0133be

Add timestamps in milliseconds to process_request_tokens table


caleeli Jan 13, 2025
0f92336

Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…


caleeli Jan 13, 2025
12c28ec

Add Prometheus metric for activity execution time


caleeli Jan 13, 2025
2e6bfde

Update Main Dashboard to include Task Completion Timing report


caleeli Jan 13, 2025
b7375b8

Update MillisecondsToDateCast to specify return types for get and se…


caleeli Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 40 additions & 0 deletions
ProcessMaker/Casts/MillisecondsToDateCast.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
 /**
 * Cast the given value.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return Carbon|null
 */
 public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
 {
 return $value ? Carbon::createFromTimestampMs($value) : null;
 }

 /**
 * Prepare the given value for storage.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return float|null
 */
 public function set(Model $model, string $key, mixed $value, array $attributes): float|null
 {
 return $value ? Carbon::parse($value)->valueOf() : null;
 }
}

27 changes: 27 additions & 0 deletions
ProcessMaker/Listeners/BpmnSubscriber.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
 }
 Log::info('Activity completed: ' . json_encode($token->getProperties()));

 // Prometheus Metric: Activity Execution Time
 $startTime = $token->created_at_ms;
 $completedTime = $token->completed_at_ms;
 $executionTime = $completedTime->diffInMilliseconds($startTime);
 Metrics::histogram(
 'activity_execution_time_seconds',
 'Activity Execution Time',
 [
 'activity_id',
 'activity_name',
 'element_type',
 'process_id',
 'request_id',
 ],
 [1, 10, 3600, 86400]
 )->observe(
 $executionTime,
 [
 'activity_id' => $token->element_id,
 'activity_name' => $token->element_name,
 'element_type' => $token->element_type,
 'process_id' => $token->process_id,
 'request_id' => $token->process_request_id,
 ]
 );

 if ($token->element_type == 'task') {
 $notifiables = $token->getNotifiables('completed');
 Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down

5 changes: 5 additions & 0 deletions
ProcessMaker/Models/ProcessRequestToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
 * @property Carbon $riskchanges_at
 * @property Carbon $updated_at
 * @property Carbon $created_at
 * @property Carbon $created_at_ms
 * @property Carbon $completed_at_ms
 * @property ProcessRequest $processRequest
 *
 * @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
 'token_properties' => 'array',
 'is_priority' => 'boolean',
 'is_actionbyemail' => 'boolean',
 'created_at_ms' => MillisecondsToDateCast::class,
 'completed_at_ms' => MillisecondsToDateCast::class,
 ];

 /**
Expand Down

8 changes: 8 additions & 0 deletions
ProcessMaker/Observers/ProcessRequestTokenObserver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
 }
 }

 public function creating(ProcessRequestToken $token)
 {
 $token->created_at_ms = now();
 }

 /**
 * Once a token is saved, it also saves the version reference of the
 * screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
 public function saving(ProcessRequestToken $token)
 {
 $token->saveVersion();
 if ($token->completed_at && $token->isDirty('completed_at')) {
 $token->completed_at_ms = now();
 }
 }
}

4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down

30 changes: 30 additions & 0 deletions
database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
 /**
 * Run the migrations.
 */
 public function up(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->bigInteger('created_at_ms')->nullable();
 $table->bigInteger('completed_at_ms')->nullable();
 });
 }

 /**
 * Reverse the migrations.
 */
 public function down(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->dropColumn('created_at_ms');
 $table->dropColumn('completed_at_ms');
 });
 }
};

79 changes: 78 additions & 1 deletion
resources/grafana/MainDashboard.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
 ],
 "title": "Tasks Completed",
 "type": "barchart"
 },
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "description": "Time a task was completed",
 "fieldConfig": {
 "defaults": {
 "color": {
 "mode": "thresholds"
 },
 "fieldMinMax": false,
 "mappings": [],
 "min": 0,
 "thresholds": {
 "mode": "absolute",
 "steps": [
 {
 "color": "green",
 "value": null
 },
 {
 "color": "red",
 "value": 80
 }
 ]
 },
 "unit": "ms"
 },
 "overrides": []
 },
 "gridPos": {
 "h": 8,
 "w": 12,
 "x": 0,
 "y": 16
 },
 "id": 5,
 "interval": "15s",
 "options": {
 "minVizHeight": 75,
 "minVizWidth": 75,
 "orientation": "auto",
 "reduceOptions": {
 "calcs": [],
 "fields": "",
 "values": false
 },
 "showThresholdLabels": false,
 "showThresholdMarkers": true,
 "sizing": "auto"
 },
 "pluginVersion": "11.4.0",
 "targets": [
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "disableTextWrap": false,
 "editorMode": "code",
 "exemplar": false,
 "expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
 "format": "time_series",
 "fullMetaSearch": false,
 "includeNullMetadata": true,
 "instant": false,
 "interval": "",
 "legendFormat": "{{activity_name}} (process={{process_id}})",
 "range": true,
 "refId": "A",
 "useBackend": false
 }
 ],
 "title": "Task Execution Time",
 "type": "gauge"
 }
 ],
 "schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
 "timezone": "browser",
 "title": "ProcessMaker Dashboard",
 "uid": "be96wxsnlmn7kc",
 "version": 23,
 "version": 29,
 "weekStart": ""
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

caleeli
merged 5 commits into

from

Jan 17, 2025
 Merged


FOUR-21035 Implement Task Execution Time by Customer
#7894
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
f0133be

Add timestamps in milliseconds to process_request_tokens table


caleeli Jan 13, 2025
0f92336

Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…


caleeli Jan 13, 2025
12c28ec

Add Prometheus metric for activity execution time


caleeli Jan 13, 2025
2e6bfde

Update Main Dashboard to include Task Completion Timing report


caleeli Jan 13, 2025
b7375b8

Update MillisecondsToDateCast to specify return types for get and se…


caleeli Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 40 additions & 0 deletions
ProcessMaker/Casts/MillisecondsToDateCast.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
 /**
 * Cast the given value.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return Carbon|null
 */
 public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
 {
 return $value ? Carbon::createFromTimestampMs($value) : null;
 }

 /**
 * Prepare the given value for storage.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return float|null
 */
 public function set(Model $model, string $key, mixed $value, array $attributes): float|null
 {
 return $value ? Carbon::parse($value)->valueOf() : null;
 }
}

27 changes: 27 additions & 0 deletions
ProcessMaker/Listeners/BpmnSubscriber.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
 }
 Log::info('Activity completed: ' . json_encode($token->getProperties()));

 // Prometheus Metric: Activity Execution Time
 $startTime = $token->created_at_ms;
 $completedTime = $token->completed_at_ms;
 $executionTime = $completedTime->diffInMilliseconds($startTime);
 Metrics::histogram(
 'activity_execution_time_seconds',
 'Activity Execution Time',
 [
 'activity_id',
 'activity_name',
 'element_type',
 'process_id',
 'request_id',
 ],
 [1, 10, 3600, 86400]
 )->observe(
 $executionTime,
 [
 'activity_id' => $token->element_id,
 'activity_name' => $token->element_name,
 'element_type' => $token->element_type,
 'process_id' => $token->process_id,
 'request_id' => $token->process_request_id,
 ]
 );

 if ($token->element_type == 'task') {
 $notifiables = $token->getNotifiables('completed');
 Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down

5 changes: 5 additions & 0 deletions
ProcessMaker/Models/ProcessRequestToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
 * @property Carbon $riskchanges_at
 * @property Carbon $updated_at
 * @property Carbon $created_at
 * @property Carbon $created_at_ms
 * @property Carbon $completed_at_ms
 * @property ProcessRequest $processRequest
 *
 * @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
 'token_properties' => 'array',
 'is_priority' => 'boolean',
 'is_actionbyemail' => 'boolean',
 'created_at_ms' => MillisecondsToDateCast::class,
 'completed_at_ms' => MillisecondsToDateCast::class,
 ];

 /**
Expand Down

8 changes: 8 additions & 0 deletions
ProcessMaker/Observers/ProcessRequestTokenObserver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
 }
 }

 public function creating(ProcessRequestToken $token)
 {
 $token->created_at_ms = now();
 }

 /**
 * Once a token is saved, it also saves the version reference of the
 * screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
 public function saving(ProcessRequestToken $token)
 {
 $token->saveVersion();
 if ($token->completed_at && $token->isDirty('completed_at')) {
 $token->completed_at_ms = now();
 }
 }
}

4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down

30 changes: 30 additions & 0 deletions
database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
 /**
 * Run the migrations.
 */
 public function up(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->bigInteger('created_at_ms')->nullable();
 $table->bigInteger('completed_at_ms')->nullable();
 });
 }

 /**
 * Reverse the migrations.
 */
 public function down(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->dropColumn('created_at_ms');
 $table->dropColumn('completed_at_ms');
 });
 }
};

79 changes: 78 additions & 1 deletion
resources/grafana/MainDashboard.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
 ],
 "title": "Tasks Completed",
 "type": "barchart"
 },
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "description": "Time a task was completed",
 "fieldConfig": {
 "defaults": {
 "color": {
 "mode": "thresholds"
 },
 "fieldMinMax": false,
 "mappings": [],
 "min": 0,
 "thresholds": {
 "mode": "absolute",
 "steps": [
 {
 "color": "green",
 "value": null
 },
 {
 "color": "red",
 "value": 80
 }
 ]
 },
 "unit": "ms"
 },
 "overrides": []
 },
 "gridPos": {
 "h": 8,
 "w": 12,
 "x": 0,
 "y": 16
 },
 "id": 5,
 "interval": "15s",
 "options": {
 "minVizHeight": 75,
 "minVizWidth": 75,
 "orientation": "auto",
 "reduceOptions": {
 "calcs": [],
 "fields": "",
 "values": false
 },
 "showThresholdLabels": false,
 "showThresholdMarkers": true,
 "sizing": "auto"
 },
 "pluginVersion": "11.4.0",
 "targets": [
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "disableTextWrap": false,
 "editorMode": "code",
 "exemplar": false,
 "expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
 "format": "time_series",
 "fullMetaSearch": false,
 "includeNullMetadata": true,
 "instant": false,
 "interval": "",
 "legendFormat": "{{activity_name}} (process={{process_id}})",
 "range": true,
 "refId": "A",
 "useBackend": false
 }
 ],
 "title": "Task Execution Time",
 "type": "gauge"
 }
 ],
 "schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
 "timezone": "browser",
 "title": "ProcessMaker Dashboard",
 "uid": "be96wxsnlmn7kc",
 "version": 23,
 "version": 29,
 "weekStart": ""
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

caleeli
merged 5 commits into

from

Jan 17, 2025
 Merged


FOUR-21035 Implement Task Execution Time by Customer
#7894
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
f0133be

Add timestamps in milliseconds to process_request_tokens table


caleeli Jan 13, 2025
0f92336

Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…


caleeli Jan 13, 2025
12c28ec

Add Prometheus metric for activity execution time


caleeli Jan 13, 2025
2e6bfde

Update Main Dashboard to include Task Completion Timing report


caleeli Jan 13, 2025
b7375b8

Update MillisecondsToDateCast to specify return types for get and se…


caleeli Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 40 additions & 0 deletions
ProcessMaker/Casts/MillisecondsToDateCast.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
 /**
 * Cast the given value.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return Carbon|null
 */
 public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
 {
 return $value ? Carbon::createFromTimestampMs($value) : null;
 }

 /**
 * Prepare the given value for storage.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return float|null
 */
 public function set(Model $model, string $key, mixed $value, array $attributes): float|null
 {
 return $value ? Carbon::parse($value)->valueOf() : null;
 }
}

27 changes: 27 additions & 0 deletions
ProcessMaker/Listeners/BpmnSubscriber.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
 }
 Log::info('Activity completed: ' . json_encode($token->getProperties()));

 // Prometheus Metric: Activity Execution Time
 $startTime = $token->created_at_ms;
 $completedTime = $token->completed_at_ms;
 $executionTime = $completedTime->diffInMilliseconds($startTime);
 Metrics::histogram(
 'activity_execution_time_seconds',
 'Activity Execution Time',
 [
 'activity_id',
 'activity_name',
 'element_type',
 'process_id',
 'request_id',
 ],
 [1, 10, 3600, 86400]
 )->observe(
 $executionTime,
 [
 'activity_id' => $token->element_id,
 'activity_name' => $token->element_name,
 'element_type' => $token->element_type,
 'process_id' => $token->process_id,
 'request_id' => $token->process_request_id,
 ]
 );

 if ($token->element_type == 'task') {
 $notifiables = $token->getNotifiables('completed');
 Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down

5 changes: 5 additions & 0 deletions
ProcessMaker/Models/ProcessRequestToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
 * @property Carbon $riskchanges_at
 * @property Carbon $updated_at
 * @property Carbon $created_at
 * @property Carbon $created_at_ms
 * @property Carbon $completed_at_ms
 * @property ProcessRequest $processRequest
 *
 * @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
 'token_properties' => 'array',
 'is_priority' => 'boolean',
 'is_actionbyemail' => 'boolean',
 'created_at_ms' => MillisecondsToDateCast::class,
 'completed_at_ms' => MillisecondsToDateCast::class,
 ];

 /**
Expand Down

8 changes: 8 additions & 0 deletions
ProcessMaker/Observers/ProcessRequestTokenObserver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
 }
 }

 public function creating(ProcessRequestToken $token)
 {
 $token->created_at_ms = now();
 }

 /**
 * Once a token is saved, it also saves the version reference of the
 * screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
 public function saving(ProcessRequestToken $token)
 {
 $token->saveVersion();
 if ($token->completed_at && $token->isDirty('completed_at')) {
 $token->completed_at_ms = now();
 }
 }
}

4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down

30 changes: 30 additions & 0 deletions
database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
 /**
 * Run the migrations.
 */
 public function up(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->bigInteger('created_at_ms')->nullable();
 $table->bigInteger('completed_at_ms')->nullable();
 });
 }

 /**
 * Reverse the migrations.
 */
 public function down(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->dropColumn('created_at_ms');
 $table->dropColumn('completed_at_ms');
 });
 }
};

79 changes: 78 additions & 1 deletion
resources/grafana/MainDashboard.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
 ],
 "title": "Tasks Completed",
 "type": "barchart"
 },
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "description": "Time a task was completed",
 "fieldConfig": {
 "defaults": {
 "color": {
 "mode": "thresholds"
 },
 "fieldMinMax": false,
 "mappings": [],
 "min": 0,
 "thresholds": {
 "mode": "absolute",
 "steps": [
 {
 "color": "green",
 "value": null
 },
 {
 "color": "red",
 "value": 80
 }
 ]
 },
 "unit": "ms"
 },
 "overrides": []
 },
 "gridPos": {
 "h": 8,
 "w": 12,
 "x": 0,
 "y": 16
 },
 "id": 5,
 "interval": "15s",
 "options": {
 "minVizHeight": 75,
 "minVizWidth": 75,
 "orientation": "auto",
 "reduceOptions": {
 "calcs": [],
 "fields": "",
 "values": false
 },
 "showThresholdLabels": false,
 "showThresholdMarkers": true,
 "sizing": "auto"
 },
 "pluginVersion": "11.4.0",
 "targets": [
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "disableTextWrap": false,
 "editorMode": "code",
 "exemplar": false,
 "expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
 "format": "time_series",
 "fullMetaSearch": false,
 "includeNullMetadata": true,
 "instant": false,
 "interval": "",
 "legendFormat": "{{activity_name}} (process={{process_id}})",
 "range": true,
 "refId": "A",
 "useBackend": false
 }
 ],
 "title": "Task Execution Time",
 "type": "gauge"
 }
 ],
 "schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
 "timezone": "browser",
 "title": "ProcessMaker Dashboard",
 "uid": "be96wxsnlmn7kc",
 "version": 23,
 "version": 29,
 "weekStart": ""
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

caleeli
merged 5 commits into

from

Jan 17, 2025
 Merged


FOUR-21035 Implement Task Execution Time by Customer
#7894
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
f0133be

Add timestamps in milliseconds to process_request_tokens table


caleeli Jan 13, 2025
0f92336

Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…


caleeli Jan 13, 2025
12c28ec

Add Prometheus metric for activity execution time


caleeli Jan 13, 2025
2e6bfde

Update Main Dashboard to include Task Completion Timing report


caleeli Jan 13, 2025
b7375b8

Update MillisecondsToDateCast to specify return types for get and se…


caleeli Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 40 additions & 0 deletions
ProcessMaker/Casts/MillisecondsToDateCast.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
 /**
 * Cast the given value.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return Carbon|null
 */
 public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
 {
 return $value ? Carbon::createFromTimestampMs($value) : null;
 }

 /**
 * Prepare the given value for storage.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return float|null
 */
 public function set(Model $model, string $key, mixed $value, array $attributes): float|null
 {
 return $value ? Carbon::parse($value)->valueOf() : null;
 }
}

27 changes: 27 additions & 0 deletions
ProcessMaker/Listeners/BpmnSubscriber.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
 }
 Log::info('Activity completed: ' . json_encode($token->getProperties()));

 // Prometheus Metric: Activity Execution Time
 $startTime = $token->created_at_ms;
 $completedTime = $token->completed_at_ms;
 $executionTime = $completedTime->diffInMilliseconds($startTime);
 Metrics::histogram(
 'activity_execution_time_seconds',
 'Activity Execution Time',
 [
 'activity_id',
 'activity_name',
 'element_type',
 'process_id',
 'request_id',
 ],
 [1, 10, 3600, 86400]
 )->observe(
 $executionTime,
 [
 'activity_id' => $token->element_id,
 'activity_name' => $token->element_name,
 'element_type' => $token->element_type,
 'process_id' => $token->process_id,
 'request_id' => $token->process_request_id,
 ]
 );

 if ($token->element_type == 'task') {
 $notifiables = $token->getNotifiables('completed');
 Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down

5 changes: 5 additions & 0 deletions
ProcessMaker/Models/ProcessRequestToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
 * @property Carbon $riskchanges_at
 * @property Carbon $updated_at
 * @property Carbon $created_at
 * @property Carbon $created_at_ms
 * @property Carbon $completed_at_ms
 * @property ProcessRequest $processRequest
 *
 * @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
 'token_properties' => 'array',
 'is_priority' => 'boolean',
 'is_actionbyemail' => 'boolean',
 'created_at_ms' => MillisecondsToDateCast::class,
 'completed_at_ms' => MillisecondsToDateCast::class,
 ];

 /**
Expand Down

8 changes: 8 additions & 0 deletions
ProcessMaker/Observers/ProcessRequestTokenObserver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
 }
 }

 public function creating(ProcessRequestToken $token)
 {
 $token->created_at_ms = now();
 }

 /**
 * Once a token is saved, it also saves the version reference of the
 * screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
 public function saving(ProcessRequestToken $token)
 {
 $token->saveVersion();
 if ($token->completed_at && $token->isDirty('completed_at')) {
 $token->completed_at_ms = now();
 }
 }
}

4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down

30 changes: 30 additions & 0 deletions
database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
 /**
 * Run the migrations.
 */
 public function up(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->bigInteger('created_at_ms')->nullable();
 $table->bigInteger('completed_at_ms')->nullable();
 });
 }

 /**
 * Reverse the migrations.
 */
 public function down(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->dropColumn('created_at_ms');
 $table->dropColumn('completed_at_ms');
 });
 }
};

79 changes: 78 additions & 1 deletion
resources/grafana/MainDashboard.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
 ],
 "title": "Tasks Completed",
 "type": "barchart"
 },
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "description": "Time a task was completed",
 "fieldConfig": {
 "defaults": {
 "color": {
 "mode": "thresholds"
 },
 "fieldMinMax": false,
 "mappings": [],
 "min": 0,
 "thresholds": {
 "mode": "absolute",
 "steps": [
 {
 "color": "green",
 "value": null
 },
 {
 "color": "red",
 "value": 80
 }
 ]
 },
 "unit": "ms"
 },
 "overrides": []
 },
 "gridPos": {
 "h": 8,
 "w": 12,
 "x": 0,
 "y": 16
 },
 "id": 5,
 "interval": "15s",
 "options": {
 "minVizHeight": 75,
 "minVizWidth": 75,
 "orientation": "auto",
 "reduceOptions": {
 "calcs": [],
 "fields": "",
 "values": false
 },
 "showThresholdLabels": false,
 "showThresholdMarkers": true,
 "sizing": "auto"
 },
 "pluginVersion": "11.4.0",
 "targets": [
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "disableTextWrap": false,
 "editorMode": "code",
 "exemplar": false,
 "expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
 "format": "time_series",
 "fullMetaSearch": false,
 "includeNullMetadata": true,
 "instant": false,
 "interval": "",
 "legendFormat": "{{activity_name}} (process={{process_id}})",
 "range": true,
 "refId": "A",
 "useBackend": false
 }
 ],
 "title": "Task Execution Time",
 "type": "gauge"
 }
 ],
 "schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
 "timezone": "browser",
 "title": "ProcessMaker Dashboard",
 "uid": "be96wxsnlmn7kc",
 "version": 23,
 "version": 29,
 "weekStart": ""
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

caleeli
merged 5 commits into

from

Jan 17, 2025
 Merged


FOUR-21035 Implement Task Execution Time by Customer
#7894
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
f0133be

Add timestamps in milliseconds to process_request_tokens table


caleeli Jan 13, 2025
0f92336

Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…


caleeli Jan 13, 2025
12c28ec

Add Prometheus metric for activity execution time


caleeli Jan 13, 2025
2e6bfde

Update Main Dashboard to include Task Completion Timing report


caleeli Jan 13, 2025
b7375b8

Update MillisecondsToDateCast to specify return types for get and se…


caleeli Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 40 additions & 0 deletions
ProcessMaker/Casts/MillisecondsToDateCast.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
 /**
 * Cast the given value.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return Carbon|null
 */
 public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
 {
 return $value ? Carbon::createFromTimestampMs($value) : null;
 }

 /**
 * Prepare the given value for storage.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return float|null
 */
 public function set(Model $model, string $key, mixed $value, array $attributes): float|null
 {
 return $value ? Carbon::parse($value)->valueOf() : null;
 }
}

27 changes: 27 additions & 0 deletions
ProcessMaker/Listeners/BpmnSubscriber.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
 }
 Log::info('Activity completed: ' . json_encode($token->getProperties()));

 // Prometheus Metric: Activity Execution Time
 $startTime = $token->created_at_ms;
 $completedTime = $token->completed_at_ms;
 $executionTime = $completedTime->diffInMilliseconds($startTime);
 Metrics::histogram(
 'activity_execution_time_seconds',
 'Activity Execution Time',
 [
 'activity_id',
 'activity_name',
 'element_type',
 'process_id',
 'request_id',
 ],
 [1, 10, 3600, 86400]
 )->observe(
 $executionTime,
 [
 'activity_id' => $token->element_id,
 'activity_name' => $token->element_name,
 'element_type' => $token->element_type,
 'process_id' => $token->process_id,
 'request_id' => $token->process_request_id,
 ]
 );

 if ($token->element_type == 'task') {
 $notifiables = $token->getNotifiables('completed');
 Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down

5 changes: 5 additions & 0 deletions
ProcessMaker/Models/ProcessRequestToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
 * @property Carbon $riskchanges_at
 * @property Carbon $updated_at
 * @property Carbon $created_at
 * @property Carbon $created_at_ms
 * @property Carbon $completed_at_ms
 * @property ProcessRequest $processRequest
 *
 * @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
 'token_properties' => 'array',
 'is_priority' => 'boolean',
 'is_actionbyemail' => 'boolean',
 'created_at_ms' => MillisecondsToDateCast::class,
 'completed_at_ms' => MillisecondsToDateCast::class,
 ];

 /**
Expand Down

8 changes: 8 additions & 0 deletions
ProcessMaker/Observers/ProcessRequestTokenObserver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
 }
 }

 public function creating(ProcessRequestToken $token)
 {
 $token->created_at_ms = now();
 }

 /**
 * Once a token is saved, it also saves the version reference of the
 * screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
 public function saving(ProcessRequestToken $token)
 {
 $token->saveVersion();
 if ($token->completed_at && $token->isDirty('completed_at')) {
 $token->completed_at_ms = now();
 }
 }
}

4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down

30 changes: 30 additions & 0 deletions
database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
 /**
 * Run the migrations.
 */
 public function up(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->bigInteger('created_at_ms')->nullable();
 $table->bigInteger('completed_at_ms')->nullable();
 });
 }

 /**
 * Reverse the migrations.
 */
 public function down(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->dropColumn('created_at_ms');
 $table->dropColumn('completed_at_ms');
 });
 }
};

79 changes: 78 additions & 1 deletion
resources/grafana/MainDashboard.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
 ],
 "title": "Tasks Completed",
 "type": "barchart"
 },
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "description": "Time a task was completed",
 "fieldConfig": {
 "defaults": {
 "color": {
 "mode": "thresholds"
 },
 "fieldMinMax": false,
 "mappings": [],
 "min": 0,
 "thresholds": {
 "mode": "absolute",
 "steps": [
 {
 "color": "green",
 "value": null
 },
 {
 "color": "red",
 "value": 80
 }
 ]
 },
 "unit": "ms"
 },
 "overrides": []
 },
 "gridPos": {
 "h": 8,
 "w": 12,
 "x": 0,
 "y": 16
 },
 "id": 5,
 "interval": "15s",
 "options": {
 "minVizHeight": 75,
 "minVizWidth": 75,
 "orientation": "auto",
 "reduceOptions": {
 "calcs": [],
 "fields": "",
 "values": false
 },
 "showThresholdLabels": false,
 "showThresholdMarkers": true,
 "sizing": "auto"
 },
 "pluginVersion": "11.4.0",
 "targets": [
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "disableTextWrap": false,
 "editorMode": "code",
 "exemplar": false,
 "expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
 "format": "time_series",
 "fullMetaSearch": false,
 "includeNullMetadata": true,
 "instant": false,
 "interval": "",
 "legendFormat": "{{activity_name}} (process={{process_id}})",
 "range": true,
 "refId": "A",
 "useBackend": false
 }
 ],
 "title": "Task Execution Time",
 "type": "gauge"
 }
 ],
 "schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
 "timezone": "browser",
 "title": "ProcessMaker Dashboard",
 "uid": "be96wxsnlmn7kc",
 "version": 23,
 "version": 29,
 "weekStart": ""
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
FOUR-21035 Implement Task Execution Time by Customer#7894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

caleeli
merged 5 commits into

from

Jan 17, 2025
 Merged


FOUR-21035 Implement Task Execution Time by Customer
#7894
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
f0133be

Add timestamps in milliseconds to process_request_tokens table


caleeli Jan 13, 2025
0f92336

Add MillisecondsToDateCast for handling milliseconds timestamps in Pr…


caleeli Jan 13, 2025
12c28ec

Add Prometheus metric for activity execution time


caleeli Jan 13, 2025
2e6bfde

Update Main Dashboard to include Task Completion Timing report


caleeli Jan 13, 2025
b7375b8

Update MillisecondsToDateCast to specify return types for get and se…


caleeli Jan 14, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


40 changes: 40 additions & 0 deletions
ProcessMaker/Casts/MillisecondsToDateCast.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
<?php

namespace ProcessMaker\Casts;

use Carbon\Carbon;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class MillisecondsToDateCast implements CastsAttributes
{
 /**
 * Cast the given value.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return Carbon|null
 */
 public function get(Model $model, string $key, mixed $value, array $attributes): Carbon|null
 {
 return $value ? Carbon::createFromTimestampMs($value) : null;
 }

 /**
 * Prepare the given value for storage.
 *
 * @param Model $model
 * @param string $key
 * @param mixed $value
 * @param array<string, mixed> $attributes
 *
 * @return float|null
 */
 public function set(Model $model, string $key, mixed $value, array $attributes): float|null
 {
 return $value ? Carbon::parse($value)->valueOf() : null;
 }
}

27 changes: 27 additions & 0 deletions
ProcessMaker/Listeners/BpmnSubscriber.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityCompleted;
use ProcessMaker\Events\ProcessCompleted;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Facades\WorkflowManager;
use ProcessMaker\Jobs\TerminateRequestEndEvent;
use ProcessMaker\Models\Comment;
Expand DownExpand Up@@ -144,6 +145,32 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
 }
 Log::info('Activity completed: ' . json_encode($token->getProperties()));

 // Prometheus Metric: Activity Execution Time
 $startTime = $token->created_at_ms;
 $completedTime = $token->completed_at_ms;
 $executionTime = $completedTime->diffInMilliseconds($startTime);
 Metrics::histogram(
 'activity_execution_time_seconds',
 'Activity Execution Time',
 [
 'activity_id',
 'activity_name',
 'element_type',
 'process_id',
 'request_id',
 ],
 [1, 10, 3600, 86400]
 )->observe(
 $executionTime,
 [
 'activity_id' => $token->element_id,
 'activity_name' => $token->element_name,
 'element_type' => $token->element_type,
 'process_id' => $token->process_id,
 'request_id' => $token->process_request_id,
 ]
 );

 if ($token->element_type == 'task') {
 $notifiables = $token->getNotifiables('completed');
 Notification::send($notifiables, new ActivityCompletedNotification($token));
Expand Down

5 changes: 5 additions & 0 deletions
ProcessMaker/Models/ProcessRequestToken.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
use Illuminate\Support\Facades\Notification;
use Laravel\Scout\Searchable;
use Log;
use ProcessMaker\Casts\MillisecondsToDateCast;
use ProcessMaker\Events\ActivityAssigned;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Facades\WorkflowUserManager;
Expand DownExpand Up@@ -45,6 +46,8 @@
 * @property Carbon $riskchanges_at
 * @property Carbon $updated_at
 * @property Carbon $created_at
 * @property Carbon $created_at_ms
 * @property Carbon $completed_at_ms
 * @property ProcessRequest $processRequest
 *
 * @OA\Schema(
Expand DownExpand Up@@ -154,6 +157,8 @@ class ProcessRequestToken extends ProcessMakerModel implements TokenInterface
 'token_properties' => 'array',
 'is_priority' => 'boolean',
 'is_actionbyemail' => 'boolean',
 'created_at_ms' => MillisecondsToDateCast::class,
 'completed_at_ms' => MillisecondsToDateCast::class,
 ];

 /**
Expand Down

8 changes: 8 additions & 0 deletions
ProcessMaker/Observers/ProcessRequestTokenObserver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,11 @@ public function saved(ProcessRequestToken $token)
 }
 }

 public function creating(ProcessRequestToken $token)
 {
 $token->created_at_ms = now();
 }

 /**
 * Once a token is saved, it also saves the version reference of the
 * screen or script executed
Expand All@@ -29,5 +34,8 @@ public function saved(ProcessRequestToken $token)
 public function saving(ProcessRequestToken $token)
 {
 $token->saveVersion();
 if ($token->completed_at && $token->isDirty('completed_at')) {
 $token->completed_at_ms = now();
 }
 }
}

4 changes: 4 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -525,6 +525,10 @@ To make things even easier, you can run `Metrics::counter('cases')->inc();` or `

You can provide an optional description, for example `Metrics::gauge('active_tasks', 'Total Active Tasks')->...`

### Import Grafana Dashboards

Go to Grafana and import the dashboards from the `resources/grafana` folder. Each JSON file represents a configured dashboard that can be imported into Grafana to visualize metrics and data.

# License

Distributed under the [AGPL Version 3](https://www.gnu.org/licenses/agpl-3.0.en.html)
Expand Down

30 changes: 30 additions & 0 deletions
database/migrations/2025_01_13_212522_add_timestamps_ms_to_process_request_tokens_table.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
 /**
 * Run the migrations.
 */
 public function up(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->bigInteger('created_at_ms')->nullable();
 $table->bigInteger('completed_at_ms')->nullable();
 });
 }

 /**
 * Reverse the migrations.
 */
 public function down(): void
 {
 Schema::table('process_request_tokens', function (Blueprint $table) {
 $table->dropColumn('created_at_ms');
 $table->dropColumn('completed_at_ms');
 });
 }
};

79 changes: 78 additions & 1 deletion
resources/grafana/MainDashboard.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -429,6 +429,83 @@
 ],
 "title": "Tasks Completed",
 "type": "barchart"
 },
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "description": "Time a task was completed",
 "fieldConfig": {
 "defaults": {
 "color": {
 "mode": "thresholds"
 },
 "fieldMinMax": false,
 "mappings": [],
 "min": 0,
 "thresholds": {
 "mode": "absolute",
 "steps": [
 {
 "color": "green",
 "value": null
 },
 {
 "color": "red",
 "value": 80
 }
 ]
 },
 "unit": "ms"
 },
 "overrides": []
 },
 "gridPos": {
 "h": 8,
 "w": 12,
 "x": 0,
 "y": 16
 },
 "id": 5,
 "interval": "15s",
 "options": {
 "minVizHeight": 75,
 "minVizWidth": 75,
 "orientation": "auto",
 "reduceOptions": {
 "calcs": [],
 "fields": "",
 "values": false
 },
 "showThresholdLabels": false,
 "showThresholdMarkers": true,
 "sizing": "auto"
 },
 "pluginVersion": "11.4.0",
 "targets": [
 {
 "datasource": {
 "type": "prometheus",
 "uid": "${DS_PROMETHEUS-PM-SPRING-2025}"
 },
 "disableTextWrap": false,
 "editorMode": "code",
 "exemplar": false,
 "expr": "topk(5, avg(processmaker_activity_execution_time_seconds_sum{element_type=\"task\"}) by (process_id, activity_name))",
 "format": "time_series",
 "fullMetaSearch": false,
 "includeNullMetadata": true,
 "instant": false,
 "interval": "",
 "legendFormat": "{{activity_name}} (process={{process_id}})",
 "range": true,
 "refId": "A",
 "useBackend": false
 }
 ],
 "title": "Task Execution Time",
 "type": "gauge"
 }
 ],
 "schemaVersion": 40,
Expand All@@ -444,6 +521,6 @@
 "timezone": "browser",
 "title": "ProcessMaker Dashboard",
 "uid": "be96wxsnlmn7kc",
 "version": 23,
 "version": 29,
 "weekStart": ""
}