FOUR-21032 Task Execution Time Metrics Collection#7874

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 8 commits into from
Jan 17, 2025
Merged

FOUR-21032 Task Execution Time Metrics Collection #7874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ccad6ea
Add PrometheusMetricInterface for metric handling
caleeli Jan 6, 2025
e26890e
Enhance CacheMetricsDecorator to use PrometheusMetricInterface
caleeli Jan 7, 2025
a7049b1
Implement PrometheusMetricInterface in Screens models
caleeli Jan 7, 2025
d8c2171
Implement PrometheusMetricInterface in Setting model for Grafana repo…
caleeli Jan 8, 2025
56f405c
Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…
caleeli Jan 9, 2025
c2fa295
Add TaskMetricsTest to validate metric storage for completed tasks
caleeli Jan 9, 2025
8a23d30
Add Prometheus methods to Metrics facade and enhance MetricsService t…
caleeli Jan 9, 2025
0b7eceb
Add metrics tracking for completed activities in CompleteActivity job
caleeli Jan 9, 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
22 changes: 19 additions & 3 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
* Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
$endTime = microtime(true);
$duration = $endTime - $startTime;

// Get extra labels for metrics
$labels = [];
if ($value instanceof PrometheusMetricInterface) {
$labels['label'] = $value->getPrometheusMetricLabel();
} else {
$labels['label'] = $key;
}
// Record metrics based on key existence, not value comparison
if ($exists) {
$this->metrics->recordHit($key, $duration);
$this->metrics->recordHit($key, $duration, $labels);
} else {
$this->metrics->recordMiss($key, $duration);
$this->metrics->recordMiss($key, $duration, $labels);
}

return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
{
$result = $this->cache->set($key, $value, $ttl);

// Get extra labels for metrics
$labels = [];
if ($value instanceof PrometheusMetricInterface) {
$labels['label'] = $value->getPrometheusMetricLabel();
} else {
$labels['label'] = $key;
}

if ($result) {
// Calculate approximate size in bytes
$size = $this->calculateSize($value);
$this->metrics->recordWrite($key, $size);
$this->metrics->recordWrite($key, $size, $labels);
}

return $result;
Expand Down
7 changes: 4 additions & 3 deletions ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
*
* @param string $key Cache key that was accessed
* @param float $microtime Time taken for the operation in microseconds
* @param array $labels Additional labels to attach to the metric
*/
public function recordHit(string $key, $microtime): void;
public function recordHit(string $key, $microtime, array $labels = []): void;

/**
* Record a cache miss event
*
* @param string $key Cache key that was accessed
* @param float $microtime Time taken for the operation in microseconds
*/
public function recordMiss(string $key, $microtime): void;
public function recordMiss(string $key, $microtime, array $labels = []): void;

/**
* Record a cache write operation
*
* @param string $key Cache key that was written
* @param int $size Size of the cached data in bytes
*/
public function recordWrite(string $key, int $size): void;
public function recordWrite(string $key, int $size, array $labels = []): void;
}
29 changes: 16 additions & 13 deletions ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
* @param string $key Cache key
* @param float $microtime Time taken in microseconds
*/
public function recordHit(string $key, $microtime): void
public function recordHit(string $key, $microtime, array $labels = []): void
{
$sanitizedKey = $this->sanitizeKey($key);
$labelKeys = array_keys($labels);

$this->metrics->counter(
'cache_hits_total',
'Total number of cache hits',
['cache_key']
)->inc(['cache_key' => $sanitizedKey]);
['cache_key', ...$labelKeys]
)->inc(['cache_key' => $sanitizedKey, ...$labels]);
// record the last write timestamp
$this->metrics->gauge(
'cache_last_write_timestamp',
'Last write timestamp',
['cache_key']
)->set($microtime, ['cache_key' => $sanitizedKey]);
['cache_key', ...$labelKeys]
)->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
}

/**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
* @param string $key Cache key
* @param float $microtime Time taken in microseconds
*/
public function recordMiss(string $key, $microtime): void
public function recordMiss(string $key, $microtime, array $labels = []): void
{
$sanitizedKey = $this->sanitizeKey($key);
$labelKeys = array_keys($labels);

$this->metrics->counter(
'cache_misses_total',
'Total number of cache misses',
['cache_key']
)->inc(['cache_key' => $sanitizedKey]);
['cache_key', ...$labelKeys]
)->inc(['cache_key' => $sanitizedKey, ...$labels]);

// record the last write timestamp
$this->metrics->gauge(
'cache_last_write_timestamp',
'Last write timestamp',
['cache_key']
)->set($microtime, ['cache_key' => $sanitizedKey]);
['cache_key', ...$labelKeys]
)->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
}

