Add PostgreSQL support and fix some type hints and docBlock types errors

.github/workflows/blackbox.yml

@@ -29,13 +29,13 @@ jobs:
         run: composer install --prefer-dist --no-interaction --no-suggest
 
       - name: Compose Blackbox environment
-        run: docker-compose up -d
+        run: docker compose up -d
       - name: Run Blackbox with APC
-        run: docker-compose run phpunit env ADAPTER=apc vendor/bin/phpunit tests/Test/
+        run: docker compose run phpunit env ADAPTER=apc vendor/bin/phpunit tests/Test/
       - name: Run Blackbox with APCng
-        run: docker-compose run phpunit env ADAPTER=apcng vendor/bin/phpunit tests/Test/
+        run: docker compose run phpunit env ADAPTER=apcng vendor/bin/phpunit tests/Test/
       - name: Run Blackbox with Redis
-        run: docker-compose run phpunit env ADAPTER=redis vendor/bin/phpunit tests/Test/
+        run: docker compose run phpunit env ADAPTER=redis vendor/bin/phpunit tests/Test/
 
 
 

.github/workflows/tests.yml

@@ -20,6 +20,11 @@ jobs:
       REDIS_HOST: redis
       # The default Redis port
       REDIS_PORT: 6379
+      # MySQL
+      DB_DATABASE: test
+      DB_USER: root
+      DB_PASSWORD: root
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
@@ -40,9 +45,23 @@ jobs:
 
       - name: Install dependencies
         run: composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
+
       - name: Start Redis
         uses: supercharge/[email protected]
         with:
           redis-version: ${{ matrix.redis-version }}
-      - name: Execute tests
+
+      - name: Execute tests (PDO with Sqlite)
         run: vendor/bin/phpunit
+
+      - name: Start MySQL
+        run: |
+          sudo /etc/init.d/mysql start
+          mysql -e "CREATE DATABASE IF NOT EXISTS $DB_DATABASE;" -u$DB_USER -p$DB_PASSWORD
+
+      - name: Execute PDO tests with MySQL
+        env:
+          TEST_PDO_DSN: 'mysql:host=localhost;dbname=test'
+          TEST_PDO_USERNAME: 'root'
+          TEST_PDO_PASSWORD: 'root'
+        run: vendor/bin/phpunit tests/Test/Prometheus/PDO

README.md

