Implement PrometheusMetricInterface in Screens models

caleeli · Jan 17, 2025 · Jan 6, 2025 · Jan 7, 2025 · Jan 7, 2025 · Jan 8, 2025
commit a7049b1f691bf792bb53a7cea2cd24642d9a4787
diff --git a/ProcessMaker/Cache/Screens/ScreenCache.php b/ProcessMaker/Cache/Screens/ScreenCache.php
@@ -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;
+    }
+}
diff --git a/ProcessMaker/Models/Screen.php b/ProcessMaker/Models/Screen.php
@@ -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;
@@ -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;
@@ -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;
+    }
 }
diff --git a/ProcessMaker/Models/ScreenVersion.php b/ProcessMaker/Models/ScreenVersion.php
@@ -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;
@@ -77,4 +78,9 @@ public function scopePublished(Builder $query)
     {
         return $query->where('draft', false);
     }
+
+    public function getPrometheusMetricLabel(): string
+    {
+        return 'screen.' . $this->screen_id;
+    }
 }
diff --git a/ProcessMaker/Traits/HasScreenFields.php b/ProcessMaker/Traits/HasScreenFields.php
@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Arr;
 use Log;
+use ProcessMaker\Cache\Screens\ScreenCache;
 use ProcessMaker\Cache\Screens\ScreenCacheFactory;
 use ProcessMaker\Models\Column;
 use ProcessMaker\Models\Screen;
@@ -60,14 +61,15 @@ private function loadScreenFields()
         $parsedFields = $screenCache->get($key);
 
         if (!$parsedFields || collect($parsedFields)->isEmpty()) {
-            $this->parsedFields = collect([]);
+            $this->parsedFields = ScreenCache::makeFrom($this, []);
             if ($this->config) {
                 $this->walkArray($this->config);
             }
+            $this->parsedFields = ScreenCache::makeFrom($this, $this->parsedFields);
 
             $screenCache->set($key, $this->parsedFields);
         } else {
-            $this->parsedFields = collect($parsedFields);
+            $this->parsedFields = ScreenCache::makeFrom($this, $parsedFields);
         }
     }