/**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
* @param string $key Cache key
* @param int $size Size in bytes
*/
public function recordWrite(string $key, int $size): void
public function recordWrite(string $key, int $size, array $labels = []): void
{
$sanitizedKey = $this->sanitizeKey($key);
$labelKeys = array_keys($labels);

$this->metrics->gauge(
'cache_memory_bytes',
'Memory usage in bytes',
['cache_key']
)->set($size, ['cache_key' => $sanitizedKey]);
['cache_key', ...$labelKeys]
)->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ProcessMaker/Cache/Monitoring/RedisMetricsManager.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
* @param string $key Cache key
* @param float $microtime Time taken in microseconds
*/
public function recordHit(string $key, $microtime): void
public function recordHit(string $key, $microtime, array $labels = []): void
{
$baseKey = self::METRICS_PREFIX . $key;
Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
* @param string $key Cache key
* @param float $microtime Time taken in microseconds
*/
public function recordMiss(string $key, $microtime): void
public function recordMiss(string $key, $microtime, array $labels = []): void
{
$baseKey = self::METRICS_PREFIX . $key;
Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
* @param string $key Cache key
* @param int $size Size in bytes
*/
public function recordWrite(string $key, int $size): void
public function recordWrite(string $key, int $size, array $labels = []): void
{
$baseKey = self::METRICS_PREFIX . $key;
Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down
30 changes: 30 additions & 0 deletions ProcessMaker/Cache/Screens/ScreenCache.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
<?php

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

public string $label;

public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
{
$self = new static($items);
$self->label = $screen->getPrometheusMetricLabel();

return $self;
}

/**
* Returns a legible or friendly name for Prometheus metrics.
*
* @return string
*/
public function getPrometheusMetricLabel(): string
{
return $this->label;
}
}
13 changes: 13 additions & 0 deletions ProcessMaker/Contracts/PrometheusMetricInterface.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
<?php

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
/**
* Returns a legible or friendly name for Prometheus metrics.
*
* @return string
*/
public function getPrometheusMetricLabel(): string;
}
8 changes: 8 additions & 0 deletions ProcessMaker/Facades/Metrics.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
* @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
* @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
* @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
* @method static void setGauge(string $name, float $value, array $labelValues = [])
* @method static string renderMetrics()
* @method static \Prometheus\CollectorRegistry getCollectionRegistry()
*/
class Metrics extends Facade
{
/**
Expand Down
20 changes: 19 additions & 1 deletion ProcessMaker/Jobs/CompleteActivity.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
$manager->updateData($token, $data);
$this->engine->runToNextState();
$element->complete($token);

Metrics::counter(
'activity_completed_total',
'Total number of activities completed',
[
'activity_id',
'activity_name',
'process_id',
'request_id',
]
)->inc(
[
'activity_id' => $element->getId(),
'activity_name' => $element->getName(),
'process_id' => $this->definitionsId,
'request_id' => $this->instanceId,
]
);
}
}
13 changes: 12 additions & 1 deletion ProcessMaker/Models/Screen.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
* @OA\Property(property="url", type="string"),
* )
*/
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
use SerializeToIso8601;
use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

return $query;
}

/**
* Return the label to be used in grafana reports
*
* @return string
*/
public function getPrometheusMetricLabel(): string
{
return 'screen.' . $this->id;
}
}
8 changes: 7 additions & 1 deletion ProcessMaker/Models/ScreenVersion.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
use HasCategories;
use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
{
return $query->where('draft', false);
}

public function getPrometheusMetricLabel(): string
{
return 'screen.' . $this->screen_id;
}
}
13 changes: 12 additions & 1 deletion ProcessMaker/Models/Setting.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
* },
* )
*/
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
use ExtendedPMQL;
use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
}
});
}

/**
* Get the label used in grafana reports
*
* @return string
*/
public function getPrometheusMetricLabel(): string
{
return 'settings.' . $this->key;
}
}
12 changes: 11 additions & 1 deletion ProcessMaker/Services/MetricsService.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
*
* @param mixed $adapter The storage adapter to use (e.g., Redis).
*/
public function __construct($adapter = null)
public function __construct(private $adapter = null)
{
$this->namespace = config('app.prometheus_namespace', 'app');
try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
}
}

/**
* Get the collection registry.
*
* @return CollectorRegistry The collection registry instance.
*/
public function getCollectionRegistry(): CollectorRegistry
{
return $this->collectionRegistry;
}

/**
* Registers or retrieves a counter metric.
*
Expand Down
Loading
, '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-21032 Task Execution Time Metrics Collection#7874

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 8 commits into

from

Jan 17, 2025
 Merged


FOUR-21032 Task Execution Time Metrics Collection
#7874
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
ccad6ea

Add PrometheusMetricInterface for metric handling


caleeli Jan 6, 2025
e26890e

Enhance CacheMetricsDecorator to use PrometheusMetricInterface


caleeli Jan 7, 2025
a7049b1

Implement PrometheusMetricInterface in Screens models


caleeli Jan 7, 2025
d8c2171

Implement PrometheusMetricInterface in Setting model for Grafana repo…


caleeli Jan 8, 2025
56f405c

Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…


caleeli Jan 9, 2025
c2fa295

Add TaskMetricsTest to validate metric storage for completed tasks


caleeli Jan 9, 2025
8a23d30

Add Prometheus methods to Metrics facade and enhance MetricsService t…


caleeli Jan 9, 2025
0b7eceb

Add metrics tracking for completed activities in CompleteActivity job


caleeli Jan 9, 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


22 changes: 19 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
 * Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
 $endTime = microtime(true);
 $duration = $endTime - $startTime;

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }
 // Record metrics based on key existence, not value comparison
 if ($exists) {
 $this->metrics->recordHit($key, $duration);
 $this->metrics->recordHit($key, $duration, $labels);
 } else {
 $this->metrics->recordMiss($key, $duration);
 $this->metrics->recordMiss($key, $duration, $labels);
 }

 return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
 {
 $result = $this->cache->set($key, $value, $ttl);

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }

 if ($result) {
 // Calculate approximate size in bytes
 $size = $this->calculateSize($value);
 $this->metrics->recordWrite($key, $size);
 $this->metrics->recordWrite($key, $size, $labels);
 }

 return $result;
Expand Down

7 changes: 4 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 * @param array $labels Additional labels to attach to the metric
 */
 public function recordHit(string $key, $microtime): void;
 public function recordHit(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache miss event
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 */
 public function recordMiss(string $key, $microtime): void;
 public function recordMiss(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache write operation
 *
 * @param string $key Cache key that was written
 * @param int $size Size of the cached data in bytes
 */
 public function recordWrite(string $key, int $size): void;
 public function recordWrite(string $key, int $size, array $labels = []): void;
}

29 changes: 16 additions & 13 deletions
ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_hits_total',
 'Total number of cache hits',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);
 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_misses_total',
 'Total number of cache misses',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);

 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->gauge(
 'cache_memory_bytes',
 'Memory usage in bytes',
 ['cache_key']
 )->set($size, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand Down

6 changes: 3 additions & 3 deletions
ProcessMaker/Cache/Monitoring/RedisMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down

30 changes: 30 additions & 0 deletions
ProcessMaker/Cache/Screens/ScreenCache.php

View file


Open in desktop

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

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

 public string $label;

 public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
 {
 $self = new static($items);
 $self->label = $screen->getPrometheusMetricLabel();

 return $self;
 }

 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string
 {
 return $this->label;
 }
}

13 changes: 13 additions & 0 deletions
ProcessMaker/Contracts/PrometheusMetricInterface.php

View file


Open in desktop

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

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string;
}

