Prevent exception from being thrown on 200

.circleci/config.yml

@@ -0,0 +1,103 @@
+unit-config: &unit-config
+  environment:
+    COMPOSER_PREFER_LOWEST: 0
+  steps:
+    - checkout
+
+    - run:
+        name: Install latest composer
+        command: |
+          php -r "copy('https://raw.githubusercontent.com/composer/getcomposer.org/master/web/installer', 'composer-setup.php');"
+          php composer-setup.php
+          php -r "unlink('composer-setup.php');"
+          mv composer.phar /usr/local/bin/composer
+
+    - run:
+        name: Write COMPOSER_PREFER_LOWEST to file
+        command: echo "$COMPOSER_PREFER_LOWEST" > ~/COMPOSER_PREFER_LOWEST.txt
+
+    # Download and cache dependencies
+    - restore_cache:
+        keys:
+        - v1-composer-cache-{{ checksum "~/COMPOSER_PREFER_LOWEST.txt" }}-{{ checksum "composer.json" }}
+        # Fall back to using the latest cache if no exact match is found.
+        - v1-composer-cache-{{ checksum "~/COMPOSER_PREFER_LOWEST.txt" }}
+
+    - run:
+        name: Validate composer files
+        command: composer validate --strict
+
+    - run:
+        name: Install PHP extensions
+        command: |
+            printf '\n' | sudo pecl install redis
+            sudo docker-php-ext-enable redis
+
+    - run:
+        name: Install composer packages
+        command: |
+          if [ $COMPOSER_PREFER_LOWEST -eq "1" ]; then
+            composer update --no-ansi --no-progress --optimize-autoloader --no-interaction --no-plugins --no-scripts --prefer-dist --prefer-stable --prefer-lowest
+          else
+            composer update --no-ansi --no-progress --optimize-autoloader --no-interaction --no-plugins --no-scripts --prefer-dist --prefer-stable
+          fi
+
+    - save_cache:
+        key: v1-composer-cache-{{ checksum "~/COMPOSER_PREFER_LOWEST.txt" }}-{{ checksum "composer.json" }}
+        paths:
+          - ./vendor
+
+    - run:
+        name: Wait for backing services to start
+        command: dockerize -wait tcp://127.0.0.1:6379 -timeout 30s
+
+    - run:
+        name: Run PHP Code Sniffer
+        command: ./vendor/bin/phpcs
+
+    - run:
+        name: Run tests
+        command: ./vendor/bin/phpunit
+
+version: 2.1
+jobs:
+  php74:
+    <<: *unit-config
+    docker:
+      - image: circleci/php:7.4-cli-node
+      - image: circleci/redis:5-alpine
+    environment:
+      COMPOSER_PREFER_LOWEST: 0
+
+  php74-lowest:
+    <<: *unit-config
+    docker:
+      - image: circleci/php:7.4-cli-node
+      - image: circleci/redis:5-alpine
+    environment:
+      COMPOSER_PREFER_LOWEST: 1
+
+  php73:
+    <<: *unit-config
+    docker:
+      - image: circleci/php:7.3-cli-node
+      - image: circleci/redis:5-alpine
+    environment:
+      COMPOSER_PREFER_LOWEST: 0
+
+  php73-lowest:
+    <<: *unit-config
+    docker:
+      - image: circleci/php:7.3-cli-node
+      - image: circleci/redis:5-alpine
+    environment:
+      COMPOSER_PREFER_LOWEST: 1
+
+workflows:
+  version: 2
+  units:
+    jobs:
+      - php74
+      - php74-lowest
+      - php73
+      - php73-lowest

.gitattributes

@@ -0,0 +1,12 @@
+* text=auto
+/.circleci/         export-ignore
+/.github/           export-ignore
+/examples/          export-ignore
+/nginx/             export-ignore
+/php-fpm/           export-ignore
+/tests/             export-ignore
+.gitattributes      export-ignore
+.gitignore          export-ignore
+docker-compose.yml  export-ignore
+phpcs.xml.dist      export-ignore
+phpunit.xml.dist    export-ignore

.gitignore

@@ -2,4 +2,5 @@
 *.iml
 /.idea/
 composer.lock
-composer.phar
+composer.phar
+.phpunit.result.cache

README.md

@@ -1,6 +1,6 @@
 # A prometheus client library written in PHP
 
