prometheus configurations

Author: yesidevelop

composer.json

@@ -28,7 +28,8 @@
         "maatwebsite/excel": "^3.1",
         "madnest/madzipper": "^1.1",
         "predis/predis": "^1.1",
-        "rusticisoftware/tincan": "@stable"
+        "rusticisoftware/tincan": "@stable",
+        "superbalist/laravel-prometheus-exporter": "^1.0"
     },
     "require-dev": {
         "facade/ignition": "^2.4.2",

config/app.php

@@ -189,6 +189,7 @@
          * Custom Service Providers
          */
         App\Providers\QueueMonitorProvider::class,
+        Superbalist\LaravelPrometheusExporter\PrometheusServiceProvider::class
     ],
 
     /*
@@ -241,6 +242,7 @@
         'Validator' => Illuminate\Support\Facades\Validator::class,
         'View' => Illuminate\Support\Facades\View::class,
         'Excel' => Maatwebsite\Excel\Facades\Excel::class,
+        'Prometheus' => Superbalist\LaravelPrometheusExporter\PrometheusFacade::class
 
     ],
 

config/prometheus.php

@@ -0,0 +1,120 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Namespace
+    |--------------------------------------------------------------------------
+    |
+    | The namespace to use as a prefix for all metrics.
+    |
+    | This will typically be the name of your project, eg: 'search'.
+    |
+    */
+
+    'namespace' => env('PROMETHEUS_NAMESPACE', 'app'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Metrics Route Enabled?
+    |--------------------------------------------------------------------------
+    |
+    | If enabled, a /metrics route will be registered to export prometheus
+    | metrics.
+    |
+    */
+
+    'metrics_route_enabled' => env('PROMETHEUS_METRICS_ROUTE_ENABLED', true),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Metrics Route Path
+    |--------------------------------------------------------------------------
+    |
+    | The path at which prometheus metrics are exported.
+    |
+    | This is only applicable if metrics_route_enabled is set to true.
+    |
+    */
+
+    'metrics_route_path' => env('PROMETHEUS_METRICS_ROUTE_PATH', 'metrics'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Metrics Route Name
+    |--------------------------------------------------------------------------
+    |
+    | Route Parh name aliase.
+    |
+    | This is only applicable if metrics_route_enabled is set to true.
+    |
+    */
+
+    'metrics_route_name' => env('PROMETHEUS_METRICS_ROUTE_NAME', 'metrics'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Metrics Route Middleware
+    |--------------------------------------------------------------------------
+    |
+    | The middleware to assign to the metrics route.
+    |
+    | This can be used to protect the /metrics end-point to authenticated users,
+    | a specific ip address, etc.
+    | You are responsible for writing the middleware and implementing any
+    | business logic needed by your application.
+    |
+    */
+
+    'metrics_route_middleware' => env('PROMETHEUS_METRICS_ROUTE_MIDDLEWARE'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Storage Adapter
+    |--------------------------------------------------------------------------
+    |
+    | The storage adapter to use.
+    |
+    | Supported: "memory", "redis", "apc"
+    |
+    */
+
+    'storage_adapter' => env('PROMETHEUS_STORAGE_ADAPTER', 'memory'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Storage Adapters
+    |--------------------------------------------------------------------------
+    |
+    | The storage adapter configs.
+    |
+    */
+
+    'storage_adapters' => [
+
+        'redis' => [
+            'host' => env('REDIS_HOST', 'localhost'),
+            'port' => env('REDIS_PORT', 6379),
+            'password'=> env('REDIS_PASSWORD', null),
+            'timeout' => 0.1,
+            'read_timeout' => 10,
+            'persistent_connections' => false,
+            'prefix' => env('PROMETHEUS_REDIS_PREFIX', 'PROMETHEUS_'),
+        ],
+
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Collectors
+    |--------------------------------------------------------------------------
+    |
+    | The collectors specified here will be auto-registered in the exporter.
+    |
+    */
+
+    'collectors' => [
+        // \Your\ExporterClass::class,
+    ],
+
+];