8 changes: 8 additions & 0 deletions
ProcessMaker/Facades/Metrics.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
 * @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
 * @method static void setGauge(string $name, float $value, array $labelValues = [])
 * @method static string renderMetrics()
 * @method static \Prometheus\CollectorRegistry getCollectionRegistry()
 */
class Metrics extends Facade
{
 /**
Expand Down

20 changes: 19 additions & 1 deletion
ProcessMaker/Jobs/CompleteActivity.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
 $manager->updateData($token, $data);
 $this->engine->runToNextState();
 $element->complete($token);

 Metrics::counter(
 'activity_completed_total',
 'Total number of activities completed',
 [
 'activity_id',
 'activity_name',
 'process_id',
 'request_id',
 ]
 )->inc(
 [
 'activity_id' => $element->getId(),
 'activity_name' => $element->getName(),
 'process_id' => $this->definitionsId,
 'request_id' => $this->instanceId,
 ]
 );
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Screen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
 * @OA\Property(property="url", type="string"),
 * )
 */
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use SerializeToIso8601;
 use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

 return $query;
 }

 /**
 * Return the label to be used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->id;
 }
}

8 changes: 7 additions & 1 deletion
ProcessMaker/Models/ScreenVersion.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use HasCategories;
 use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
 {
 return $query->where('draft', false);
 }

 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->screen_id;
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Setting.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
 * },
 * )
 */
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
 use ExtendedPMQL;
 use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
 }
 });
 }

 /**
 * Get the label used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'settings.' . $this->key;
 }
}

12 changes: 11 additions & 1 deletion
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 public function __construct(private $adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
 }
 }

 /**
 * Get the collection registry.
 *
 * @return CollectorRegistry The collection registry instance.
 */
 public function getCollectionRegistry(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Registers or retrieves a counter metric.
 *
Expand Down
Loading

, '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-21032 Task Execution Time Metrics Collection#7874

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 8 commits into

from

Jan 17, 2025
 Merged


FOUR-21032 Task Execution Time Metrics Collection
#7874
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
ccad6ea

Add PrometheusMetricInterface for metric handling


caleeli Jan 6, 2025
e26890e

Enhance CacheMetricsDecorator to use PrometheusMetricInterface


caleeli Jan 7, 2025
a7049b1

Implement PrometheusMetricInterface in Screens models


caleeli Jan 7, 2025
d8c2171

Implement PrometheusMetricInterface in Setting model for Grafana repo…


caleeli Jan 8, 2025
56f405c

Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…


caleeli Jan 9, 2025
c2fa295

Add TaskMetricsTest to validate metric storage for completed tasks


caleeli Jan 9, 2025
8a23d30

Add Prometheus methods to Metrics facade and enhance MetricsService t…


caleeli Jan 9, 2025
0b7eceb

Add metrics tracking for completed activities in CompleteActivity job


caleeli Jan 9, 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


22 changes: 19 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
 * Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
 $endTime = microtime(true);
 $duration = $endTime - $startTime;

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }
 // Record metrics based on key existence, not value comparison
 if ($exists) {
 $this->metrics->recordHit($key, $duration);
 $this->metrics->recordHit($key, $duration, $labels);
 } else {
 $this->metrics->recordMiss($key, $duration);
 $this->metrics->recordMiss($key, $duration, $labels);
 }

 return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
 {
 $result = $this->cache->set($key, $value, $ttl);

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }

 if ($result) {
 // Calculate approximate size in bytes
 $size = $this->calculateSize($value);
 $this->metrics->recordWrite($key, $size);
 $this->metrics->recordWrite($key, $size, $labels);
 }

 return $result;
Expand Down

7 changes: 4 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 * @param array $labels Additional labels to attach to the metric
 */
 public function recordHit(string $key, $microtime): void;
 public function recordHit(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache miss event
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 */
 public function recordMiss(string $key, $microtime): void;
 public function recordMiss(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache write operation
 *
 * @param string $key Cache key that was written
 * @param int $size Size of the cached data in bytes
 */
 public function recordWrite(string $key, int $size): void;
 public function recordWrite(string $key, int $size, array $labels = []): void;
}

29 changes: 16 additions & 13 deletions
ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_hits_total',
 'Total number of cache hits',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);
 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_misses_total',
 'Total number of cache misses',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);

 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->gauge(
 'cache_memory_bytes',
 'Memory usage in bytes',
 ['cache_key']
 )->set($size, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand Down

6 changes: 3 additions & 3 deletions
ProcessMaker/Cache/Monitoring/RedisMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down

30 changes: 30 additions & 0 deletions
ProcessMaker/Cache/Screens/ScreenCache.php

View file


Open in desktop

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

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

 public string $label;

 public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
 {
 $self = new static($items);
 $self->label = $screen->getPrometheusMetricLabel();

 return $self;
 }

 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string
 {
 return $this->label;
 }
}

13 changes: 13 additions & 0 deletions
ProcessMaker/Contracts/PrometheusMetricInterface.php

View file


Open in desktop

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

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string;
}

8 changes: 8 additions & 0 deletions
ProcessMaker/Facades/Metrics.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
 * @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
 * @method static void setGauge(string $name, float $value, array $labelValues = [])
 * @method static string renderMetrics()
 * @method static \Prometheus\CollectorRegistry getCollectionRegistry()
 */
class Metrics extends Facade
{
 /**
Expand Down

20 changes: 19 additions & 1 deletion
ProcessMaker/Jobs/CompleteActivity.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
 $manager->updateData($token, $data);
 $this->engine->runToNextState();
 $element->complete($token);

 Metrics::counter(
 'activity_completed_total',
 'Total number of activities completed',
 [
 'activity_id',
 'activity_name',
 'process_id',
 'request_id',
 ]
 )->inc(
 [
 'activity_id' => $element->getId(),
 'activity_name' => $element->getName(),
 'process_id' => $this->definitionsId,
 'request_id' => $this->instanceId,
 ]
 );
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Screen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
 * @OA\Property(property="url", type="string"),
 * )
 */
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use SerializeToIso8601;
 use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

