done

Author: pavel.chi

.github/workflows/ci.yml

@@ -5,27 +5,27 @@ on:
     branches:
       - master
   pull_request:
-  
+
 env:
   cache_key: cache-v1
 
-jobs:	
+jobs:
   lint:
     runs-on: '${{ matrix.operating_system }}'
-    strategy:	
+    strategy:
       matrix:
         operating_system:
           - ubuntu-20.04
         php_versions:
           - '7.4'
       fail-fast: false
     name: 'Lint'
-    steps:	
+    steps:
       - name: 'Checkout'
         uses: actions/checkout@v2
       - name: 'Setup PHP'
-        uses: shivammathur/setup-php@v2	
-        with:	
+        uses: shivammathur/setup-php@v2
+        with:
           php-version: ${{ matrix.php_versions }}
       - name: 'Install PHP dependencies with Composer'
         run: composer install --prefer-dist --no-progress --no-suggest --optimize-autoloader
@@ -37,7 +37,7 @@ jobs:
       matrix:
         operating_system:
           - ubuntu-20.04
-        php_versions: 
+        php_versions:
           - '7.4'
     runs-on: '${{ matrix.operating_system }}'
     name: 'Test / PHP ${{ matrix.php_versions }}'
@@ -68,7 +68,7 @@ jobs:
         run: ./vendor/bin/php-coveralls --coverage_clover=build/logs/clover.xml -v
   coverage:
     needs: test
-    runs-on:           
+    runs-on:
       - ubuntu-20.04
     name: "Code coverage"
     steps:

.github/workflows/image.yml

@@ -0,0 +1,44 @@
+name: Publish Docker image
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: umbrellio/event-tracker/exporter
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Log in to the Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v2
+        with:
+          context: exporter
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -19,6 +19,7 @@ composer require umbrellio/event-tracker
 - Log anything you want by multipurpose classes - EventRepository and PrometheusRepository
 - Log into influxdb directly or by telegraf
 - Prometheus support
+- Application metrics exporter
 
 ## Known issues
 
@@ -31,6 +32,46 @@ composer require umbrellio/event-tracker
 1. Execute `php artisan vendor:publish` for publishing config example in your `config` directory
 2. Write your credentials and settings in config. If you don't need some connections or trackers you can delete them.
 
+### Prometheus
+
+Each instances of your application must have own storage for your metrics. You cannot use shared storage with several replicas of your application. In that case scraping will return metrics for both the current replica and other replicas.
+
+You could still use shared storage if you have only one fpm replica.
+
+In distributed systems like Kubernetes probably your application is likely running in multiple instances and in different modes (fpm, horizon). Each of them produces metrics and each of them has to be monitored by Prometheus. The exporter provided by this package will solve mentioned above problem. Correct setup should include:
+
+- Each replica has its own (local) redis instance to store metrics
+- Each replica has its own exporter which exposes `/metrics`-endpoint and grabs metrics from the redis instance. The provided exporter is available: ghcr.io/umbrellio/event-tracker/exporter:latest
+- Application writes metrics to that local redis instance
+- `database.php` has separated connection to the local instance
+
+```php
+return [
+    ...
+    'redis' => [
+        ...
+        'metrics' => [
+            'host' => env('REDIS_METRICS_HOST', '127.0.0.1'),
+            'port' => env('REDIS_METRICS_PORT', 6379),
+            'database' => env('REDIS_METRICS_DATABASE', 0),
+        ],
+    ],
+];
+```
+- `event_tracker.php` has the name of this connection
+
+```php
+return [
+    ...
+    'connections' => [
+        ...
+        'prometheus' => [
+            'redis' => 'metrics',
+        ],
+    ],
+];
+```
+
 ## Trackers
 
 ### Response time tracker

config/event_tracker.php

@@ -28,6 +28,7 @@
             ],
         ],
         'prometheus' => [
+            'redis' => 'default',
             'labels' => [
                 'namespace' => 'app_ns',
             ],

exporter/.dockerignore

@@ -0,0 +1,4 @@
+.dockerignore
+Dockerfile
+docker-compose.yml
+vendor/

exporter/.gitignore

@@ -0,0 +1 @@
+/vendor/

exporter/Dockerfile

@@ -0,0 +1,24 @@
+ARG dependency_proxy_prefix="library"
+FROM mlocati/php-extension-installer:2.0.2 AS php-extension-installer
+FROM $dependency_proxy_prefix/php:8.2-alpine
+
+LABEL maintainer="Umbrellio"
+SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
+
+COPY --from=php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
+RUN chmod +x /usr/local/bin/install-php-extensions && \
+    install-php-extensions \
+    redis
+
+RUN curl -sS https://getcomposer.org/installer \
+    | php -- --install-dir=/usr/local/bin --filename=composer \
+
+RUN mkdir exporter
+WORKDIR /exporter
+COPY composer.json composer.lock ./
+RUN composer install --no-dev --prefer-dist --no-interaction --optimize-autoloader --quiet
+
+COPY ./ ./
+
+CMD ["php", "-S", "0.0.0.0:8000", "-t", "public"]
+

exporter/composer.json

@@ -0,0 +1,9 @@
+{
+    "name": "umbrellio/exporter",
+    "type": "project",
+    "require": {
+        "php": ">=8.2",
+        "promphp/prometheus_client_php": "^2.6"
+    },
+    "license": "MIT"
+}

exporter/composer.lock

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+use Prometheus\CollectorRegistry;
+use Prometheus\RenderTextFormat;
+use Prometheus\Storage\Redis as RedisAdapter;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$uri = urldecode(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH));
+
+if ($uri === '/healthcheck') {
+    echo 'ok';
+
+    return;
+}
+
+if ($uri !== '/metrics') {
+    http_response_code(404);
+
+    return;
+}
+
+$config = [
+    'host' => getenv('REDIS_HOST') ?: '127.0.0.1',
+    'port' => getenv('REDIS_PORT') ?: 6379,
+    'password' => getenv('REDIS_PASSWORD') ?: null,
+    'database' => getenv('REDIS_DATABASE') ?: 0,
+];
+
+$adapter = new RedisAdapter($config);
+$registry = new CollectorRegistry($adapter, false);
+$format = new RenderTextFormat();
+$metrics = $registry->getMetricFamilySamples();
+$rendered = $format->render($metrics);
+
+ob_start('ob_gzhandler');
+
+header('Content-Type: ' . RenderTextFormat::MIME_TYPE);
+echo $rendered;
+
+ob_end_flush();