Merge pull request #1 from tech-djoin/development

Development

Author: Alitindrawan24

.github/workflows/tests.yml

@@ -0,0 +1,48 @@
+name: Tests
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ ubuntu-latest ]
+        php: [ 7.4 ]
+        dependency-version: [ prefer-lowest, prefer-stable ]
+        redis-version: [ 6 ]
+
+    name: P${{ matrix.php }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
+
+    env:
+      # The hostname used to communicate with the Redis service container
+      REDIS_HOST: redis
+      # The default Redis port
+      REDIS_PORT: 6379
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: redis, apcu
+          ini-values: apc.enable_cli='On',apc.shm_size = 256M
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
+      - name: Start Redis
+        uses: supercharge/redis-github-action@1.1.0
+        with:
+          redis-version: ${{ matrix.redis-version }}
+      # - name: Execute tests
+      #   run: ./vendor/bin/pest

config/docker-compose.yml

@@ -0,0 +1,32 @@
+version: '3.8'
+
+services:
+  prometheus:
+    container_name: prometheus
+    image: prom/prometheus:latest
+    ports:
+      - 9090:9090
+    volumes:
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+      - '--storage.tsdb.path=/prometheus'
+      - '--web.console.libraries=/etc/prometheus/console_libraries'
+      - '--web.console.templates=/etc/prometheus/consoles'
+      - '--web.enable-lifecycle'
+    networks:
+      - net-prometheus
+
+  grafana:
+    container_name: grafana
+    image: grafana/grafana:latest
+    ports:
+      - 3000:3000
+    depends_on:
+      - prometheus
+    networks:
+      - net-prometheus
+
+
+networks:
+  net-prometheus:

config/prometheus.yml

@@ -0,0 +1,11 @@
+global:
+  scrape_interval:     15s
+  evaluation_interval: 15s
+
+
+scrape_configs:
+  - job_name: 'job_name'
+    metrics_path: '/metrics'
+    scrape_interval: 5s
+    static_configs:
+      - targets: ['localhost:8080']

src/Middleware/MetricCollector.php

@@ -38,6 +38,9 @@ public function handle(Request $request, Closure $next)
 
         $response = $next($request);
 
+        // Skip metric collect
+        if($this->isBlackListPath($request->route()->uri)) return $next($request);
+
         // Increase the number of http requests by 1 for label uri
         $this->http_request_counter->incBy(1 , [$request->route()->uri]);
 
@@ -48,4 +51,18 @@ private function isEnabled(): bool
     {
         return config('prometheus.enabled');
     }
+
+    private function isBlackListPath($path): bool
+    {
+        $blackList = [
+            'metrics/{secret?}'
+        ];
+
+        foreach ($blackList as $list) {
+            // Pattern matching
+            if(fnmatch($list, $path)) return true;
+        }
+
+        return false;
+    }
 }

src/PrometheusServiceProvider.php

@@ -25,6 +25,12 @@ public function boot()
             $this->publishes([
                 __DIR__.'/../config/prometheus.php' => config_path('prometheus.php'),
             ], 'config');
+            $this->publishes([
+                __DIR__.'/../config/prometheus.yml' => \base_path('prometheus.yml.bak'),
+            ]);
+            $this->publishes([
+                __DIR__.'/../config/docker-compose.yml' => \base_path('docker-compose.yml.bak'),
+            ]);
         }
 
         $this->loadRoutesFrom(__DIR__.'/../routes/web.php');