chore!: update opentracing/opentracing to 1.0.1

.github/workflows/lint.yaml

@@ -0,0 +1,42 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        php:
+          - '7.3'
+          - '7.4'
+          - '8.0'
+        dependency-version: [prefer-stable]
+    name: ${{ matrix.php }} - ${{ matrix.dependency-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-laravel-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+
+      - name: Install dependencies
+        run: |
+          composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+
+      - name: Execute PHPStan
+        run: composer run-script phpstan
+
+      - name: PHP CS Fixer Check
+        run: composer run-script phpcs-check

.github/workflows/test.yaml

@@ -0,0 +1,39 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        php:
+          - '7.3'
+          - '7.4'
+          - '8.0'
+        dependency-version: [prefer-stable]
+    name: ${{ matrix.php }} - ${{ matrix.dependency-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-laravel-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+
+      - name: Install dependencies
+        run: |
+          composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: composer run-script test

.gitignore

@@ -1,7 +1,9 @@
 .settings/
 .buildpath
+.php-version
 .project
 .idea
+.php-cs-fixer.cache
 composer.lock
 vendor/*
 build

.php-cs-fixer.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('vendor')
+    ->exclude('src/Jaeger/Thrift')
+    ->in(__DIR__);
+
+$config = new PhpCsFixer\Config();
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+    ])
+    ->setFinder($finder);

README.md

@@ -1,103 +1,76 @@
-[![Build Status](https://travis-ci.com/jukylin/jaeger-php.svg?branch=master)](https://travis-ci.com/jukylin/jaeger-php)
-[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg)](https://php.net/)
-[![License](https://img.shields.io/github/license/jukylin/jaeger-php.svg)](https://github.com/jukylin/jaeger-php/blob/master/LICENSE)
-[![Coverage Status](https://coveralls.io/repos/github/jukylin/jaeger-php/badge.svg?branch=master)](https://coveralls.io/github/jukylin/jaeger-php?branch=master)
-
 # jaeger-php
 
-## Install
-
-Install via composer.
+[![Tests](https://github.com/auxmoney/jaeger-php/actions/workflows/test.yaml/badge.svg)](https://github.com/auxmoney/jaeger-php/actions/workflows/test.yaml)
+[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg)](https://php.net/)
+[![License](https://img.shields.io/github/license/auxmoney/jaeger-php.svg)](https://github.com/auxmoney/jaeger-php/blob/master/LICENSE)
+[![Coverage Status](https://coveralls.io/repos/github/auxmoney/jaeger-php/badge.svg?branch=master)](https://coveralls.io/github/auxmoney/jaeger-php?branch=master)
 
-```
-composer config minimum-stability dev
-composer require jukylin/jaeger-php
-```
+_ATTENTION: this is a fork and republication of [jukylin/jaeger-php](https://github.com/jukylin/jaeger-php)_
 
-## Init Jaeger-php
+_We opted into forking and publishing the original library in order to maintain our set of 
+[opentracing related symfony bundles](https://github.com/auxmoney?q=opentracingbundle). The original library seems to be unmaintained 
+currently._
 
-```php
-$config = Config::getInstance();
-$tracer = $config->initTracer('example', '0.0.0.0:6831');
-```
+jaeger-php is a library implementing the [OpenTracing specification for PHP](https://github.com/opentracing/opentracing-php) to 
+connect with the [Jaeger Distributed Tracing Platform](https://github.com/jaegertracing/jaeger). It can be used to instrument PHP
+code to generate tracing data and send it to Jaeger.
 
-## 128bit
+## Installation
 
-```php
-$config->gen128bit();
 ```
-
-## Extract from Superglobals
-
-```php
-$spanContext = $tracer->extract(Formats\TEXT_MAP, $_SERVER);
+composer require auxmoney/jaeger-php
 ```
 
-## Start Span
+## Usage
 
-```php
-$serverSpan = $tracer->startSpan('example HTTP', ['child_of' => $spanContext]);
-```
+First, you need to create a `Config` object, which serves as the factory to create your `Tracer`:
 
-## Distributed context propagation
 ```php
-$serverSpan->addBaggageItem("version", "2.0.0");
+// create a config instance
+$config = \Jaeger\Config::getInstance();
+// create a tracer
+$tracer = $config->initTracer('example service name', '0.0.0.0:6831');
 ```
 
-## Inject into Superglobals
-
+To make the distributed tracing work, you need to extract your `SpanContext` from somewhere, e.g. `$_SERVER`:
 ```php
-$clientTrace->inject($clientSpan1->spanContext, Formats\TEXT_MAP, $_SERVER);
+$spanContext = $tracer->extract(\Opentracing\Formats\TEXT_MAP, $_SERVER);
 ```
 
-## Tags and Log
-
+You can then start tracing by using the common Opentracing interface:
 ```php
-// tags are searchable in Jaeger UI
-$span->setTag('http.status', '200');
-
-// log record
-$span->log(['error' => 'HTTP request timeout']);
+$tracer->startActiveSpan("example operation name", ['child_of' => $spanContext]);
 ```
 
-## Close Tracer
-
+To add metadata to your span, you need to retrieve it first (be sure to check the [semantic conventions](https://opentracing.io/specification/conventions/) first):
 ```php
-$config->setDisabled(true);
+$span = $tracer->getActiveSpan();
+$span->addBaggageItem("user_id", "12345");
+$span->setTag("http.url", "http://localhost");
+$span->log(["message" => "responded successfully"]);
+$span->finish();
 ```
 
-## Zipkin B3 Propagation
-
-*no support for* `Distributed context propagation`
-
+Finally, at the end of your script, you should flush the original `Config`. This will flush all created `Tracer`s and all created `Span`s:
 ```php
-$config::$propagator = \Jaeger\Constants\PROPAGATOR_ZIPKIN;
+$config->flush();
 ```
 
-## Finish span and flush Tracer
+### optional configuration
 
 ```php
-$span->finish();
-$config->flush();
+// optional: generate 128 bit trace ids (default: false)
+$config->gen128bit();
+// optional: disable tracing (default: false)
+$config->setDisabled(true);
+// optional: inject custom transport (default: TransportUdp)
+$config->setTransport($transport);
+// optional: inject custom reporter (default: RemoteReporter)
+$config->setReporter($reporter);
+// optional: inject custom sampler (default: ConstSampler)
+$config->setSampler($sampler);
 ```
 
-## More example
-
-- [HTTP](https://github.com/jukylin/jaeger-php/blob/master/example/HTTP.php)
-- [Hprose](https://github.com/jukylin/blog/blob/master/Uber%E5%88%86%E5%B8%83%E5%BC%8F%E8%BF%BD%E8%B8%AA%E7%B3%BB%E7%BB%9FJaeger%E4%BD%BF%E7%94%A8%E4%BB%8B%E7%BB%8D%E5%92%8C%E6%A1%88%E4%BE%8B%E3%80%90PHP%20%20%20Hprose%20%20%20Go%E3%80%91.md#跨语言调用案例)
-- [Istio](https://github.com/jukylin/jaeger-php/blob/master/example/README.md)
-
-## Features
-
-- Transports
-    - via Thrift over UDP
-
-- Sampling
-    - ConstSampler
-    - ProbabilisticSampler
-
-## Reference
-
-[OpenTracing](https://opentracing.io/)
+## Special thanks
 
-[Jaeger](https://uber.github.io/jaeger/)
+Thank you @jukylin for creating this library!

composer.json

@@ -1,33 +1,53 @@
 {
-  "name":              "jukylin/jaeger-php",
-  "description":       "php client for jaeger",
-  "keywords":          ["jaeger","trace","opentracing"],
-  "license":           "Apache-2.0",
+  "name": "auxmoney/jaeger-php",
+  "description": "php client for jaeger",
+  "keywords": [
+    "jaeger",
+    "trace",
+    "opentracing"
+  ],
+  "license": "Apache-2.0",
   "minimum-stability": "stable",
-  "require":           {
-    "php": ">=5.6.0",
-    "packaged/thrift" : "0.10.0",
-    "opentracing/opentracing" : "1.0.0-beta5"
+  "require": {
+    "php": ">=7.1",
+    "ext-json": "*",
+    "packaged/thrift": "~0.13.0",
+    "opentracing/opentracing": "^1.0.1"
   },
   "authors": [
     {
       "name": "jukylin",
       "email": "[email protected]"
+    },
+    {
+      "name": "auxmoney GmbH",
+      "email": "[email protected]"
     }
   ],
-  "autoload":          {
+  "autoload": {
     "psr-4": {
       "Jaeger\\": "src\\Jaeger"
     },
     "files": [
       "src/Jaeger/Constants.php"
     ]
   },
+  "autoload-dev": {
+    "psr-4": {
+      "tests\\": "tests\\"
+    }
+  },
   "scripts": {
-    "test": "./vendor/bin/phpunit"
+    "test": "phpdbg -qrr vendor/bin/phpunit",
+    "phpcs": "vendor/bin/php-cs-fixer fix --ansi",
+    "phpcs-check": "vendor/bin/php-cs-fixer fix --dry-run --diff 1>&2",
+    "phpstan": "vendor/bin/phpstan analyse src tests"
   },
   "require-dev": {
-    "phpunit/phpunit": "^5",
-    "php-coveralls/php-coveralls": "^1.0"
+    "roave/security-advisories": "dev-latest",
+    "phpunit/phpunit": "^8.5",
+    "php-coveralls/php-coveralls": "^v2.4",
+    "phpstan/phpstan": "^0.12",
+    "friendsofphp/php-cs-fixer": "^v3.1"
   }
 }