 return $query;
 }

 /**
 * Return the label to be used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->id;
 }
}

8 changes: 7 additions & 1 deletion
ProcessMaker/Models/ScreenVersion.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use HasCategories;
 use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
 {
 return $query->where('draft', false);
 }

 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->screen_id;
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Setting.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
 * },
 * )
 */
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
 use ExtendedPMQL;
 use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
 }
 });
 }

 /**
 * Get the label used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'settings.' . $this->key;
 }
}

12 changes: 11 additions & 1 deletion
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 public function __construct(private $adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
 }
 }

 /**
 * Get the collection registry.
 *
 * @return CollectorRegistry The collection registry instance.
 */
 public function getCollectionRegistry(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Registers or retrieves a counter metric.
 *
Expand Down
Loading

, '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-21032 Task Execution Time Metrics Collection#7874

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 8 commits into

from

Jan 17, 2025
 Merged


FOUR-21032 Task Execution Time Metrics Collection
#7874
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
ccad6ea

Add PrometheusMetricInterface for metric handling


caleeli Jan 6, 2025
e26890e

Enhance CacheMetricsDecorator to use PrometheusMetricInterface


caleeli Jan 7, 2025
a7049b1

Implement PrometheusMetricInterface in Screens models


caleeli Jan 7, 2025
d8c2171

Implement PrometheusMetricInterface in Setting model for Grafana repo…


caleeli Jan 8, 2025
56f405c

Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…


caleeli Jan 9, 2025
c2fa295

Add TaskMetricsTest to validate metric storage for completed tasks


caleeli Jan 9, 2025
8a23d30

Add Prometheus methods to Metrics facade and enhance MetricsService t…


caleeli Jan 9, 2025
0b7eceb

Add metrics tracking for completed activities in CompleteActivity job


caleeli Jan 9, 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


22 changes: 19 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
 * Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
 $endTime = microtime(true);
 $duration = $endTime - $startTime;

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }
 // Record metrics based on key existence, not value comparison
 if ($exists) {
 $this->metrics->recordHit($key, $duration);
 $this->metrics->recordHit($key, $duration, $labels);
 } else {
 $this->metrics->recordMiss($key, $duration);
 $this->metrics->recordMiss($key, $duration, $labels);
 }

 return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
 {
 $result = $this->cache->set($key, $value, $ttl);

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }

 if ($result) {
 // Calculate approximate size in bytes
 $size = $this->calculateSize($value);
 $this->metrics->recordWrite($key, $size);
 $this->metrics->recordWrite($key, $size, $labels);
 }

 return $result;
Expand Down

7 changes: 4 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 * @param array $labels Additional labels to attach to the metric
 */
 public function recordHit(string $key, $microtime): void;
 public function recordHit(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache miss event
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 */
 public function recordMiss(string $key, $microtime): void;
 public function recordMiss(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache write operation
 *
 * @param string $key Cache key that was written
 * @param int $size Size of the cached data in bytes
 */
 public function recordWrite(string $key, int $size): void;
 public function recordWrite(string $key, int $size, array $labels = []): void;
}

29 changes: 16 additions & 13 deletions
ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_hits_total',
 'Total number of cache hits',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);
 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_misses_total',
 'Total number of cache misses',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);

 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->gauge(
 'cache_memory_bytes',
 'Memory usage in bytes',
 ['cache_key']
 )->set($size, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand Down

6 changes: 3 additions & 3 deletions
ProcessMaker/Cache/Monitoring/RedisMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down

30 changes: 30 additions & 0 deletions
ProcessMaker/Cache/Screens/ScreenCache.php

View file


Open in desktop

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

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

 public string $label;

 public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
 {
 $self = new static($items);
 $self->label = $screen->getPrometheusMetricLabel();

 return $self;
 }

 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string
 {
 return $this->label;
 }
}

13 changes: 13 additions & 0 deletions
ProcessMaker/Contracts/PrometheusMetricInterface.php

View file


Open in desktop

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

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string;
}

8 changes: 8 additions & 0 deletions
ProcessMaker/Facades/Metrics.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
 * @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
 * @method static void setGauge(string $name, float $value, array $labelValues = [])
 * @method static string renderMetrics()
 * @method static \Prometheus\CollectorRegistry getCollectionRegistry()
 */
class Metrics extends Facade
{
 /**
Expand Down

20 changes: 19 additions & 1 deletion
ProcessMaker/Jobs/CompleteActivity.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
 $manager->updateData($token, $data);
 $this->engine->runToNextState();
 $element->complete($token);

 Metrics::counter(
 'activity_completed_total',
 'Total number of activities completed',
 [
 'activity_id',
 'activity_name',
 'process_id',
 'request_id',
 ]
 )->inc(
 [
 'activity_id' => $element->getId(),
 'activity_name' => $element->getName(),
 'process_id' => $this->definitionsId,
 'request_id' => $this->instanceId,
 ]
 );
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Screen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
 * @OA\Property(property="url", type="string"),
 * )
 */
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use SerializeToIso8601;
 use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

 return $query;
 }

 /**
 * Return the label to be used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->id;
 }
}

8 changes: 7 additions & 1 deletion
ProcessMaker/Models/ScreenVersion.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use HasCategories;
 use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
 {
 return $query->where('draft', false);
 }

 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->screen_id;
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Setting.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
 * },
 * )
 */
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
 use ExtendedPMQL;
 use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
 }
 });
 }

 /**
 * Get the label used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'settings.' . $this->key;
 }
}

12 changes: 11 additions & 1 deletion
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 public function __construct(private $adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
 }
 }

 /**
 * Get the collection registry.
 *
 * @return CollectorRegistry The collection registry instance.
 */
 public function getCollectionRegistry(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Registers or retrieves a counter metric.
 *
Expand Down
Loading

, '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-21032 Task Execution Time Metrics Collection#7874

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 8 commits into

from

Jan 17, 2025
 Merged


FOUR-21032 Task Execution Time Metrics Collection
#7874
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
ccad6ea

Add PrometheusMetricInterface for metric handling


caleeli Jan 6, 2025
e26890e

Enhance CacheMetricsDecorator to use PrometheusMetricInterface


caleeli Jan 7, 2025
a7049b1

Implement PrometheusMetricInterface in Screens models


caleeli Jan 7, 2025
d8c2171

Implement PrometheusMetricInterface in Setting model for Grafana repo…


caleeli Jan 8, 2025
56f405c

Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…


caleeli Jan 9, 2025
c2fa295

Add TaskMetricsTest to validate metric storage for completed tasks


caleeli Jan 9, 2025
8a23d30

Add Prometheus methods to Metrics facade and enhance MetricsService t…


caleeli Jan 9, 2025
0b7eceb

Add metrics tracking for completed activities in CompleteActivity job


caleeli Jan 9, 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


22 changes: 19 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
 * Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
 $endTime = microtime(true);
 $duration = $endTime - $startTime;

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }
 // Record metrics based on key existence, not value comparison
 if ($exists) {
 $this->metrics->recordHit($key, $duration);
 $this->metrics->recordHit($key, $duration, $labels);
 } else {
 $this->metrics->recordMiss($key, $duration);
 $this->metrics->recordMiss($key, $duration, $labels);
 }

 return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
 {
 $result = $this->cache->set($key, $value, $ttl);

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }

 if ($result) {
 // Calculate approximate size in bytes
 $size = $this->calculateSize($value);
 $this->metrics->recordWrite($key, $size);
 $this->metrics->recordWrite($key, $size, $labels);
 }

 return $result;