-[![Build Status](https://travis-ci.org/Jimdo/prometheus_client_php.svg?branch=master)](https://travis-ci.org/Jimdo/prometheus_client_php)
+[![CircleCI](https://circleci.com/gh/endclothing/prometheus_client_php/tree/master.svg?style=shield)](https://circleci.com/gh/endclothing/prometheus_client_php/tree/master)
 
 This library uses Redis or APCu to do the client side aggregation.
 If using Redis, we recommend to run a local Redis instance next to your PHP workers.
@@ -12,6 +12,14 @@ You can pick from three adapters.
 Redis, APC or an in memory adapter.
 While the first needs a separate binary running, the second just needs the [APC](https://pecl.php.net/package/APCU) extension to be installed. If you don't need persistent metrics between requests (e.g. a long running cron job or script) the in memory adapter might be suitable to use.
 
+## Installation
+
+Add as [Composer](https://getcomposer.org/) dependency:
+
+```sh
+composer require endclothing/prometheus_client_php
+```
+
 ## Usage
 
 A simple counter:
@@ -83,13 +91,27 @@ $renderer = new RenderTextFormat();
 $result = $renderer->render($registry->getMetricFamilySamples());
 ```
 
+### Advanced Usage
+
+#### Advanced Histogram Usage
+On passing an empty array for the bucket parameter on instantiation, a set of default buckets will be used instead.
+Whilst this is a good base for a typical web application, there is named constructor to assist in the generation of
+exponential / geometric buckets.
+
+Eg:
+```
+Histogram::exponentialBuckets(0.05, 1.5, 10);
+```
+
+This will start your buckets with a value of 1.5, grow them by a factor of 1.5 per bucket across a set of 10 buckets.
+
 Also look at the [examples](examples).
 
 ## Development
 
 ### Dependencies
 
-* PHP 5.6
+* PHP ^7.3
 * PHP Redis extension
 * PHP APCu extension
 * [Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)

composer.json

@@ -1,36 +1,48 @@
 {
-    "name": "jimdo/prometheus_client_php",
+    "name": "endclothing/prometheus_client_php",
+    "description": "Prometheus instrumentation library for PHP applications.",
+    "type": "library",
+    "license": "Apache-2.0",
     "authors": [
         {
-            "name": "Joscha",
-            "email": "[email protected]"
-        },
-        {
-            "name": "Jan Brauer",
-            "email": "[email protected]"
+            "name": "Daniel Noel-Davies",
+            "email": "[email protected]"
         }
     ],
+    "replace": {
+        "jimdo/prometheus_client_php": "*"
+    },
     "require": {
-        "php": ">=5.6.3",
-        "guzzlehttp/guzzle": "^6.2",
+        "php": "^7.3",
+        "ext-json": "*",
+        "guzzlehttp/guzzle": "^6.3",
         "symfony/polyfill-apcu": "^1.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "4.1.0"
+        "phpunit/phpunit": "^8.4",
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "suggest": {
         "ext-redis": "Required if using Redis.",
         "ext-apc": "Required if using APCu."
     },
     "autoload": {
-        "psr-0": {
-            "Prometheus\\": "src/"
+        "psr-4": {
+            "Prometheus\\": "src/Prometheus/"
         }
     },
     "autoload-dev": {
         "psr-0": {
             "Test\\Prometheus\\": "tests/"
         }
     },
-    "license": "Apache-2.0"
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0-dev"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "prefer-stable": true
 }

examples/flush_adapter.php

@@ -4,14 +4,14 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    define('REDIS_HOST', isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1');
+    define('REDIS_HOST', $_SERVER['REDIS_HOST'] ?? '127.0.0.1');
 
-    $redisAdapter = new Prometheus\Storage\Redis(array('host' => REDIS_HOST));
+    $redisAdapter = new Prometheus\Storage\Redis(['host' => REDIS_HOST]);
     $redisAdapter->flushRedis();
 } elseif ($adapter === 'apc') {
     $apcAdapter = new Prometheus\Storage\APC();
     $apcAdapter->flushAPC();
 } elseif ($adapter === 'in-memory') {
     $inMemoryAdapter = new Prometheus\Storage\InMemory();
     $inMemoryAdapter->flushMemory();
-}
+}

examples/metrics.php

@@ -9,7 +9,7 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

examples/pushgateway.php

@@ -1,13 +1,14 @@
 <?php
 require __DIR__ . '/../vendor/autoload.php';
 
+use Prometheus\PushGateway;
 use Prometheus\Storage\Redis;
 use Prometheus\CollectorRegistry;
 
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();
@@ -20,5 +21,5 @@
 $counter = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']);
 $counter->incBy(6, ['blue']);
 
-$pushGateway = new \Prometheus\PushGateway('192.168.59.100:9091');
-$pushGateway->push($registry, 'my_job', array('instance'=>'foo'));
+$pushGateway = new PushGateway('192.168.59.100:9091');
+$pushGateway->push($registry, 'my_job', ['instance' => 'foo']);

examples/some_counter.php

@@ -8,7 +8,7 @@
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

examples/some_gauge.php

@@ -6,12 +6,12 @@
 use Prometheus\Storage\Redis;
 
 
-error_log('c='. $_GET['c']);
+error_log('c=' . $_GET['c']);
 
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

examples/some_histogram.php

@@ -5,12 +5,12 @@
 use Prometheus\CollectorRegistry;
 use Prometheus\Storage\Redis;
 
-error_log('c='. $_GET['c']);
+error_log('c=' . $_GET['c']);
 
 $adapter = $_GET['adapter'];
 
 if ($adapter === 'redis') {
-    Redis::setDefaultOptions(array('host' => isset($_SERVER['REDIS_HOST']) ? $_SERVER['REDIS_HOST'] : '127.0.0.1'));
+    Redis::setDefaultOptions(['host' => $_SERVER['REDIS_HOST'] ?? '127.0.0.1']);
     $adapter = new Prometheus\Storage\Redis();
 } elseif ($adapter === 'apc') {
     $adapter = new Prometheus\Storage\APC();

phpcs.xml.dist

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<ruleset name="PHP_CodeSniffer">
+    <file>src/</file>
+    <file>tests/</file>
+    <file>examples/</file>
+
+    <exclude-pattern type="relative">vendor/*</exclude-pattern>
+
+    <arg value="nps"/>
+
+    <rule ref="PSR12"/>
+</ruleset>

phpunit.xml.dist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="tests/bootstrap.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnError="false"
+         stopOnFailure="false">
+
+    <testsuites>
+        <testsuite name="Unit">
+            <directory>./tests/Test/Prometheus</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">./src/Prometheus</directory>
+        </whitelist>
+    </filter>
+</phpunit>