Remove a bit more Boilerplate code

Author: LKaemmerling

.github/workflows/tests.yml

@@ -11,15 +11,9 @@ jobs:
         os: [ ubuntu-latest ]
         php: [ 7.2, 7.3, 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
@@ -34,15 +28,10 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: redis
           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: Run PHP Code Sniffer
         run: ./vendor/bin/phpcs
       - name: Execute tests

README.md

@@ -0,0 +1,50 @@
+# A prometheus push gateway client library written in PHP
+
+![Tests](https://github.com/lkaemmerling/prometheus_push_gateway_php/workflows/Tests/badge.svg)
+
+This package provides an easy PHP API for Prometheus Push Gateway. It was part of https://github.com/LKaemmerling/prometheus_client_php and was moved into a seperate package as of Prometheus Client PHP Version 2.0.0. 
+
+## How does it work?
+
+The PushGateway allows Prometheus to get Metrics from Systems that are not scrableable (Your Prometheus cannot access that systems). With this library you can easily send your metrics to the PushGateway. 
+## Installation
+
+Add as [Composer](https://getcomposer.org/) dependency:
+
+```sh
+composer require lkaemmerling/prometheus_push_gateway_php
+```
+
+## Usage
+
+Let's assume you have that simple counter and want to send it to your PushGateway. 
+```php
+\Prometheus\CollectorRegistry::getDefault()
+    ->getOrRegisterCounter('', 'some_quick_counter', 'just a quick measurement')
+    ->inc();
+
+// Now send it to the PushGateway:
+$pushGateway = new \PrometheusPushGateway\PushGateway('192.168.59.100:9091');
+$pushGateway->push(\Prometheus\CollectorRegistry::getDefault(), 'my_job', ['instance' => 'foo']);
+```
+
+Also look at the [examples](examples).
+
+## Development
+
+### Dependencies
+
+* PHP ^7.2
+* [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)
+
+## Black box testing
+
+Just start the pushgateway by using docker-compose
+```
+docker-compose up
+```
+
+Execute the tests:
+```
+docker-compose run phpunit vendor/bin/phpunit tests/Test/
+```

composer.json

@@ -1,30 +1,31 @@
 {
-    "name": "lkaemmerling/prometheus_push_gateway_php",
-    "description": "Prometheus Push Gatewy client for PHP applications.",
-    "type": "library",
-    "require": {
-        "php": "^7.2",
-        "guzzlehttp/guzzle": "^7.0",
-        "lkaemmerling/prometheus_client_php": "^1.0"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "^9.3"
-    },
-    "license": "Apache-2.0",
-    "authors": [
-        {
-            "name": "Lukas Kämmerling",
-            "email": "kontakt@lukas-kaemmerling.de"
-        }
-    ],
-    "autoload": {
-        "psr-4": {
-            "PrometheusPushGateway\\": "src/PrometheusPushGateway/"
-        }
-    },
-    "autoload-dev": {
-        "psr-0": {
-            "Test\\PrometheusPushGateway\\": "tests/"
-        }
+  "name": "lkaemmerling/prometheus_push_gateway_php",
+  "description": "Prometheus Push Gateway client for PHP applications.",
+  "type": "library",
+  "require": {
+    "php": "^7.2",
+    "guzzlehttp/guzzle": "^7.0",
+    "lkaemmerling/prometheus_client_php": "^1.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^9.3",
+    "squizlabs/php_codesniffer": "^3.5"
+  },
+  "license": "Apache-2.0",
+  "authors": [
+    {
+      "name": "Lukas Kämmerling",
+      "email": "kontakt@lukas-kaemmerling.de"
     }
+  ],
+  "autoload": {
+    "psr-4": {
+      "PrometheusPushGateway\\": "src/PrometheusPushGateway/"
+    }
+  },
+  "autoload-dev": {
+    "psr-0": {
+      "Test\\PrometheusPushGateway\\": "tests/"
+    }
+  }
 }

docker-compose.yml

@@ -1,25 +1,3 @@
-nginx:
-  build: nginx/
-  links:
-    - php-fpm
-  ports:
-    - 8080:80
-
-php-fpm:
-  build: php-fpm/
-  volumes:
-    - .:/var/www/html
-  links:
-    - redis
-    - pushgateway
-  environment:
-    - REDIS_HOST=redis
-
-redis:
-  image: redis
-  ports:
-      - 6379:6379
-
 pushgateway:
   image: prom/pushgateway
   ports:
@@ -30,8 +8,4 @@ phpunit:
   volumes:
     - .:/var/www/html
   links:
-    - redis
     - pushgateway
-    - nginx
-  environment:
-    - REDIS_HOST=redis

examples/pushgateway.php

@@ -3,8 +3,8 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 use Prometheus\CollectorRegistry;
-use Prometheus\PushGateway;
 use Prometheus\Storage\Redis;
+use PrometheusPushGateway\PushGateway;
 
 $adapter = $_GET['adapter'];
 

tests/Test/BlackBoxPushGatewayTest.php

@@ -5,8 +5,8 @@
 use GuzzleHttp\Client;
 use PHPUnit\Framework\TestCase;
 use Prometheus\CollectorRegistry;
-use Prometheus\PushGateway;
-use Prometheus\Storage\APC;
+use Prometheus\Storage\InMemory;
+use PrometheusPushGateway\PushGateway;
 
 class BlackBoxPushGatewayTest extends TestCase
 {
@@ -15,7 +15,7 @@ class BlackBoxPushGatewayTest extends TestCase
      */
     public function pushGatewayShouldWork()
     {
-        $adapter = new APC();
+        $adapter = new InMemory();
         $registry = new CollectorRegistry($adapter);
 
         $counter = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']);

tests/Test/PrometheusPushGateway/PushGatewayTest.php

@@ -9,7 +9,7 @@
 use PHPUnit\Framework\TestCase;
 use Prometheus\CollectorRegistry;
 use Prometheus\MetricFamilySamples;
-use Prometheus\PushGateway;
+use PrometheusPushGateway\PushGateway;
 
 class PushGatewayTest extends TestCase
 {

tests/bootstrap.php

@@ -11,6 +11,6 @@
     exit(1);
 }
 $loader = require $autoload;
-$loader->add('Test\\Prometheus', __DIR__);
+$loader->add('Test\\PrometheusPushGateway', __DIR__);
 
 define('REDIS_HOST', isset($_ENV['REDIS_HOST']) ? $_ENV['REDIS_HOST'] : '127.0.0.1');