Expand Down

7 changes: 4 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 * @param array $labels Additional labels to attach to the metric
 */
 public function recordHit(string $key, $microtime): void;
 public function recordHit(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache miss event
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 */
 public function recordMiss(string $key, $microtime): void;
 public function recordMiss(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache write operation
 *
 * @param string $key Cache key that was written
 * @param int $size Size of the cached data in bytes
 */
 public function recordWrite(string $key, int $size): void;
 public function recordWrite(string $key, int $size, array $labels = []): void;
}

29 changes: 16 additions & 13 deletions
ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_hits_total',
 'Total number of cache hits',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);
 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_misses_total',
 'Total number of cache misses',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);

 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->gauge(
 'cache_memory_bytes',
 'Memory usage in bytes',
 ['cache_key']
 )->set($size, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand Down

6 changes: 3 additions & 3 deletions
ProcessMaker/Cache/Monitoring/RedisMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down

30 changes: 30 additions & 0 deletions
ProcessMaker/Cache/Screens/ScreenCache.php

View file


Open in desktop

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

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

 public string $label;

 public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
 {
 $self = new static($items);
 $self->label = $screen->getPrometheusMetricLabel();

 return $self;
 }

 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string
 {
 return $this->label;
 }
}

13 changes: 13 additions & 0 deletions
ProcessMaker/Contracts/PrometheusMetricInterface.php

View file


Open in desktop

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

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string;
}

8 changes: 8 additions & 0 deletions
ProcessMaker/Facades/Metrics.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
 * @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
 * @method static void setGauge(string $name, float $value, array $labelValues = [])
 * @method static string renderMetrics()
 * @method static \Prometheus\CollectorRegistry getCollectionRegistry()
 */
class Metrics extends Facade
{
 /**
Expand Down

20 changes: 19 additions & 1 deletion
ProcessMaker/Jobs/CompleteActivity.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
 $manager->updateData($token, $data);
 $this->engine->runToNextState();
 $element->complete($token);

 Metrics::counter(
 'activity_completed_total',
 'Total number of activities completed',
 [
 'activity_id',
 'activity_name',
 'process_id',
 'request_id',
 ]
 )->inc(
 [
 'activity_id' => $element->getId(),
 'activity_name' => $element->getName(),
 'process_id' => $this->definitionsId,
 'request_id' => $this->instanceId,
 ]
 );
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Screen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
 * @OA\Property(property="url", type="string"),
 * )
 */
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use SerializeToIso8601;
 use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

 return $query;
 }

 /**
 * Return the label to be used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->id;
 }
}

8 changes: 7 additions & 1 deletion
ProcessMaker/Models/ScreenVersion.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use HasCategories;
 use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
 {
 return $query->where('draft', false);
 }

 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->screen_id;
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Setting.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
 * },
 * )
 */
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
 use ExtendedPMQL;
 use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
 }
 });
 }

 /**
 * Get the label used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'settings.' . $this->key;
 }
}

12 changes: 11 additions & 1 deletion
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 public function __construct(private $adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
 }
 }

 /**
 * Get the collection registry.
 *
 * @return CollectorRegistry The collection registry instance.
 */
 public function getCollectionRegistry(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Registers or retrieves a counter metric.
 *
Expand Down
Loading

, '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-21032 Task Execution Time Metrics Collection#7874

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 8 commits into

from

Jan 17, 2025
 Merged


FOUR-21032 Task Execution Time Metrics Collection
#7874
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
ccad6ea

Add PrometheusMetricInterface for metric handling


caleeli Jan 6, 2025
e26890e

Enhance CacheMetricsDecorator to use PrometheusMetricInterface


caleeli Jan 7, 2025
a7049b1

Implement PrometheusMetricInterface in Screens models


caleeli Jan 7, 2025
d8c2171

Implement PrometheusMetricInterface in Setting model for Grafana repo…


caleeli Jan 8, 2025
56f405c

Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…


caleeli Jan 9, 2025
c2fa295

Add TaskMetricsTest to validate metric storage for completed tasks


caleeli Jan 9, 2025
8a23d30

Add Prometheus methods to Metrics facade and enhance MetricsService t…


caleeli Jan 9, 2025
0b7eceb

Add metrics tracking for completed activities in CompleteActivity job


caleeli Jan 9, 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


22 changes: 19 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
 * Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
 $endTime = microtime(true);
 $duration = $endTime - $startTime;

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }
 // Record metrics based on key existence, not value comparison
 if ($exists) {
 $this->metrics->recordHit($key, $duration);
 $this->metrics->recordHit($key, $duration, $labels);
 } else {
 $this->metrics->recordMiss($key, $duration);
 $this->metrics->recordMiss($key, $duration, $labels);
 }

 return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
 {
 $result = $this->cache->set($key, $value, $ttl);

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }

 if ($result) {
 // Calculate approximate size in bytes
 $size = $this->calculateSize($value);
 $this->metrics->recordWrite($key, $size);
 $this->metrics->recordWrite($key, $size, $labels);
 }

 return $result;
Expand Down

