Update readme and add namespace config#7833

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
nolanpro merged 3 commits into from
Dec 18, 2024
Merged

Update readme and add namespace config #7833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a63afa7
Update readme and add namespace config
nolanpro Dec 16, 2024
91d8a85
FOUR-21074 Improvements for a better user experience.
gproly Dec 17, 2024
ddbd267
Update prometheus.yml
nolanpro Dec 18, 2024
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
219 changes: 45 additions & 174 deletions ProcessMaker/Services/MetricsService.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@
namespace ProcessMaker\Services;

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
/**
* The CollectorRegistry instance used by the MetricsService.
*
* @var \Prometheus\CollectorRegistry
* @var CollectorRegistry
*/
private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
*
* @var string
*/
private $namespace = 'app';
private $namespace;

/**
* Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
* Example:
* $metricsService = new MetricsService(new Redis([
* 'host' => config('database.redis.default.host'),
* 'port' => config('database.redis.default.port'),
* ]));
*
* @param mixed $adapter The storage adapter to use (e.g., Redis).
*/
public function __construct($adapter = null)
{
$this->namespace = config('app.prometheus_namespace', 'app');
try {
// Set up Redis as the adapter if none is provided
if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
}

/**
* Returns the namespace used by the MetricsService.
* Registers or retrieves a counter metric.
*
* @return string The namespace used by the MetricsService.
*/
public function getNamespace(): string
{
return $this->namespace;
}

/**
* Sets the namespace used by the MetricsService.
*
* @param string $namespace The namespace to set.
*/
public function setNamespace(string $namespace): void
{
$this->namespace = $namespace;
}

/**
* Sets the CollectorRegistry used by the MetricsService.
* Example:
* $metricsService->setRegistry(new CollectorRegistry(new Redis([
* 'host' => config('database.redis.default.host'),
* 'port' => config('database.redis.default.port'),
* ])));
*
* @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
*/
public function setRegistry(CollectorRegistry $collectionRegistry): void
{
$this->collectionRegistry = $collectionRegistry;
}

/**
* Returns the CollectorRegistry used by the MetricsService.
*
* @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
*/
public function getMetrics(): CollectorRegistry
{
return $this->collectionRegistry;
}

/**
* Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
* Example:
* $metricsService->getMetricByName('app_http_requests_total');
*
* @param string $name The name of the metric to retrieve.
* @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
* @param string $name The name of the counter.
* @param string|null $help The help text of the counter.
* @param array $labels The labels of the counter.
* @return Counter The registered or retrieved counter.
*/
public function getMetricByName(string $name)
public function counter(string $name, string $help = null, array $labels = []): Counter
{
$metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
$help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
$this->namespace,
$name,
$help,
$labels
);
}

/**
* Registers a new counter metric.
* Example:
* $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
* Registers or retrieves a gauge metric.
*
* @param string $name The name of the counter.
* @param string $help The help text of the counter.
* @param array $labels The labels of the counter.
* @return \Prometheus\Counter The registered counter.
* @throws \RuntimeException If a metric with the same name already exists.
* @param string $name The name of the gauge.
* @param string|null $help The help text of the gauge.
* @param array $labels The labels of the gauge.
* @return Gauge The registered or retrieved gauge.
*/
public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
public function gauge(string $name, string $help = null, array $labels = []): Gauge
{
if ($this->getMetricByName($name) !== null) {
throw new RuntimeException("A metric with this name already exists. '{$name}'.");
}
return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
$help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterGauge(
$this->namespace,
$name,
$help,
$labels
);
}

/**
* Registers a new histogram metric.
* Example:
* $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
* Registers or retrieves a histogram metric.
*
* @param string $name The name of the histogram.
* @param string $help The help text of the histogram.
* @param string|null $help The help text of the histogram.
* @param array $labels The labels of the histogram.
* @param array $buckets The buckets of the histogram.
* @return \Prometheus\Histogram The registered histogram.
* @return Histogram The registered or retrieved histogram.
*/
public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
{
return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
}

/**
* Registers a new gauge metric.
* Example:
* $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
*
* @param string $name The name of the gauge.
* @param string $help The help text of the gauge.
* @param array $labels The labels of the gauge.
* @return \Prometheus\Gauge The registered gauge.
*/
public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
{
return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
$help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterHistogram(
$this->namespace,
$name,
$help,
$labels,
$buckets
);
}

/**
* Sets a gauge metric to a specific value.
* Example:
* $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
*
* @param string $name The name of the gauge.
* @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
$gauge->set($value, $labelValues);
}

/**
* Increments a counter metric by 1.
* Example:
* $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
*
* @param string $name The name of the counter.
* @param array $labelValues The values of the labels for the counter.
* @throws \RuntimeException If the counter could not be incremented.
*/
public function incrementCounter(string $name, array $labelValues = []): void
{
try {
$counter = $this->collectionRegistry->getCounter($this->namespace, $name);
$counter->inc($labelValues);
} catch (Exception $e) {
throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
}
}

/**
* Observes a value for a histogram metric.
* Example:
* $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
*
* @param string $name The name of the histogram.
* @param float $value The value to observe.
* @param array $labelValues The values of the labels for the histogram.
*/
public function observeHistogram(string $name, float $value, array $labelValues = []): void
{
$histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
$histogram->observe($value, $labelValues);
}

/**
* Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
* Example: This is useful to monitor the number of active jobs in the queue.
* $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
*
* @param string $key The cache key.
* @param string $metricName The Prometheus metric name.
* @param string $help The help text for the gauge.
* @param array $labels The labels for the gauge.
* @param float $increment The value to increment.
*/
public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
{
// Retrieve and update the cache
$currentValue = Cache::increment($key, $increment);

// Register the gauge if it doesn't exist
if ($this->getMetricByName($metricName) === null) {
$this->registerGauge($metricName, $help, $labels);
}

// Update the gauge with the cached value
$this->setGauge($metricName, $currentValue, []);
}

/**
* Renders the metrics in the Prometheus text format.
*
* @return string The rendered metrics.
*/
public function renderMetrics()
public function renderMetrics(): string
{
$renderer = new RenderTextFormat();
$metrics = $this->collectionRegistry->getMetricFamilySamples();
return $renderer->render($metrics);
}

/**
* Helper to register a default set of metrics for common Laravel use cases.
*/
public function registerDefaultMetrics(): void
{
$this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
$this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
$this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
$this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
}
}
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
Update readme and add namespace config#7833

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

