Skip to content

Commit 1e328ca

Browse files
brettmcbrettmc
authored
build 8.2 (#91)
* httplug async client auto-instrumentation * experimental 8.2 build
1 parent 78d4ed9 commit 1e328ca

File tree

12 files changed

+499
-3
lines changed

12 files changed

+499
-3
lines changed

‎.github/workflows/php.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@ on:
1010
jobs:
1111
php:
1212
runs-on: ubuntu-latest
13-
continue-on-error: true
13+
continue-on-error: false
1414
strategy:
1515
fail-fast: false
1616
matrix:
17-
operating-system: [ubuntu-latest]
18-
php-version: ['7.4', '8.0', '8.1']
17+
php-version: ['7.4', '8.0', '8.1', '8.2']
1918
project: [
2019
'Aws',
2120
'Context/Swoole',
@@ -65,6 +64,7 @@ jobs:
6564

6665
- name: Check Style
6766
working-directory: src/${{ matrix.project }}
67+
continue-on-error: ${{ matrix.php-version == 8.2 }} #temporary, until php-cs-fixer is happy with php8.2
6868
run: vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php -v --dry-run --stop-on-violation --using-cache=no -vvv
6969

7070
- name: Run Phan

‎src/Instrumentation/HttpAsyncClient/.php-cs-fixer.php‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<?php
2+
$finder = PhpCsFixer\Finder::create()
3+
->exclude('vendor')
4+
->exclude('var/cache')
5+
->in(__DIR__);
6+
7+
$config = new PhpCsFixer\Config();
8+
return $config->setRules([
9+
'concat_space' => ['spacing' => 'one'],
10+
'declare_equal_normalize' => ['space' => 'none'],
11+
'is_null' => true,
12+
'modernize_types_casting' => true,
13+
'ordered_imports' => true,
14+
'php_unit_construct' => true,
15+
'single_line_comment_style' => true,
16+
'yoda_style' => false,
17+
'@PSR2' => true,
18+
'array_syntax' => ['syntax' => 'short'],
19+
'blank_line_after_opening_tag' => true,
20+
'blank_line_before_statement' => true,
21+
'cast_spaces' => true,
22+
'declare_strict_types' => true,
23+
'function_typehint_space' => true,
24+
'include' => true,
25+
'lowercase_cast' => true,
26+
'new_with_braces' => true,
27+
'no_extra_blank_lines' => true,
28+
'no_leading_import_slash' => true,
29+
'echo_tag_syntax' => true,
30+
'no_unused_imports' => true,
31+
'no_useless_else' => true,
32+
'no_useless_return' => true,
33+
'phpdoc_order' => true,
34+
'phpdoc_scalar' => true,
35+
'phpdoc_types' => true,
36+
'short_scalar_cast' => true,
37+
'single_blank_line_before_namespace' => true,
38+
'single_quote' => true,
39+
'trailing_comma_in_multiline' => true,
40+
])
41+
->setRiskyAllowed(true)
42+
->setFinder($finder);
43+

‎src/Instrumentation/HttpAsyncClient/README.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# OpenTelemetry HTTPlug async auto-instrumentation
2+
3+
## Requirements
4+
5+
* OpenTelemetry extension
6+
* OpenTelemetry SDK an exporter (required to actually export traces)
7+
* An HTTPlug async client
8+
* (optional) OpenTelemetry [SDK Autoloading](https://github.com/open-telemetry/opentelemetry-php/blob/main/examples/autoload_sdk.php) configured
9+
10+
## Overview
11+
Auto-instrumentation hooks are registered via composer, which will:
12+
13+
* create spans automatically for each async request that is sent
14+
15+
## Manual configuration
16+
If you are not using SDK autoloading, you will need to create and register a `TracerProvider` early in your application's lifecycle:
17+
18+
```php
19+
<?php
20+
require_once 'vendor/autoload.php';
21+
22+
$tracerProvider = /*create tracer provider*/;
23+
$scope = \OpenTelemetry\API\Common\Instrumentation\Configurator::create()
24+
->withTracerProvider($tracerProvider)
25+
->activate();
26+
27+
$client->sendAsyncRequest($request);
28+
29+
$scope->detach();
30+
$tracerProvider->shutdown();
31+
```

‎src/Instrumentation/HttpAsyncClient/_register.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
\OpenTelemetry\Contrib\Instrumentation\HttpAsyncClient\HttpAsyncClientInstrumentation::register();

‎src/Instrumentation/HttpAsyncClient/composer.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"name": "open-telemetry/opentelemetry-auto-http-async",
3+
"description": "OpenTelemetry auto-instrumentation for HTTPlug async clients.",
4+
"keywords": ["opentelemetry", "otel", "open-telemetry", "tracing", "httplug", "async", "instrumentation"],
5+
"type": "library",
6+
"homepage": "https://opentelemetry.io/docs/php",
7+
"readme": "./README.md",
8+
"license": "Apache-2.0",
9+
"minimum-stability": "dev",
10+
"require": {
11+
"php": "^8.0",
12+
"ext-otel_instrumentation": "*",
13+
"open-telemetry/api": "^0",
14+
"php-http/httplug": "^2"
15+
},
16+
"autoload": {
17+
"psr-4": {
18+
"OpenTelemetry\\Contrib\\Instrumentation\\HttpAsyncClient\\": "src/"
19+
},
20+
"files": [
21+
"_register.php"
22+
]
23+
},
24+
"require-dev": {
25+
"friendsofphp/php-cs-fixer": "^3",
26+
"monolog/monolog": "*",
27+
"open-telemetry/exporter-zipkin": "*",
28+
"php-http/guzzle7-adapter": "*",
29+
"nyholm/psr7": "*",
30+
"phan/phan": "^5.0",
31+
"php-http/mock-client": "*",
32+
"phpstan/phpstan": "^1.1",
33+
"phpstan/phpstan-phpunit": "^1.0",
34+
"psalm/plugin-phpunit": "^0.16",
35+
"open-telemetry/sdk": "^0",
36+
"phpunit/phpunit": "^9.5",
37+
"vimeo/psalm": "^4.0"
38+
}
39+
}

‎src/Instrumentation/HttpAsyncClient/examples/async_requests.php‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use GuzzleHttp\Psr7\Request;
6+
use Http\Adapter\Guzzle7\Client;
7+
use Monolog\Handler\StreamHandler;
8+
use Monolog\Logger;
9+
use OpenTelemetry\API\Common\Instrumentation;
10+
use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
11+
use OpenTelemetry\SDK\Common\Export\Stream\StreamTransport;
12+
use OpenTelemetry\SDK\Common\Log\LoggerHolder;
13+
use OpenTelemetry\SDK\Common\Time\ClockFactory;
14+
use OpenTelemetry\SDK\Resource\ResourceInfoFactory;
15+
use OpenTelemetry\SDK\Trace\Sampler\AlwaysOnSampler;
16+
use OpenTelemetry\SDK\Trace\SpanExporter\ConsoleSpanExporter;
17+
use OpenTelemetry\SDK\Trace\SpanProcessor\BatchSpanProcessor;
18+
use OpenTelemetry\SDK\Trace\TracerProvider;
19+
use Psr\Log\LogLevel;
20+
21+
require_once dirname(__DIR__) . '/vendor/autoload.php';
22+
23+
LoggerHolder::set(
24+
new Logger('otel-php', [new StreamHandler(STDOUT, LogLevel::DEBUG)])
25+
);
26+
27+
$transport = new StreamTransport(fopen('php://stdout', 'a'), 'application/json');
28+
$exporter = new ConsoleSpanExporter($transport);
29+
30+
$tracerProvider = new TracerProvider(
31+
new BatchSpanProcessor($exporter, ClockFactory::getDefault()),
32+
new AlwaysOnSampler(),
33+
ResourceInfoFactory::emptyResource(),
34+
);
35+
36+
$scope = Instrumentation\Configurator::create()
37+
->withTracerProvider($tracerProvider)
38+
->withPropagator(TraceContextPropagator::getInstance())
39+
->activate();
40+
41+
$root = $tracerProvider->getTracer('async-requests-demo')->spanBuilder('root')->startSpan();
42+
$rootScope = $root->activate();
43+
44+
try {
45+
$requests = [
46+
new Request('GET', 'https://postman-echo.com/get'),
47+
new Request('POST', 'https://postman-echo.com/post'),
48+
new Request('GET', 'https://httpbin.org/does-not-exist'),
49+
new Request('GET', 'https://httpbin.org/get'),
50+
];
51+
$client = new Client();
52+
$promises = [];
53+
foreach ($requests as $request) {
54+
$promises[] = [$request, $client->sendAsyncRequest($request)];
55+
}
56+
foreach ($promises as [$request, $promise]) {
57+
try {
58+
$response = $promise->wait();
59+
echo sprintf('[%d] ', $response->getStatusCode()) . json_encode(json_decode($response->getBody()->getContents()), JSON_PRETTY_PRINT), PHP_EOL;
60+
} catch (\Exception $e) {
61+
var_dump($e->getMessage());
62+
}
63+
}
64+
65+
$root->end();
66+
} finally {
67+
$rootScope->detach();
68+
$scope->detach();
69+
$tracerProvider->shutdown();
70+
}

‎src/Instrumentation/HttpAsyncClient/phpstan.neon.dist‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
includes:
2+
- vendor/phpstan/phpstan-phpunit/extension.neon
3+
4+
parameters:
5+
tmpDir: var/cache/phpstan
6+
level: 5
7+
paths:
8+
- src
9+
- tests

‎src/Instrumentation/HttpAsyncClient/phpunit.xml.dist‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<phpunit
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
6+
backupGlobals="false"
7+
backupStaticAttributes="false"
8+
cacheResult="false"
9+
colors="false"
10+
convertErrorsToExceptions="true"
11+
convertNoticesToExceptions="true"
12+
convertWarningsToExceptions="true"
13+
forceCoversAnnotation="false"
14+
processIsolation="false"
15+
stopOnError="false"
16+
stopOnFailure="false"
17+
stopOnIncomplete="false"
18+
stopOnSkipped="false"
19+
stopOnRisky="false"
20+
timeoutForSmallTests="1"
21+
timeoutForMediumTests="10"
22+
timeoutForLargeTests="60"
23+
verbose="true">
24+
25+
<coverage processUncoveredFiles="true" disableCodeCoverageIgnore="false">
26+
<include>
27+
<directory>src</directory>
28+
</include>
29+
</coverage>
30+
31+
<php>
32+
<ini name="date.timezone" value="UTC" />
33+
<ini name="display_errors" value="On" />
34+
<ini name="display_startup_errors" value="On" />
35+
<ini name="error_reporting" value="E_ALL" />
36+
</php>
37+
38+
<testsuites>
39+
<testsuite name="unit">
40+
<directory>tests/Unit</directory>
41+
</testsuite>
42+
<testsuite name="integration">
43+
<directory>tests/Integration</directory>
44+
</testsuite>
45+
</testsuites>
46+
47+
</phpunit>

‎src/Instrumentation/HttpAsyncClient/psalm.xml.dist‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?xml version="1.0"?>
2+
<psalm
3+
errorLevel="3"
4+
cacheDirectory="var/cache/psalm"
5+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6+
xmlns="https://getpsalm.org/schema/config"
7+
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd">
8+
<projectFiles>
9+
<directory name="src"/>
10+
<directory name="tests"/>
11+
</projectFiles>
12+
<plugins>
13+
<pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
14+
</plugins>
15+
</psalm>

0 commit comments

Comments
 (0)