open-telemetry/context-swoole

Async Swoole/OpenSwoole context implementation for OpenTelemetry PHP.

1.0.2 2024-09-17 09:20 UTC

Requires

• php: ^7.4 || ^8.0
• open-telemetry/context: ^1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• nyholm/psr7: *
• open-telemetry/sdk: ^1.0
• phan/phan: ^5.0
• php-http/mock-client: *
• phpstan/phpstan: ^1.1
• phpstan/phpstan-phpunit: ^1.0
• phpunit/phpunit: ^9.5
• psalm/plugin-phpunit: ^0.18.4
• vimeo/psalm: ^5.0

Apache-2.0

• opentelemetry-php contributors

• Context
• contrib
• coroutine
• swoole
• openswoole
• opentelemetry
• otel

README

This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib.

OpenTelemetry Swoole context

简体中文 | ENGLISH

Unlike the PHP-FPM runtime where a single process handles one request at a time, in Swoole, each process handles multiple http requests simultaneously. This library solves the context switching issue when using Opentelemetry in Swoole.

Requirement

• php >= 8.0
• swoole >= 4.5

Installation

Install the package with composer:

composer require open-telemetry/context-swoole

Note: this library needs to be used in conjunction with OpenTelemetry, such as open-telemetry/opentelemetry.

Usage

Quickly start Jaeger based on Docker.

docker run -d --name jaeger \
  -p 16686:16686 \
  -p 4318:4318 \
  -p 4317:4317 \
  jaegertracing/all-in-one

Register TracerProvider and start Swoole http server:

<?php

use OpenTelemetry\API\Globals;
use OpenTelemetry\API\Instrumentation\Configurator;
use OpenTelemetry\API\Trace\SpanKind;
use OpenTelemetry\Context\Context;
use OpenTelemetry\Context\ContextStorage;
use OpenTelemetry\Contrib\Context\Swoole\SwooleContextStorage;
use OpenTelemetry\Contrib\Otlp\OtlpHttpTransportFactory;
use OpenTelemetry\Contrib\Otlp\SpanExporter;
use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
use OpenTelemetry\SDK\Trace\TracerProvider;
use Swoole\Http\Server;

require __DIR__ . '/vendor/autoload.php';

// Create a tracer provider with the exporter and processor
$transport = (new OtlpHttpTransportFactory())->create('http://127.0.0.1:4318/v1/traces', 'application/json');
$exporter = new SpanExporter($transport);
$spanProcessor = new SimpleSpanProcessor($exporter);
$tracerProvider = new TracerProvider($spanProcessor);

// Use Swoole context storage
Context::setStorage(new SwooleContextStorage(new ContextStorage()));

// Register the tracer provider
Globals::registerInitializer(fn(Configurator $configurator) => $configurator->withTracerProvider($tracerProvider));

// Create a Swoole HTTP server, which will start on local port 9501
$http = new Server('127.0.0.1', 9501);

// Http request callback
$http->on('request', function ($request, $response) {
    $tracer = Globals::tracerProvider()->getTracer('io.opentelemetry.contrib.swoole.php');

    try {
        $root = $tracer->spanBuilder($request->server['request_uri'])
            ->setSpanKind(SpanKind::KIND_SERVER)
            ->startSpan();
        $scope = $root->activate();

        for ($i = 0; $i < 3; $i++) {
            // start a span, register some events
            $span = $tracer->spanBuilder('loop-' . $i)->startSpan();

            $span
                ->setAttribute('remote_ip', '1.2.3.4')
                ->setAttribute('country', 'USA');

            $span->addEvent('found_login' . $i, [
                'id' => $i,
                'username' => 'otuser' . $i,
            ]);
            $span->addEvent('generated_session', [
                'id' => md5((string) microtime(true)),
            ]);

            $span->end();
        }
    } finally {
        $root->end();
        $scope->detach();
    }

    $response->header('Content-Type', 'text/plain');
    $response->end('Hello Swoole Context');
});

// Start server
$http->start();

Use the following command to access the test:

curl -i 127.0.0.1:9501/swoole-context-demo

find the trace in Jaeger UI: http://127.0.0.1:16686/ .