nolanpro
merged 3 commits into

from

Dec 18, 2024
 Merged


Update readme and add namespace config
#7833
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a63afa7

Update readme and add namespace config


nolanpro Dec 16, 2024
91d8a85

FOUR-21074 Improvements for a better user experience.


gproly Dec 17, 2024
ddbd267

Update prometheus.yml


nolanpro Dec 18, 2024

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


219 changes: 45 additions & 174 deletions
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

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

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
 /**
 * The CollectorRegistry instance used by the MetricsService.
 *
 * @var \Prometheus\CollectorRegistry
 * @var CollectorRegistry
 */
 private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
 *
 * @var string
 */
 private $namespace = 'app';
 private $namespace;

 /**
 * Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
 * Example:
 * $metricsService = new MetricsService(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ]));
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
 // Set up Redis as the adapter if none is provided
 if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
 }

 /**
 * Returns the namespace used by the MetricsService.
 * Registers or retrieves a counter metric.
 *
 * @return string The namespace used by the MetricsService.
 */
 public function getNamespace(): string
 {
 return $this->namespace;
 }

 /**
 * Sets the namespace used by the MetricsService.
 *
 * @param string $namespace The namespace to set.
 */
 public function setNamespace(string $namespace): void
 {
 $this->namespace = $namespace;
 }

 /**
 * Sets the CollectorRegistry used by the MetricsService.
 * Example:
 * $metricsService->setRegistry(new CollectorRegistry(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ])));
 *
 * @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
 */
 public function setRegistry(CollectorRegistry $collectionRegistry): void
 {
 $this->collectionRegistry = $collectionRegistry;
 }

 /**
 * Returns the CollectorRegistry used by the MetricsService.
 *
 * @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
 */
 public function getMetrics(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
 * Example:
 * $metricsService->getMetricByName('app_http_requests_total');
 *
 * @param string $name The name of the metric to retrieve.
 * @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
 * @param string $name The name of the counter.
 * @param string|null $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return Counter The registered or retrieved counter.
 */
 public function getMetricByName(string $name)
 public function counter(string $name, string $help = null, array $labels = []): Counter
 {
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
 $help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
 $this->namespace,
$name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new counter metric.
 * Example:
 * $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 * Registers or retrieves a gauge metric.
 *
 * @param string $name The name of the counter.
 * @param string $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return \Prometheus\Counter The registered counter.
 * @throws \RuntimeException If a metric with the same name already exists.
 * @param string $name The name of the gauge.
 * @param string|null $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return Gauge The registered or retrieved gauge.
 */
 public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
 public function gauge(string $name, string $help = null, array $labels = []): Gauge
 {
 if ($this->getMetricByName($name) !== null) {
 throw new RuntimeException("A metric with this name already exists. '{$name}'.");
 }
 return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterGauge(
 $this->namespace,
 $name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new histogram metric.
 * Example:
 * $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 * Registers or retrieves a histogram metric.
 *
 * @param string $name The name of the histogram.
 * @param string $help The help text of the histogram.
 * @param string|null $help The help text of the histogram.
 * @param array $labels The labels of the histogram.
 * @param array $buckets The buckets of the histogram.
 * @return \Prometheus\Histogram The registered histogram.
 * @return Histogram The registered or retrieved histogram.
 */
 public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
 public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
 {
 return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
 }

 /**
 * Registers a new gauge metric.
 * Example:
 * $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
 *
 * @param string $name The name of the gauge.
 * @param string $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return \Prometheus\Gauge The registered gauge.
 */
 public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
 {
 return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterHistogram(
 $this->namespace,
 $name,
 $help,
 $labels,
 $buckets
 );
 }

 /**
 * Sets a gauge metric to a specific value.
 * Example:
 * $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
 *
 * @param string $name The name of the gauge.
 * @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
 $gauge->set($value, $labelValues);
 }

 /**
 * Increments a counter metric by 1.
 * Example:
 * $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
 *
 * @param string $name The name of the counter.
 * @param array $labelValues The values of the labels for the counter.
 * @throws \RuntimeException If the counter could not be incremented.
 */
 public function incrementCounter(string $name, array $labelValues = []): void
 {
 try {
 $counter = $this->collectionRegistry->getCounter($this->namespace, $name);
 $counter->inc($labelValues);
 } catch (Exception $e) {
 throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
 }
 }

 /**
 * Observes a value for a histogram metric.
 * Example:
 * $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
 *
 * @param string $name The name of the histogram.
 * @param float $value The value to observe.
 * @param array $labelValues The values of the labels for the histogram.
 */
 public function observeHistogram(string $name, float $value, array $labelValues = []): void
 {
 $histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
 $histogram->observe($value, $labelValues);
 }

 /**
 * Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
 * Example: This is useful to monitor the number of active jobs in the queue.
 * $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
 *
 * @param string $key The cache key.
 * @param string $metricName The Prometheus metric name.
 * @param string $help The help text for the gauge.
 * @param array $labels The labels for the gauge.
 * @param float $increment The value to increment.
 */
 public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
 {
 // Retrieve and update the cache
 $currentValue = Cache::increment($key, $increment);

 // Register the gauge if it doesn't exist
 if ($this->getMetricByName($metricName) === null) {
 $this->registerGauge($metricName, $help, $labels);
 }

 // Update the gauge with the cached value
 $this->setGauge($metricName, $currentValue, []);
 }

 /**
 * Renders the metrics in the Prometheus text format.
 *
 * @return string The rendered metrics.
 */
 public function renderMetrics()
 public function renderMetrics(): string
 {
 $renderer = new RenderTextFormat();
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
 return $renderer->render($metrics);
 }

 /**
 * Helper to register a default set of metrics for common Laravel use cases.
 */
 public function registerDefaultMetrics(): void
 {
 $this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 $this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 $this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
 $this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
 }
}
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
Update readme and add namespace config#7833

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

nolanpro
merged 3 commits into

from

Dec 18, 2024
 Merged


Update readme and add namespace config
#7833
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a63afa7

Update readme and add namespace config


nolanpro Dec 16, 2024
91d8a85

FOUR-21074 Improvements for a better user experience.


gproly Dec 17, 2024
ddbd267

Update prometheus.yml


nolanpro Dec 18, 2024

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


219 changes: 45 additions & 174 deletions
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

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

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
 /**
 * The CollectorRegistry instance used by the MetricsService.
 *
 * @var \Prometheus\CollectorRegistry
 * @var CollectorRegistry
 */
 private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
 *
 * @var string
 */
 private $namespace = 'app';
 private $namespace;

 /**
 * Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
 * Example:
 * $metricsService = new MetricsService(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ]));
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
 // Set up Redis as the adapter if none is provided
 if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
 }

 /**
 * Returns the namespace used by the MetricsService.
 * Registers or retrieves a counter metric.
 *
 * @return string The namespace used by the MetricsService.
 */
 public function getNamespace(): string
 {
 return $this->namespace;
 }

 /**
 * Sets the namespace used by the MetricsService.
 *
 * @param string $namespace The namespace to set.
 */
 public function setNamespace(string $namespace): void
 {
 $this->namespace = $namespace;
 }

 /**
 * Sets the CollectorRegistry used by the MetricsService.
 * Example:
 * $metricsService->setRegistry(new CollectorRegistry(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ])));
 *
 * @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
 */
 public function setRegistry(CollectorRegistry $collectionRegistry): void
 {
 $this->collectionRegistry = $collectionRegistry;
 }

 /**
 * Returns the CollectorRegistry used by the MetricsService.
 *
 * @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
 */
 public function getMetrics(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
 * Example:
 * $metricsService->getMetricByName('app_http_requests_total');
 *
 * @param string $name The name of the metric to retrieve.
 * @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
 * @param string $name The name of the counter.
 * @param string|null $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return Counter The registered or retrieved counter.
 */
 public function getMetricByName(string $name)
 public function counter(string $name, string $help = null, array $labels = []): Counter
 {
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
 $help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
 $this->namespace,
$name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new counter metric.
 * Example:
 * $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 * Registers or retrieves a gauge metric.
 *
 * @param string $name The name of the counter.
 * @param string $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return \Prometheus\Counter The registered counter.
 * @throws \RuntimeException If a metric with the same name already exists.
 * @param string $name The name of the gauge.
 * @param string|null $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return Gauge The registered or retrieved gauge.
 */
 public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
 public function gauge(string $name, string $help = null, array $labels = []): Gauge
 {
 if ($this->getMetricByName($name) !== null) {
 throw new RuntimeException("A metric with this name already exists. '{$name}'.");
 }
 return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterGauge(
 $this->namespace,
 $name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new histogram metric.
 * Example:
 * $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 * Registers or retrieves a histogram metric.
 *
 * @param string $name The name of the histogram.
 * @param string $help The help text of the histogram.
 * @param string|null $help The help text of the histogram.
 * @param array $labels The labels of the histogram.
 * @param array $buckets The buckets of the histogram.
 * @return \Prometheus\Histogram The registered histogram.
 * @return Histogram The registered or retrieved histogram.
 */
 public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
 public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
 {
 return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
 }

 /**
 * Registers a new gauge metric.
 * Example:
 * $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
 *
 * @param string $name The name of the gauge.
 * @param string $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return \Prometheus\Gauge The registered gauge.
 */
 public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
 {
 return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterHistogram(
 $this->namespace,
 $name,
 $help,
 $labels,
 $buckets
 );
 }

 /**
 * Sets a gauge metric to a specific value.
 * Example:
 * $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
 *
 * @param string $name The name of the gauge.
 * @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
 $gauge->set($value, $labelValues);
 }

 /**
 * Increments a counter metric by 1.
 * Example:
 * $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
 *
 * @param string $name The name of the counter.
 * @param array $labelValues The values of the labels for the counter.
 * @throws \RuntimeException If the counter could not be incremented.
 */
 public function incrementCounter(string $name, array $labelValues = []): void
 {
 try {
 $counter = $this->collectionRegistry->getCounter($this->namespace, $name);
 $counter->inc($labelValues);
 } catch (Exception $e) {
 throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
 }
 }

 /**
 * Observes a value for a histogram metric.
 * Example:
 * $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
 *
 * @param string $name The name of the histogram.
 * @param float $value The value to observe.
 * @param array $labelValues The values of the labels for the histogram.
 */
 public function observeHistogram(string $name, float $value, array $labelValues = []): void
 {
 $histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
 $histogram->observe($value, $labelValues);
 }

 /**
 * Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
 * Example: This is useful to monitor the number of active jobs in the queue.
 * $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
 *
 * @param string $key The cache key.
 * @param string $metricName The Prometheus metric name.
 * @param string $help The help text for the gauge.
 * @param array $labels The labels for the gauge.
 * @param float $increment The value to increment.
 */
 public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
 {
 // Retrieve and update the cache
 $currentValue = Cache::increment($key, $increment);

 // Register the gauge if it doesn't exist
 if ($this->getMetricByName($metricName) === null) {
 $this->registerGauge($metricName, $help, $labels);
 }

 // Update the gauge with the cached value
 $this->setGauge($metricName, $currentValue, []);
 }

 /**
 * Renders the metrics in the Prometheus text format.
 *
 * @return string The rendered metrics.
 */
 public function renderMetrics()
 public function renderMetrics(): string
 {
 $renderer = new RenderTextFormat();
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
 return $renderer->render($metrics);
 }

 /**
 * Helper to register a default set of metrics for common Laravel use cases.
 */
 public function registerDefaultMetrics(): void
 {
 $this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 $this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 $this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
 $this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
 }
}
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
Update readme and add namespace config#7833

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

nolanpro
merged 3 commits into

from

Dec 18, 2024
 Merged


Update readme and add namespace config
#7833
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a63afa7

Update readme and add namespace config


nolanpro Dec 16, 2024
91d8a85

FOUR-21074 Improvements for a better user experience.


gproly Dec 17, 2024
ddbd267

Update prometheus.yml


nolanpro Dec 18, 2024

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


219 changes: 45 additions & 174 deletions
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

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

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
 /**
 * The CollectorRegistry instance used by the MetricsService.
 *
 * @var \Prometheus\CollectorRegistry
 * @var CollectorRegistry
 */
 private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
 *
 * @var string
 */
 private $namespace = 'app';
 private $namespace;

 /**
 * Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
 * Example:
 * $metricsService = new MetricsService(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ]));
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
 // Set up Redis as the adapter if none is provided
 if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
 }

 /**
 * Returns the namespace used by the MetricsService.
 * Registers or retrieves a counter metric.
 *
 * @return string The namespace used by the MetricsService.
 */
 public function getNamespace(): string
 {
 return $this->namespace;
 }

 /**
 * Sets the namespace used by the MetricsService.
 *
 * @param string $namespace The namespace to set.
 */
 public function setNamespace(string $namespace): void
 {
 $this->namespace = $namespace;
 }

 /**
 * Sets the CollectorRegistry used by the MetricsService.
 * Example:
 * $metricsService->setRegistry(new CollectorRegistry(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ])));
 *
 * @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
 */
 public function setRegistry(CollectorRegistry $collectionRegistry): void
 {
 $this->collectionRegistry = $collectionRegistry;
 }

 /**
 * Returns the CollectorRegistry used by the MetricsService.
 *
 * @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
 */
 public function getMetrics(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
 * Example:
 * $metricsService->getMetricByName('app_http_requests_total');
 *
 * @param string $name The name of the metric to retrieve.
 * @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
 * @param string $name The name of the counter.
 * @param string|null $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return Counter The registered or retrieved counter.
 */
 public function getMetricByName(string $name)
 public function counter(string $name, string $help = null, array $labels = []): Counter
 {
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
 $help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
 $this->namespace,
$name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new counter metric.
 * Example:
 * $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 * Registers or retrieves a gauge metric.
 *
 * @param string $name The name of the counter.
 * @param string $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return \Prometheus\Counter The registered counter.
 * @throws \RuntimeException If a metric with the same name already exists.
 * @param string $name The name of the gauge.
 * @param string|null $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return Gauge The registered or retrieved gauge.
 */
 public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
 public function gauge(string $name, string $help = null, array $labels = []): Gauge
 {
 if ($this->getMetricByName($name) !== null) {
 throw new RuntimeException("A metric with this name already exists. '{$name}'.");
 }
 return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterGauge(
 $this->namespace,
 $name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new histogram metric.
 * Example:
 * $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 * Registers or retrieves a histogram metric.
 *
 * @param string $name The name of the histogram.
 * @param string $help The help text of the histogram.
 * @param string|null $help The help text of the histogram.
 * @param array $labels The labels of the histogram.
 * @param array $buckets The buckets of the histogram.
 * @return \Prometheus\Histogram The registered histogram.
 * @return Histogram The registered or retrieved histogram.
 */
 public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
 public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
 {
 return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
 }

 /**
 * Registers a new gauge metric.
 * Example:
 * $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
 *
 * @param string $name The name of the gauge.
 * @param string $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return \Prometheus\Gauge The registered gauge.
 */
 public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
 {
 return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterHistogram(
 $this->namespace,
 $name,
 $help,
 $labels,
 $buckets
 );
 }

 /**
 * Sets a gauge metric to a specific value.
 * Example:
 * $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
 *
 * @param string $name The name of the gauge.
 * @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
 $gauge->set($value, $labelValues);
 }

 /**
 * Increments a counter metric by 1.
 * Example:
 * $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
 *
 * @param string $name The name of the counter.
 * @param array $labelValues The values of the labels for the counter.
 * @throws \RuntimeException If the counter could not be incremented.
 */
 public function incrementCounter(string $name, array $labelValues = []): void
 {
 try {
 $counter = $this->collectionRegistry->getCounter($this->namespace, $name);
 $counter->inc($labelValues);
 } catch (Exception $e) {
 throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
 }
 }

 /**
 * Observes a value for a histogram metric.
 * Example:
 * $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
 *
 * @param string $name The name of the histogram.
 * @param float $value The value to observe.
 * @param array $labelValues The values of the labels for the histogram.
 */
 public function observeHistogram(string $name, float $value, array $labelValues = []): void
 {
 $histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
 $histogram->observe($value, $labelValues);
 }

 /**
 * Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
 * Example: This is useful to monitor the number of active jobs in the queue.
 * $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
 *
 * @param string $key The cache key.
 * @param string $metricName The Prometheus metric name.
 * @param string $help The help text for the gauge.
 * @param array $labels The labels for the gauge.
 * @param float $increment The value to increment.
 */
 public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
 {
 // Retrieve and update the cache
 $currentValue = Cache::increment($key, $increment);

 // Register the gauge if it doesn't exist
 if ($this->getMetricByName($metricName) === null) {
 $this->registerGauge($metricName, $help, $labels);
 }

 // Update the gauge with the cached value
 $this->setGauge($metricName, $currentValue, []);
 }

 /**
 * Renders the metrics in the Prometheus text format.
 *
 * @return string The rendered metrics.
 */
 public function renderMetrics()
 public function renderMetrics(): string
 {
 $renderer = new RenderTextFormat();
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
 return $renderer->render($metrics);
 }

 /**
 * Helper to register a default set of metrics for common Laravel use cases.
 */
 public function registerDefaultMetrics(): void
 {
 $this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 $this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 $this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
 $this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
 }
}
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
Update readme and add namespace config#7833

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

nolanpro
merged 3 commits into

from

Dec 18, 2024
 Merged


Update readme and add namespace config
#7833
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a63afa7

Update readme and add namespace config


nolanpro Dec 16, 2024
91d8a85

FOUR-21074 Improvements for a better user experience.


gproly Dec 17, 2024
ddbd267

Update prometheus.yml


nolanpro Dec 18, 2024

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


219 changes: 45 additions & 174 deletions
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

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

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
 /**
 * The CollectorRegistry instance used by the MetricsService.
 *
 * @var \Prometheus\CollectorRegistry
 * @var CollectorRegistry
 */
 private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
 *
 * @var string
 */
 private $namespace = 'app';
 private $namespace;

 /**
 * Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
 * Example:
 * $metricsService = new MetricsService(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ]));
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
 // Set up Redis as the adapter if none is provided
 if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
 }

 /**
 * Returns the namespace used by the MetricsService.
 * Registers or retrieves a counter metric.
 *
 * @return string The namespace used by the MetricsService.
 */
 public function getNamespace(): string
 {
 return $this->namespace;
 }

 /**
 * Sets the namespace used by the MetricsService.
 *
 * @param string $namespace The namespace to set.
 */
 public function setNamespace(string $namespace): void
 {
 $this->namespace = $namespace;
 }

 /**
 * Sets the CollectorRegistry used by the MetricsService.
 * Example:
 * $metricsService->setRegistry(new CollectorRegistry(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ])));
 *
 * @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
 */
 public function setRegistry(CollectorRegistry $collectionRegistry): void
 {
 $this->collectionRegistry = $collectionRegistry;
 }

 /**
 * Returns the CollectorRegistry used by the MetricsService.
 *
 * @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
 */
 public function getMetrics(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
 * Example:
 * $metricsService->getMetricByName('app_http_requests_total');
 *
 * @param string $name The name of the metric to retrieve.
 * @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
 * @param string $name The name of the counter.
 * @param string|null $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return Counter The registered or retrieved counter.
 */
 public function getMetricByName(string $name)
 public function counter(string $name, string $help = null, array $labels = []): Counter
 {
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
 $help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
 $this->namespace,
$name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new counter metric.
 * Example:
 * $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 * Registers or retrieves a gauge metric.
 *
 * @param string $name The name of the counter.
 * @param string $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return \Prometheus\Counter The registered counter.
 * @throws \RuntimeException If a metric with the same name already exists.
 * @param string $name The name of the gauge.
 * @param string|null $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return Gauge The registered or retrieved gauge.
 */
 public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
 public function gauge(string $name, string $help = null, array $labels = []): Gauge
 {
 if ($this->getMetricByName($name) !== null) {
 throw new RuntimeException("A metric with this name already exists. '{$name}'.");
 }
 return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterGauge(
 $this->namespace,
 $name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new histogram metric.
 * Example:
 * $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 * Registers or retrieves a histogram metric.
 *
 * @param string $name The name of the histogram.
 * @param string $help The help text of the histogram.
 * @param string|null $help The help text of the histogram.
 * @param array $labels The labels of the histogram.
 * @param array $buckets The buckets of the histogram.
 * @return \Prometheus\Histogram The registered histogram.
 * @return Histogram The registered or retrieved histogram.
 */
 public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
 public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
 {
 return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
 }

 /**
 * Registers a new gauge metric.
 * Example:
 * $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
 *
 * @param string $name The name of the gauge.
 * @param string $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return \Prometheus\Gauge The registered gauge.
 */
 public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
 {
 return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterHistogram(
 $this->namespace,
 $name,
 $help,
 $labels,
 $buckets
 );
 }

 /**
 * Sets a gauge metric to a specific value.
 * Example:
 * $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
 *
 * @param string $name The name of the gauge.
 * @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
 $gauge->set($value, $labelValues);
 }

 /**
 * Increments a counter metric by 1.
 * Example:
 * $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
 *
 * @param string $name The name of the counter.
 * @param array $labelValues The values of the labels for the counter.
 * @throws \RuntimeException If the counter could not be incremented.
 */
 public function incrementCounter(string $name, array $labelValues = []): void
 {
 try {
 $counter = $this->collectionRegistry->getCounter($this->namespace, $name);
 $counter->inc($labelValues);
 } catch (Exception $e) {
 throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
 }
 }

 /**
 * Observes a value for a histogram metric.
 * Example:
 * $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
 *
 * @param string $name The name of the histogram.
 * @param float $value The value to observe.
 * @param array $labelValues The values of the labels for the histogram.
 */
 public function observeHistogram(string $name, float $value, array $labelValues = []): void
 {
 $histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
 $histogram->observe($value, $labelValues);
 }

 /**
 * Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
 * Example: This is useful to monitor the number of active jobs in the queue.
 * $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
 *
 * @param string $key The cache key.
 * @param string $metricName The Prometheus metric name.
 * @param string $help The help text for the gauge.
 * @param array $labels The labels for the gauge.
 * @param float $increment The value to increment.
 */
 public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
 {
 // Retrieve and update the cache
 $currentValue = Cache::increment($key, $increment);

 // Register the gauge if it doesn't exist
 if ($this->getMetricByName($metricName) === null) {
 $this->registerGauge($metricName, $help, $labels);
 }

 // Update the gauge with the cached value
 $this->setGauge($metricName, $currentValue, []);
 }

 /**
 * Renders the metrics in the Prometheus text format.
 *
 * @return string The rendered metrics.
 */
 public function renderMetrics()
 public function renderMetrics(): string
 {
 $renderer = new RenderTextFormat();
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
 return $renderer->render($metrics);
 }

 /**
 * Helper to register a default set of metrics for common Laravel use cases.
 */
 public function registerDefaultMetrics(): void
 {
 $this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 $this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 $this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
 $this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
 }
}
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
Update readme and add namespace config#7833

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

nolanpro
merged 3 commits into

from

Dec 18, 2024
 Merged


Update readme and add namespace config
#7833
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a63afa7

Update readme and add namespace config


nolanpro Dec 16, 2024
91d8a85

FOUR-21074 Improvements for a better user experience.


gproly Dec 17, 2024
ddbd267

Update prometheus.yml


nolanpro Dec 18, 2024

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


219 changes: 45 additions & 174 deletions
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

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

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
 /**
 * The CollectorRegistry instance used by the MetricsService.
 *
 * @var \Prometheus\CollectorRegistry
 * @var CollectorRegistry
 */
 private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
 *
 * @var string
 */
 private $namespace = 'app';
 private $namespace;

 /**
 * Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
 * Example:
 * $metricsService = new MetricsService(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ]));
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
 // Set up Redis as the adapter if none is provided
 if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
 }

 /**
 * Returns the namespace used by the MetricsService.
 * Registers or retrieves a counter metric.
 *
 * @return string The namespace used by the MetricsService.
 */
 public function getNamespace(): string
 {
 return $this->namespace;
 }

 /**
 * Sets the namespace used by the MetricsService.
 *
 * @param string $namespace The namespace to set.
 */
 public function setNamespace(string $namespace): void
 {
 $this->namespace = $namespace;
 }

 /**
 * Sets the CollectorRegistry used by the MetricsService.
 * Example:
 * $metricsService->setRegistry(new CollectorRegistry(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ])));
 *
 * @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
 */
 public function setRegistry(CollectorRegistry $collectionRegistry): void
 {
 $this->collectionRegistry = $collectionRegistry;
 }

 /**
 * Returns the CollectorRegistry used by the MetricsService.
 *
 * @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
 */
 public function getMetrics(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
 * Example:
 * $metricsService->getMetricByName('app_http_requests_total');
 *
 * @param string $name The name of the metric to retrieve.
 * @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
 * @param string $name The name of the counter.
 * @param string|null $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return Counter The registered or retrieved counter.
 */
 public function getMetricByName(string $name)
 public function counter(string $name, string $help = null, array $labels = []): Counter
 {
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
 $help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
 $this->namespace,
$name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new counter metric.
 * Example:
 * $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 * Registers or retrieves a gauge metric.
 *
 * @param string $name The name of the counter.
 * @param string $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return \Prometheus\Counter The registered counter.
 * @throws \RuntimeException If a metric with the same name already exists.
 * @param string $name The name of the gauge.
 * @param string|null $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return Gauge The registered or retrieved gauge.
 */
 public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
 public function gauge(string $name, string $help = null, array $labels = []): Gauge
 {
 if ($this->getMetricByName($name) !== null) {
 throw new RuntimeException("A metric with this name already exists. '{$name}'.");
 }
 return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterGauge(
 $this->namespace,
 $name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new histogram metric.
 * Example:
 * $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 * Registers or retrieves a histogram metric.
 *
 * @param string $name The name of the histogram.
 * @param string $help The help text of the histogram.
 * @param string|null $help The help text of the histogram.
 * @param array $labels The labels of the histogram.
 * @param array $buckets The buckets of the histogram.
 * @return \Prometheus\Histogram The registered histogram.
 * @return Histogram The registered or retrieved histogram.
 */
 public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
 public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
 {
 return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
 }

 /**
 * Registers a new gauge metric.
 * Example:
 * $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
 *
 * @param string $name The name of the gauge.
 * @param string $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return \Prometheus\Gauge The registered gauge.
 */
 public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
 {
 return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterHistogram(
 $this->namespace,
 $name,
 $help,
 $labels,
 $buckets
 );
 }

 /**
 * Sets a gauge metric to a specific value.
 * Example:
 * $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
 *
 * @param string $name The name of the gauge.
 * @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
 $gauge->set($value, $labelValues);
 }

 /**
 * Increments a counter metric by 1.
 * Example:
 * $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
 *
 * @param string $name The name of the counter.
 * @param array $labelValues The values of the labels for the counter.
 * @throws \RuntimeException If the counter could not be incremented.
 */
 public function incrementCounter(string $name, array $labelValues = []): void
 {
 try {
 $counter = $this->collectionRegistry->getCounter($this->namespace, $name);
 $counter->inc($labelValues);
 } catch (Exception $e) {
 throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
 }
 }

 /**
 * Observes a value for a histogram metric.
 * Example:
 * $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
 *
 * @param string $name The name of the histogram.
 * @param float $value The value to observe.
 * @param array $labelValues The values of the labels for the histogram.
 */
 public function observeHistogram(string $name, float $value, array $labelValues = []): void
 {
 $histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
 $histogram->observe($value, $labelValues);
 }

 /**
 * Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
 * Example: This is useful to monitor the number of active jobs in the queue.
 * $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
 *
 * @param string $key The cache key.
 * @param string $metricName The Prometheus metric name.
 * @param string $help The help text for the gauge.
 * @param array $labels The labels for the gauge.
 * @param float $increment The value to increment.
 */
 public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
 {
 // Retrieve and update the cache
 $currentValue = Cache::increment($key, $increment);

 // Register the gauge if it doesn't exist
 if ($this->getMetricByName($metricName) === null) {
 $this->registerGauge($metricName, $help, $labels);
 }

 // Update the gauge with the cached value
 $this->setGauge($metricName, $currentValue, []);
 }

 /**
 * Renders the metrics in the Prometheus text format.
 *
 * @return string The rendered metrics.
 */
 public function renderMetrics()
 public function renderMetrics(): string
 {
 $renderer = new RenderTextFormat();
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
 return $renderer->render($metrics);
 }

 /**
 * Helper to register a default set of metrics for common Laravel use cases.
 */
 public function registerDefaultMetrics(): void
 {
 $this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 $this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 $this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
 $this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
 }
}
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
Update readme and add namespace config#7833

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

nolanpro
merged 3 commits into

from

Dec 18, 2024
 Merged


Update readme and add namespace config
#7833
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a63afa7

Update readme and add namespace config


nolanpro Dec 16, 2024
91d8a85

FOUR-21074 Improvements for a better user experience.


gproly Dec 17, 2024
ddbd267

Update prometheus.yml


nolanpro Dec 18, 2024

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


219 changes: 45 additions & 174 deletions
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

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

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
 /**
 * The CollectorRegistry instance used by the MetricsService.
 *
 * @var \Prometheus\CollectorRegistry
 * @var CollectorRegistry
 */
 private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
 *
 * @var string
 */
 private $namespace = 'app';
 private $namespace;

 /**
 * Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
 * Example:
 * $metricsService = new MetricsService(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ]));
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
 // Set up Redis as the adapter if none is provided
 if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
 }

 /**
 * Returns the namespace used by the MetricsService.
 * Registers or retrieves a counter metric.
 *
 * @return string The namespace used by the MetricsService.
 */
 public function getNamespace(): string
 {
 return $this->namespace;
 }

 /**
 * Sets the namespace used by the MetricsService.
 *
 * @param string $namespace The namespace to set.
 */
 public function setNamespace(string $namespace): void
 {
 $this->namespace = $namespace;
 }

 /**
 * Sets the CollectorRegistry used by the MetricsService.
 * Example:
 * $metricsService->setRegistry(new CollectorRegistry(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ])));
 *
 * @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
 */
 public function setRegistry(CollectorRegistry $collectionRegistry): void
 {
 $this->collectionRegistry = $collectionRegistry;
 }

 /**
 * Returns the CollectorRegistry used by the MetricsService.
 *
 * @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
 */
 public function getMetrics(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
 * Example:
 * $metricsService->getMetricByName('app_http_requests_total');
 *
 * @param string $name The name of the metric to retrieve.
 * @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
 * @param string $name The name of the counter.
 * @param string|null $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return Counter The registered or retrieved counter.
 */
 public function getMetricByName(string $name)
 public function counter(string $name, string $help = null, array $labels = []): Counter
 {
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
 $help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
 $this->namespace,
$name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new counter metric.
 * Example:
 * $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 * Registers or retrieves a gauge metric.
 *
 * @param string $name The name of the counter.
 * @param string $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return \Prometheus\Counter The registered counter.
 * @throws \RuntimeException If a metric with the same name already exists.
 * @param string $name The name of the gauge.
 * @param string|null $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return Gauge The registered or retrieved gauge.
 */
 public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
 public function gauge(string $name, string $help = null, array $labels = []): Gauge
 {
 if ($this->getMetricByName($name) !== null) {
 throw new RuntimeException("A metric with this name already exists. '{$name}'.");
 }
 return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterGauge(
 $this->namespace,
 $name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new histogram metric.
 * Example:
 * $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 * Registers or retrieves a histogram metric.
 *
 * @param string $name The name of the histogram.
 * @param string $help The help text of the histogram.
 * @param string|null $help The help text of the histogram.
 * @param array $labels The labels of the histogram.
 * @param array $buckets The buckets of the histogram.
 * @return \Prometheus\Histogram The registered histogram.
 * @return Histogram The registered or retrieved histogram.
 */
 public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
 public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
 {
 return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
 }

 /**
 * Registers a new gauge metric.
 * Example:
 * $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
 *
 * @param string $name The name of the gauge.
 * @param string $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return \Prometheus\Gauge The registered gauge.
 */
 public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
 {
 return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterHistogram(
 $this->namespace,
 $name,
 $help,
 $labels,
 $buckets
 );
 }

 /**
 * Sets a gauge metric to a specific value.
 * Example:
 * $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
 *
 * @param string $name The name of the gauge.
 * @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
 $gauge->set($value, $labelValues);
 }

 /**
 * Increments a counter metric by 1.
 * Example:
 * $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
 *
 * @param string $name The name of the counter.
 * @param array $labelValues The values of the labels for the counter.
 * @throws \RuntimeException If the counter could not be incremented.
 */
 public function incrementCounter(string $name, array $labelValues = []): void
 {
 try {
 $counter = $this->collectionRegistry->getCounter($this->namespace, $name);
 $counter->inc($labelValues);
 } catch (Exception $e) {
 throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
 }
 }

 /**
 * Observes a value for a histogram metric.
 * Example:
 * $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
 *
 * @param string $name The name of the histogram.
 * @param float $value The value to observe.
 * @param array $labelValues The values of the labels for the histogram.
 */
 public function observeHistogram(string $name, float $value, array $labelValues = []): void
 {
 $histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
 $histogram->observe($value, $labelValues);
 }

 /**
 * Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
 * Example: This is useful to monitor the number of active jobs in the queue.
 * $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
 *
 * @param string $key The cache key.
 * @param string $metricName The Prometheus metric name.
 * @param string $help The help text for the gauge.
 * @param array $labels The labels for the gauge.
 * @param float $increment The value to increment.
 */
 public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
 {
 // Retrieve and update the cache
 $currentValue = Cache::increment($key, $increment);

 // Register the gauge if it doesn't exist
 if ($this->getMetricByName($metricName) === null) {
 $this->registerGauge($metricName, $help, $labels);
 }

 // Update the gauge with the cached value
 $this->setGauge($metricName, $currentValue, []);
 }

 /**
 * Renders the metrics in the Prometheus text format.
 *
 * @return string The rendered metrics.
 */
 public function renderMetrics()
 public function renderMetrics(): string
 {
 $renderer = new RenderTextFormat();
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
 return $renderer->render($metrics);
 }

 /**
 * Helper to register a default set of metrics for common Laravel use cases.
 */
 public function registerDefaultMetrics(): void
 {
 $this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 $this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 $this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
 $this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
 }
}
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
Update readme and add namespace config#7833

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

nolanpro
merged 3 commits into

from

Dec 18, 2024
 Merged


Update readme and add namespace config
#7833
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a63afa7

Update readme and add namespace config


nolanpro Dec 16, 2024
91d8a85

FOUR-21074 Improvements for a better user experience.


gproly Dec 17, 2024
ddbd267

Update prometheus.yml


nolanpro Dec 18, 2024

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


219 changes: 45 additions & 174 deletions
ProcessMaker/Services/MetricsService.php

View file


Open in desktop

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

use Exception;
use Illuminate\Support\Facades\Cache;
use Prometheus\Counter;
use Prometheus\Gauge;
use Prometheus\Histogram;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\Redis;
Expand All@@ -14,7 +16,7 @@ class MetricsService
 /**
 * The CollectorRegistry instance used by the MetricsService.
 *
 * @var \Prometheus\CollectorRegistry
 * @var CollectorRegistry
 */
 private $collectionRegistry;

Expand All@@ -23,20 +25,16 @@ class MetricsService
 *
 * @var string
 */
 private $namespace = 'app';
 private $namespace;

 /**
 * Initializes the MetricsService with a CollectorRegistry using the provided storage adapter.
 * Example:
 * $metricsService = new MetricsService(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ]));
 *
 * @param mixed $adapter The storage adapter to use (e.g., Redis).
 */
 public function __construct($adapter = null)
 {
 $this->namespace = config('app.prometheus_namespace', 'app');
 try {
 // Set up Redis as the adapter if none is provided
 if ($adapter === null) {
Expand All@@ -52,123 +50,66 @@ public function __construct($adapter = null)
 }

 /**
 * Returns the namespace used by the MetricsService.
 * Registers or retrieves a counter metric.
 *
 * @return string The namespace used by the MetricsService.
 */
 public function getNamespace(): string
 {
 return $this->namespace;
 }

 /**
 * Sets the namespace used by the MetricsService.
 *
 * @param string $namespace The namespace to set.
 */
 public function setNamespace(string $namespace): void
 {
 $this->namespace = $namespace;
 }

 /**
 * Sets the CollectorRegistry used by the MetricsService.
 * Example:
 * $metricsService->setRegistry(new CollectorRegistry(new Redis([
 * 'host' => config('database.redis.default.host'),
 * 'port' => config('database.redis.default.port'),
 * ])));
 *
 * @param \Prometheus\CollectorRegistry $collectionRegistry The CollectorRegistry to set.
 */
 public function setRegistry(CollectorRegistry $collectionRegistry): void
 {
 $this->collectionRegistry = $collectionRegistry;
 }

 /**
 * Returns the CollectorRegistry used by the MetricsService.
 *
 * @return \Prometheus\CollectorRegistry The CollectorRegistry used by the MetricsService.
 */
 public function getMetrics(): CollectorRegistry
 {
 return $this->collectionRegistry;
 }

 /**
 * Retrieves a metric by its name. The app_ prefix is added to the name of the metric.
 * Example:
 * $metricsService->getMetricByName('app_http_requests_total');
 *
 * @param string $name The name of the metric to retrieve.
 * @return \Prometheus\MetricFamilySamples|null The metric with the specified name, or null if not found.
 * @param string $name The name of the counter.
 * @param string|null $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return Counter The registered or retrieved counter.
 */
 public function getMetricByName(string $name)
 public function counter(string $name, string $help = null, array $labels = []): Counter
 {
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
foreach ($metrics as $metric) {
if ($metric->getName() === $name) {
return $metric;
}
}
return null;
 $help = $help ?? $name;
return $this->collectionRegistry->getOrRegisterCounter(
 $this->namespace,
$name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new counter metric.
 * Example:
 * $metricsService->registerCounter('app_http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 * Registers or retrieves a gauge metric.
 *
 * @param string $name The name of the counter.
 * @param string $help The help text of the counter.
 * @param array $labels The labels of the counter.
 * @return \Prometheus\Counter The registered counter.
 * @throws \RuntimeException If a metric with the same name already exists.
 * @param string $name The name of the gauge.
 * @param string|null $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return Gauge The registered or retrieved gauge.
 */
 public function registerCounter(string $name, string $help, array $labels = []): \Prometheus\Counter
 public function gauge(string $name, string $help = null, array $labels = []): Gauge
 {
 if ($this->getMetricByName($name) !== null) {
 throw new RuntimeException("A metric with this name already exists. '{$name}'.");
 }
 return $this->collectionRegistry->registerCounter($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterGauge(
 $this->namespace,
 $name,
 $help,
 $labels
 );
 }

 /**
 * Registers a new histogram metric.
 * Example:
 * $metricsService->registerHistogram('app_http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 * Registers or retrieves a histogram metric.
 *
 * @param string $name The name of the histogram.
 * @param string $help The help text of the histogram.
 * @param string|null $help The help text of the histogram.
 * @param array $labels The labels of the histogram.
 * @param array $buckets The buckets of the histogram.
 * @return \Prometheus\Histogram The registered histogram.
 * @return Histogram The registered or retrieved histogram.
 */
 public function registerHistogram(string $name, string $help, array $labels = [], array $buckets = [0.1, 1, 5, 10]): \Prometheus\Histogram
 public function histogram(string $name, string $help = null, array $labels = [], array $buckets = [0.1, 1, 5, 10]): Histogram
 {
 return $this->collectionRegistry->registerHistogram($this->namespace, $name, $help, $labels, $buckets);
 }

 /**
 * Registers a new gauge metric.
 * Example:
 * $metricsService->registerGauge('app_active_jobs', 'Number of active jobs in the queue', ['queue']);
 *
 * @param string $name The name of the gauge.
 * @param string $help The help text of the gauge.
 * @param array $labels The labels of the gauge.
 * @return \Prometheus\Gauge The registered gauge.
 */
 public function registerGauge(string $name, string $help, array $labels = []): \Prometheus\Gauge
 {
 return $this->collectionRegistry->registerGauge($this->namespace, $name, $help, $labels);
 $help = $help ?? $name;
 return $this->collectionRegistry->getOrRegisterHistogram(
 $this->namespace,
 $name,
 $help,
 $labels,
 $buckets
 );
 }

 /**
 * Sets a gauge metric to a specific value.
 * Example:
 * $metricsService->setGauge('app_active_jobs', 10, ['queue1']);
 *
 * @param string $name The name of the gauge.
 * @param float $value The value to set the gauge to.
Expand All@@ -180,85 +121,15 @@ public function setGauge(string $name, float $value, array $labelValues = []): v
 $gauge->set($value, $labelValues);
 }

 /**
 * Increments a counter metric by 1.
 * Example:
 * $metricsService->incrementCounter('app_http_requests_total', ['GET', '/api/v1/users', '200']);
 *
 * @param string $name The name of the counter.
 * @param array $labelValues The values of the labels for the counter.
 * @throws \RuntimeException If the counter could not be incremented.
 */
 public function incrementCounter(string $name, array $labelValues = []): void
 {
 try {
 $counter = $this->collectionRegistry->getCounter($this->namespace, $name);
 $counter->inc($labelValues);
 } catch (Exception $e) {
 throw new RuntimeException("The counter could not be incremented '{$name}': " . $e->getMessage());
 }
 }

 /**
 * Observes a value for a histogram metric.
 * Example:
 * $metricsService->observeHistogram('app_http_request_duration_seconds', 0.3, ['GET', '/api/v1/users']);
 *
 * @param string $name The name of the histogram.
 * @param float $value The value to observe.
 * @param array $labelValues The values of the labels for the histogram.
 */
 public function observeHistogram(string $name, float $value, array $labelValues = []): void
 {
 $histogram = $this->collectionRegistry->getHistogram($this->namespace, $name);
 $histogram->observe($value, $labelValues);
 }

 /**
 * Retrieves or increments a value stored in the cache and sets it to a Prometheus gauge.
 * Example: This is useful to monitor the number of active jobs in the queue.
 * $metricsService->cacheToGauge('app_active_jobs', 'app_active_jobs', 'Number of active jobs in the queue', ['queue'], 1);
 *
 * @param string $key The cache key.
 * @param string $metricName The Prometheus metric name.
 * @param string $help The help text for the gauge.
 * @param array $labels The labels for the gauge.
 * @param float $increment The value to increment.
 */
 public function cacheToGauge(string $key, string $metricName, string $help, array $labels = [], float $increment = 0): void
 {
 // Retrieve and update the cache
 $currentValue = Cache::increment($key, $increment);

 // Register the gauge if it doesn't exist
 if ($this->getMetricByName($metricName) === null) {
 $this->registerGauge($metricName, $help, $labels);
 }

 // Update the gauge with the cached value
 $this->setGauge($metricName, $currentValue, []);
 }

 /**
 * Renders the metrics in the Prometheus text format.
 *
 * @return string The rendered metrics.
 */
 public function renderMetrics()
 public function renderMetrics(): string
 {
 $renderer = new RenderTextFormat();
 $metrics = $this->collectionRegistry->getMetricFamilySamples();
 return $renderer->render($metrics);
 }

 /**
 * Helper to register a default set of metrics for common Laravel use cases.
 */
 public function registerDefaultMetrics(): void
 {
 $this->registerCounter('http_requests_total', 'Total HTTP requests', ['method', 'endpoint', 'status']);
 $this->registerHistogram('http_request_duration_seconds', 'HTTP request duration in seconds', ['method', 'endpoint'], [0.1, 0.5, 1, 5, 10]);
 $this->registerGauge('active_jobs', 'Number of active jobs in the queue', ['queue']);
 $this->registerCounter('job_failures_total', 'Total number of failed jobs', ['queue']);
 }
}
Loading