@@ -102,6 +102,12 @@ $registry = new CollectorRegistry(new APC());
 ```
 (see the `README.APCng.md` file for more details)
 
+Using the PDO storage:
+```php
+$registry = new CollectorRegistry(new \PDO('mysql:host=localhost;dbname=prometheus', 'username', 'password'));
+ or
+$registry = new CollectorRegistry(new \PDO('sqlite::memory:'));
+```
 
 ### Advanced Usage
 

composer.json

@@ -31,6 +31,7 @@
     "suggest": {
         "ext-redis": "Required if using Redis.",
         "ext-apc": "Required if using APCu.",
+        "ext-pdo": "Required if using PDO.",
         "promphp/prometheus_push_gateway_php": "An easy client for using Prometheus PushGateway.",
         "symfony/polyfill-apcu": "Required if you use APCu on PHP8.0+"
     },

src/Prometheus/CollectorRegistry.php

@@ -95,7 +95,7 @@ public function getMetricFamilySamples(bool $sortMetrics = true): array
      * @return Gauge
      * @throws MetricsRegistrationException
      */
-    public function registerGauge(string $namespace, string $name, string $help, $labels = []): Gauge
+    public function registerGauge(string $namespace, string $name, string $help, array $labels = []): Gauge
     {
         $metricIdentifier = self::metricIdentifier($namespace, $name);
         if (isset($this->gauges[$metricIdentifier])) {
@@ -136,7 +136,7 @@ public function getGauge(string $namespace, string $name): Gauge
      * @return Gauge
      * @throws MetricsRegistrationException
      */
-    public function getOrRegisterGauge(string $namespace, string $name, string $help, $labels = []): Gauge
+    public function getOrRegisterGauge(string $namespace, string $name, string $help, array $labels = []): Gauge
     {
         try {
             $gauge = $this->getGauge($namespace, $name);
@@ -155,7 +155,7 @@ public function getOrRegisterGauge(string $namespace, string $name, string $help
      * @return Counter
      * @throws MetricsRegistrationException
      */
-    public function registerCounter(string $namespace, string $name, string $help, $labels = []): Counter
+    public function registerCounter(string $namespace, string $name, string $help, array $labels = []): Counter
     {
         $metricIdentifier = self::metricIdentifier($namespace, $name);
         if (isset($this->counters[$metricIdentifier])) {
@@ -196,7 +196,7 @@ public function getCounter(string $namespace, string $name): Counter
      * @return Counter
      * @throws MetricsRegistrationException
      */
-    public function getOrRegisterCounter(string $namespace, string $name, string $help, $labels = []): Counter
+    public function getOrRegisterCounter(string $namespace, string $name, string $help, array $labels = []): Counter
     {
         try {
             $counter = $this->getCounter($namespace, $name);
@@ -211,7 +211,7 @@ public function getOrRegisterCounter(string $namespace, string $name, string $he
      * @param string $name e.g. duration_seconds
      * @param string $help e.g. A histogram of the duration in seconds.
      * @param string[] $labels e.g. ['controller', 'action']
-     * @param mixed[]|null $buckets e.g. [100, 200, 300]
+     * @param float[]|null $buckets e.g. [100.0, 200.0, 300.0]
      *
      * @return Histogram
      * @throws MetricsRegistrationException
@@ -221,7 +221,7 @@ public function registerHistogram(
         string $name,
         string $help,
         array $labels = [],
-        array $buckets = null
+        ?array $buckets = null
     ): Histogram {
         $metricIdentifier = self::metricIdentifier($namespace, $name);
         if (isset($this->histograms[$metricIdentifier])) {
@@ -259,7 +259,7 @@ public function getHistogram(string $namespace, string $name): Histogram
      * @param string $name e.g. duration_seconds
      * @param string $help e.g. A histogram of the duration in seconds.
      * @param string[] $labels e.g. ['controller', 'action']
-     * @param float[]|null $buckets e.g. [100, 200, 300]
+     * @param float[]|null $buckets e.g. [100.0, 200.0, 300.0]
      *
      * @return Histogram
      * @throws MetricsRegistrationException
@@ -269,7 +269,7 @@ public function getOrRegisterHistogram(
         string $name,
         string $help,
         array $labels = [],
-        array $buckets = null
+        ?array $buckets = null
     ): Histogram {
         try {
             $histogram = $this->getHistogram($namespace, $name);
@@ -297,7 +297,7 @@ public function registerSummary(
         string $help,
         array $labels = [],
         int $maxAgeSeconds = 600,
-        array $quantiles = null
+        ?array $quantiles = null
     ): Summary {
         $metricIdentifier = self::metricIdentifier($namespace, $name);
         if (isset($this->summaries[$metricIdentifier])) {
@@ -348,7 +348,7 @@ public function getOrRegisterSummary(
         string $help,
         array $labels = [],
         int $maxAgeSeconds = 600,
-        array $quantiles = null
+        ?array $quantiles = null
     ): Summary {
         try {
             $summary = $this->getSummary($namespace, $name);

src/Prometheus/Counter.php

@@ -28,7 +28,7 @@ public function inc(array $labels = []): void
 
     /**
      * @param int|float $count e.g. 2
-     * @param mixed[] $labels e.g. ['status', 'opcode']
+     * @param string[] $labels e.g. ['status', 'opcode']
      */
     public function incBy($count, array $labels = []): void
     {

src/Prometheus/Gauge.php

@@ -11,7 +11,7 @@ class Gauge extends Collector
     const TYPE = 'gauge';
 
     /**
-     * @param double $value e.g. 123
+     * @param float $value e.g. 123.0
      * @param string[] $labels e.g. ['status', 'opcode']
      */
     public function set(float $value, array $labels = []): void

src/Prometheus/Histogram.php

@@ -30,7 +30,7 @@ public function __construct(
         string $name,
         string $help,
         array $labels = [],
-        array $buckets = null
+        ?array $buckets = null
     ) {
         parent::__construct($adapter, $namespace, $name, $help, $labels);
 
@@ -113,7 +113,7 @@ public static function exponentialBuckets(float $start, float $growthFactor, int
     }
 
     /**
-     * @param double $value e.g. 123
+     * @param float $value e.g. 123.0
      * @param string[]  $labels e.g. ['status', 'opcode']
      */
     public function observe(float $value, array $labels = []): void