7 changes: 4 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 * @param array $labels Additional labels to attach to the metric
 */
 public function recordHit(string $key, $microtime): void;
 public function recordHit(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache miss event
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 */
 public function recordMiss(string $key, $microtime): void;
 public function recordMiss(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache write operation
 *
 * @param string $key Cache key that was written
 * @param int $size Size of the cached data in bytes
 */
 public function recordWrite(string $key, int $size): void;
 public function recordWrite(string $key, int $size, array $labels = []): void;
}

29 changes: 16 additions & 13 deletions
ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_hits_total',
 'Total number of cache hits',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);
 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_misses_total',
 'Total number of cache misses',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);

 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->gauge(
 'cache_memory_bytes',
 'Memory usage in bytes',
 ['cache_key']
 )->set($size, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand Down

6 changes: 3 additions & 3 deletions
ProcessMaker/Cache/Monitoring/RedisMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down

30 changes: 30 additions & 0 deletions
ProcessMaker/Cache/Screens/ScreenCache.php

View file


Open in desktop

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

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

 public string $label;

 public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
 {
 $self = new static($items);
 $self->label = $screen->getPrometheusMetricLabel();

 return $self;
 }

 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string
 {
 return $this->label;
 }
}

13 changes: 13 additions & 0 deletions
ProcessMaker/Contracts/PrometheusMetricInterface.php

View file


Open in desktop

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

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string;
}

8 changes: 8 additions & 0 deletions
ProcessMaker/Facades/Metrics.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
 * @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
 * @method static void setGauge(string $name, float $value, array $labelValues = [])
 * @method static string renderMetrics()
 * @method static \Prometheus\CollectorRegistry getCollectionRegistry()
 */
class Metrics extends Facade
{
 /**
Expand Down

20 changes: 19 additions & 1 deletion
ProcessMaker/Jobs/CompleteActivity.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
 $manager->updateData($token, $data);
 $this->engine->runToNextState();
 $element->complete($token);

 Metrics::counter(
 'activity_completed_total',
 'Total number of activities completed',
 [
 'activity_id',
 'activity_name',
 'process_id',
 'request_id',
 ]
 )->inc(
 [
 'activity_id' => $element->getId(),
 'activity_name' => $element->getName(),
 'process_id' => $this->definitionsId,
 'request_id' => $this->instanceId,
 ]
 );
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Screen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
 * @OA\Property(property="url", type="string"),
 * )
 */
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use SerializeToIso8601;
 use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

 return $query;
 }

 /**
 * Return the label to be used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->id;
 }
}

8 changes: 7 additions & 1 deletion
ProcessMaker/Models/ScreenVersion.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use HasCategories;
 use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
 {
 return $query->where('draft', false);
 }

 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->screen_id;
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Setting.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
 * },
 * )
 */
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
 use ExtendedPMQL;
 use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
 }
 });
 }

 /**
 * Get the label used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'settings.' . $this->key;
 }
}

12 changes: 11 additions & 1 deletion
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 public function __construct(private $adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
 }
 }

 /**
 * Get the collection registry.
 *
 * @return CollectorRegistry The collection registry instance.
 */
 public function getCollectionRegistry(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Registers or retrieves a counter metric.
 *
Expand Down
Loading

, '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-21032 Task Execution Time Metrics Collection#7874

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 8 commits into

from

Jan 17, 2025
 Merged


FOUR-21032 Task Execution Time Metrics Collection
#7874
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
ccad6ea

Add PrometheusMetricInterface for metric handling


caleeli Jan 6, 2025
e26890e

Enhance CacheMetricsDecorator to use PrometheusMetricInterface


caleeli Jan 7, 2025
a7049b1

Implement PrometheusMetricInterface in Screens models


caleeli Jan 7, 2025
d8c2171

Implement PrometheusMetricInterface in Setting model for Grafana repo…


caleeli Jan 8, 2025
56f405c

Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…


caleeli Jan 9, 2025
c2fa295

Add TaskMetricsTest to validate metric storage for completed tasks


caleeli Jan 9, 2025
8a23d30

Add Prometheus methods to Metrics facade and enhance MetricsService t…


caleeli Jan 9, 2025
0b7eceb

Add metrics tracking for completed activities in CompleteActivity job


caleeli Jan 9, 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


22 changes: 19 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
 * Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
 $endTime = microtime(true);
 $duration = $endTime - $startTime;

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }
 // Record metrics based on key existence, not value comparison
 if ($exists) {
 $this->metrics->recordHit($key, $duration);
 $this->metrics->recordHit($key, $duration, $labels);
 } else {
 $this->metrics->recordMiss($key, $duration);
 $this->metrics->recordMiss($key, $duration, $labels);
 }

 return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
 {
 $result = $this->cache->set($key, $value, $ttl);

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }

 if ($result) {
 // Calculate approximate size in bytes
 $size = $this->calculateSize($value);
 $this->metrics->recordWrite($key, $size);
 $this->metrics->recordWrite($key, $size, $labels);
 }

 return $result;
Expand Down

7 changes: 4 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 * @param array $labels Additional labels to attach to the metric
 */
 public function recordHit(string $key, $microtime): void;
 public function recordHit(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache miss event
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 */
 public function recordMiss(string $key, $microtime): void;
 public function recordMiss(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache write operation
 *
 * @param string $key Cache key that was written
 * @param int $size Size of the cached data in bytes
 */
 public function recordWrite(string $key, int $size): void;
 public function recordWrite(string $key, int $size, array $labels = []): void;
}

29 changes: 16 additions & 13 deletions
ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_hits_total',
 'Total number of cache hits',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);
 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_misses_total',
 'Total number of cache misses',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);

 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->gauge(
 'cache_memory_bytes',
 'Memory usage in bytes',
 ['cache_key']
 )->set($size, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand Down

6 changes: 3 additions & 3 deletions
ProcessMaker/Cache/Monitoring/RedisMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down

30 changes: 30 additions & 0 deletions
ProcessMaker/Cache/Screens/ScreenCache.php

View file


Open in desktop

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

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

 public string $label;

 public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
 {
 $self = new static($items);
 $self->label = $screen->getPrometheusMetricLabel();

 return $self;
 }

 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string
 {
 return $this->label;
 }
}

13 changes: 13 additions & 0 deletions
ProcessMaker/Contracts/PrometheusMetricInterface.php

View file


Open in desktop

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

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string;
}

8 changes: 8 additions & 0 deletions
ProcessMaker/Facades/Metrics.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
 * @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
 * @method static void setGauge(string $name, float $value, array $labelValues = [])
 * @method static string renderMetrics()
 * @method static \Prometheus\CollectorRegistry getCollectionRegistry()
 */
class Metrics extends Facade
{
 /**
Expand Down

20 changes: 19 additions & 1 deletion
ProcessMaker/Jobs/CompleteActivity.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
 $manager->updateData($token, $data);
 $this->engine->runToNextState();
 $element->complete($token);

 Metrics::counter(
 'activity_completed_total',
 'Total number of activities completed',
 [
 'activity_id',
 'activity_name',
 'process_id',
 'request_id',
 ]
 )->inc(
 [
 'activity_id' => $element->getId(),
 'activity_name' => $element->getName(),
 'process_id' => $this->definitionsId,
 'request_id' => $this->instanceId,
 ]
 );
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Screen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
 * @OA\Property(property="url", type="string"),
 * )
 */
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use SerializeToIso8601;
 use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

 return $query;
 }

 /**
 * Return the label to be used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->id;
 }
}

8 changes: 7 additions & 1 deletion
ProcessMaker/Models/ScreenVersion.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use HasCategories;
 use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
 {
 return $query->where('draft', false);
 }

 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->screen_id;
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Setting.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
 * },
 * )
 */
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
 use ExtendedPMQL;
 use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
 }
 });
 }

 /**
 * Get the label used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'settings.' . $this->key;
 }
}

12 changes: 11 additions & 1 deletion
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 public function __construct(private $adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
 }
 }

 /**
 * Get the collection registry.
 *
 * @return CollectorRegistry The collection registry instance.
 */
 public function getCollectionRegistry(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Registers or retrieves a counter metric.
 *
Expand Down
Loading

, '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-21032 Task Execution Time Metrics Collection#7874

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 8 commits into

from

Jan 17, 2025
 Merged


FOUR-21032 Task Execution Time Metrics Collection
#7874
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
ccad6ea

Add PrometheusMetricInterface for metric handling


caleeli Jan 6, 2025
e26890e

Enhance CacheMetricsDecorator to use PrometheusMetricInterface


caleeli Jan 7, 2025
a7049b1

Implement PrometheusMetricInterface in Screens models


caleeli Jan 7, 2025
d8c2171

Implement PrometheusMetricInterface in Setting model for Grafana repo…


caleeli Jan 8, 2025
56f405c

Add tests for CacheMetricsDecorator to validate PrometheusMetricInter…


caleeli Jan 9, 2025
c2fa295

Add TaskMetricsTest to validate metric storage for completed tasks


caleeli Jan 9, 2025
8a23d30

Add Prometheus methods to Metrics facade and enhance MetricsService t…


caleeli Jan 9, 2025
0b7eceb

Add metrics tracking for completed activities in CompleteActivity job


caleeli Jan 9, 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


22 changes: 19 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Contracts\PrometheusMetricInterface;

/**
 * Decorator class that adds metrics tracking about cache operations
Expand DownExpand Up@@ -64,11 +65,18 @@ public function get(string $key, mixed $default = null): mixed
 $endTime = microtime(true);
 $duration = $endTime - $startTime;

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }
 // Record metrics based on key existence, not value comparison
 if ($exists) {
 $this->metrics->recordHit($key, $duration);
 $this->metrics->recordHit($key, $duration, $labels);
 } else {
 $this->metrics->recordMiss($key, $duration);
 $this->metrics->recordMiss($key, $duration, $labels);
 }

 return $value;
Expand All@@ -88,10 +96,18 @@ public function set(string $key, mixed $value, null|int|\DateInterval $ttl = nul
 {
 $result = $this->cache->set($key, $value, $ttl);

 // Get extra labels for metrics
 $labels = [];
 if ($value instanceof PrometheusMetricInterface) {
 $labels['label'] = $value->getPrometheusMetricLabel();
 } else {
 $labels['label'] = $key;
 }

 if ($result) {
 // Calculate approximate size in bytes
 $size = $this->calculateSize($value);
 $this->metrics->recordWrite($key, $size);
 $this->metrics->recordWrite($key, $size, $labels);
 }

 return $result;
Expand Down

7 changes: 4 additions & 3 deletions
ProcessMaker/Cache/Monitoring/CacheMetricsInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,22 +12,23 @@ interface CacheMetricsInterface
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 * @param array $labels Additional labels to attach to the metric
 */
 public function recordHit(string $key, $microtime): void;
 public function recordHit(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache miss event
 *
 * @param string $key Cache key that was accessed
 * @param float $microtime Time taken for the operation in microseconds
 */
 public function recordMiss(string $key, $microtime): void;
 public function recordMiss(string $key, $microtime, array $labels = []): void;

 /**
 * Record a cache write operation
 *
 * @param string $key Cache key that was written
 * @param int $size Size of the cached data in bytes
 */
 public function recordWrite(string $key, int $size): void;
 public function recordWrite(string $key, int $size, array $labels = []): void;
}

29 changes: 16 additions & 13 deletions
ProcessMaker/Cache/Monitoring/PrometheusMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,21 +35,22 @@ public function __construct(string $namespace = 'cache')
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_hits_total',
 'Total number of cache hits',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);
 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -58,22 +59,23 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->counter(
 'cache_misses_total',
 'Total number of cache misses',
 ['cache_key']
 )->inc(['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->inc(['cache_key' => $sanitizedKey, ...$labels]);

 // record the last write timestamp
 $this->metrics->gauge(
 'cache_last_write_timestamp',
 'Last write timestamp',
 ['cache_key']
 )->set($microtime, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($microtime, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand All@@ -82,15 +84,16 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $sanitizedKey = $this->sanitizeKey($key);
 $labelKeys = array_keys($labels);

 $this->metrics->gauge(
 'cache_memory_bytes',
 'Memory usage in bytes',
 ['cache_key']
 )->set($size, ['cache_key' => $sanitizedKey]);
 ['cache_key', ...$labelKeys]
 )->set($size, ['cache_key' => $sanitizedKey, ...$labels]);
 }

 /**
Expand Down

6 changes: 3 additions & 3 deletions
ProcessMaker/Cache/Monitoring/RedisMetricsManager.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ class RedisMetricsManager implements CacheMetricsInterface
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordHit(string $key, $microtime): void
 public function recordHit(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -42,7 +42,7 @@ public function recordHit(string $key, $microtime): void
 * @param string $key Cache key
 * @param float $microtime Time taken in microseconds
 */
 public function recordMiss(string $key, $microtime): void
 public function recordMiss(string $key, $microtime, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $microtime) {
Expand All@@ -58,7 +58,7 @@ public function recordMiss(string $key, $microtime): void
 * @param string $key Cache key
 * @param int $size Size in bytes
 */
 public function recordWrite(string $key, int $size): void
 public function recordWrite(string $key, int $size, array $labels = []): void
 {
 $baseKey = self::METRICS_PREFIX . $key;
 Redis::pipeline(function ($pipe) use ($baseKey, $size) {
Expand Down

30 changes: 30 additions & 0 deletions
ProcessMaker/Cache/Screens/ScreenCache.php

View file


Open in desktop

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

namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Collection;
use ProcessMaker\Contracts\PrometheusMetricInterface;

class ScreenCache extends Collection implements PrometheusMetricInterface
{

 public string $label;

 public static function makeFrom(PrometheusMetricInterface $screen, $items): ScreenCache
 {
 $self = new static($items);
 $self->label = $screen->getPrometheusMetricLabel();

 return $self;
 }

 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string
 {
 return $this->label;
 }
}

13 changes: 13 additions & 0 deletions
ProcessMaker/Contracts/PrometheusMetricInterface.php

View file


Open in desktop

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

namespace ProcessMaker\Contracts;

interface PrometheusMetricInterface
{
 /**
 * Returns a legible or friendly name for Prometheus metrics.
 *
 * @return string
 */
 public function getPrometheusMetricLabel(): string;
}

8 changes: 8 additions & 0 deletions
ProcessMaker/Facades/Metrics.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,14 @@
use Illuminate\Support\Facades\Facade;
use ProcessMaker\Services\MetricsService;

/**
 * @method static \Prometheus\Counter counter(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Gauge gauge(string $name, string $help = null, array $labels = [])
 * @method static \Prometheus\Histogram histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10])
 * @method static void setGauge(string $name, float $value, array $labelValues = [])
 * @method static string renderMetrics()
 * @method static \Prometheus\CollectorRegistry getCollectionRegistry()
 */
class Metrics extends Facade
{
 /**
Expand Down

20 changes: 19 additions & 1 deletion
ProcessMaker/Jobs/CompleteActivity.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
namespace ProcessMaker\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Database\DatabaseManager;
use ProcessMaker\Facades\Metrics;
use ProcessMaker\Managers\DataManager;
use ProcessMaker\Models\Process as Definitions;
use ProcessMaker\Models\ProcessRequestToken;
Expand DownExpand Up@@ -46,5 +46,23 @@ public function action(ProcessRequestToken $token, ActivityInterface $element, a
 $manager->updateData($token, $data);
 $this->engine->runToNextState();
 $element->complete($token);

 Metrics::counter(
 'activity_completed_total',
 'Total number of activities completed',
 [
 'activity_id',
 'activity_name',
 'process_id',
 'request_id',
 ]
 )->inc(
 [
 'activity_id' => $element->getId(),
 'activity_name' => $element->getName(),
 'process_id' => $this->definitionsId,
 'request_id' => $this->instanceId,
 ]
 );
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Screen.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\Exportable;
Expand DownExpand Up@@ -63,7 +64,7 @@
 * @OA\Property(property="url", type="string"),
 * )
 */
class Screen extends ProcessMakerModel implements ScreenInterface
class Screen extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use SerializeToIso8601;
 use HideSystemResources;
Expand DownExpand Up@@ -283,4 +284,14 @@ public function scopeFilter($query, $filterStr)

 return $query;
 }

 /**
 * Return the label to be used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->id;
 }
}

8 changes: 7 additions & 1 deletion
ProcessMaker/Models/ScreenVersion.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,12 +3,13 @@
namespace ProcessMaker\Models;

use Illuminate\Database\Eloquent\Builder;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Events\TranslationChanged;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;

class ScreenVersion extends ProcessMakerModel implements ScreenInterface
class ScreenVersion extends ProcessMakerModel implements ScreenInterface, PrometheusMetricInterface
{
 use HasCategories;
 use HasScreenFields;
Expand DownExpand Up@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
 {
 return $query->where('draft', false);
 }

 public function getPrometheusMetricLabel(): string
 {
 return 'screen.' . $this->screen_id;
 }
}

13 changes: 12 additions & 1 deletion
ProcessMaker/Models/Setting.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
use Illuminate\Validation\Rule;
use Log;
use ProcessMaker\Cache\Settings\SettingCacheFactory;
use ProcessMaker\Contracts\PrometheusMetricInterface;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
Expand DownExpand Up@@ -48,7 +49,7 @@
 * },
 * )
 */
class Setting extends ProcessMakerModel implements HasMedia
class Setting extends ProcessMakerModel implements HasMedia, PrometheusMetricInterface
{
 use ExtendedPMQL;
 use InteractsWithMedia;
Expand DownExpand Up@@ -497,4 +498,14 @@ public static function updateAllSettingsGroupId()
 }
 });
 }

 /**
 * Get the label used in grafana reports
 *
 * @return string 
 */
 public function getPrometheusMetricLabel(): string
 {
 return 'settings.' . $this->key;
 }
}

12 changes: 11 additions & 1 deletion
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,7 +32,7 @@ class MetricsService
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 public function __construct(private $adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
Expand All@@ -49,6 +49,16 @@ public function __construct($adapter = null)
 }
 }

 /**
 * Get the collection registry.
 *
 * @return CollectorRegistry The collection registry instance.
 */
 public function getCollectionRegistry(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Registers or retrieves a counter metric.
 *
Expand Down
Loading