发布于 由admin

PHP分布式链路追踪（Tracing）：集成Jaeger/Zipkin在协程环境下的Context传递

好的，我们开始。

PHP分布式链路追踪（Tracing）：集成Jaeger/Zipkin在协程环境下的Context传递

大家好，今天我们来聊聊PHP分布式链路追踪，以及如何在协程环境下正确传递Context，尤其是在Jaeger和Zipkin的集成过程中。

1. 什么是分布式链路追踪？

在微服务架构日益普及的今天，一个用户请求往往需要经过多个服务节点的处理才能完成。当出现问题时，我们很难定位瓶颈究竟在哪一个服务上。传统的日志分析方法在面对复杂的调用链时显得力不从心。

分布式链路追踪就是为了解决这个问题而生的。它通过为每一个请求赋予一个唯一的ID，贯穿整个调用链，将各个服务节点上的请求信息串联起来，从而可以清晰地看到请求在每个服务上的耗时、调用关系等信息，帮助我们快速定位性能瓶颈和错误根源。

1.1 链路追踪的核心概念

  • Trace: 一条完整的调用链，代表一个用户请求从发起到结束的整个过程。一个Trace包含多个Span。

  • Span: 调用链中的一个基本单元，代表一个服务节点上的一个操作。Span记录了操作的开始时间、结束时间、操作名称、所属服务、以及一些自定义的Tag和Log。Span之间通过父子关系来表示调用关系。

  • Trace ID: 全局唯一的ID，用于标识一个Trace。整个Trace中的所有Span都共享同一个Trace ID。

  • Span ID: 每一个Span的唯一ID。

  • Parent Span ID: 指向父Span的ID。如果一个Span没有父Span，则Parent Span ID为空。

2. 为什么需要在协程环境下考虑Context传递？

PHP协程的出现，极大地提升了PHP的并发能力。但在协程环境下，Context的传递变得更加复杂。

在传统的同步阻塞模型中，Context通常存储在全局变量、静态变量或者Session中。但在协程环境中，如果简单地使用全局变量或者静态变量来存储Context，会导致数据污染，因为多个协程可能会共享这些变量。

例如，假设我们使用一个全局变量来存储Trace ID。当一个协程A发起了一个请求，并将Trace ID写入全局变量后，如果协程A被挂起，切换到协程B执行，协程B也发起了一个请求，并将新的Trace ID写入全局变量，那么当协程A恢复执行时，它所使用的Trace ID已经被协程B覆盖了，导致链路追踪的数据错误。

因此，在协程环境下，我们需要一种机制来确保每个协程都拥有独立的Context，并且可以在协程之间正确传递Context。

3. Jaeger和Zipkin简介

Jaeger和Zipkin是目前主流的开源分布式链路追踪系统。它们都提供了一套完整的解决方案，包括数据采集、存储、查询和可视化。

3.1 Jaeger

Jaeger由Uber开源，使用Go语言编写。它支持多种数据存储后端，包括Cassandra、Elasticsearch和Kafka。Jaeger的架构相对简单，易于部署和维护。

3.2 Zipkin

Zipkin由Twitter开源，使用Java语言编写。它也支持多种数据存储后端，包括Cassandra、Elasticsearch和MySQL。Zipkin的社区活跃度较高，拥有丰富的扩展和插件。

3.3 Jaeger vs Zipkin:

特性 Jaeger Zipkin
编程语言 Go Java
数据存储 Cassandra, Elasticsearch, Kafka Cassandra, Elasticsearch, MySQL
部署复杂度 较低 较高
扩展性 较好 更好
社区活跃度 较高 很高

选择哪个系统取决于具体的业务需求和技术栈。一般来说，如果对性能要求较高，且希望快速部署，可以选择Jaeger。如果对扩展性要求较高，且希望拥有更多的插件和社区支持，可以选择Zipkin。

4. 在PHP协程环境下集成Jaeger/Zipkin

下面我们将介绍如何在PHP协程环境下集成Jaeger和Zipkin，并解决Context传递的问题。

4.1 使用SwooleCoroutineContext解决Context传递

Swoole提供了一个SwooleCoroutineContext类，用于在协程之间传递数据。SwooleCoroutineContext实际上是一个协程级别的全局变量，每个协程都拥有独立的SwooleCoroutineContext实例。

我们可以使用SwooleCoroutineContext来存储Trace ID、Span ID等Context信息，从而确保每个协程都拥有独立的Context。

4.2 集成Jaeger

首先，我们需要安装Jaeger的PHP客户端。可以使用Composer安装：

composer require jaegertracing/jaeger-client-php

接下来，我们需要创建一个Jaeger的Tracer实例。

<?php

use JaegerConfig;
use OpenTracingGlobalTracer;
use const OpenTracingFormatsTEXT_MAP;

class JaegerTracing
{
    private static $tracer;

    public static function init(string $serviceName, string $agentHostPort = '127.0.0.1:6831'): void
    {
        $config = new Config(
            [
                'sampler' => [
                    'type'  => 'const',
                    'param' => 1,
                ],
                'logging' => true,
            ],
            $serviceName
        );

        self::$tracer = $config->initializeTracer();
        GlobalTracer::set(self::$tracer); // 设置全局Tracer
    }

    public static function startSpan(string $operationName): OpenTracingSpan
    {
        $span = GlobalTracer::get()->startSpan($operationName);
        $context = SwooleCoroutine::getContext();
        $context->span = $span; // 将 Span 存储到协程 Context 中
        return $span;
    }

    public static function finishSpan(): void
    {
        $context = SwooleCoroutine::getContext();
        if (isset($context->span) && $context->span instanceof OpenTracingSpan) {
            $context->span->finish();
            unset($context->span); // 清理 Context
        }
    }

    public static function injectContext(OpenTracingSpan $span, &$carrier): void
    {
        GlobalTracer::get()->inject($span->getContext(), TEXT_MAP, $carrier);
    }

    public static function extractContext(array $carrier): ?OpenTracingSpanContext
    {
        try {
            return GlobalTracer::get()->extract(TEXT_MAP, $carrier);
        } catch (Exception $e) {
            // 处理提取失败的情况，例如记录日志
            return null;
        }
    }

    public static function getTracer()
    {
        return self::$tracer;
    }
}

然后，在你的代码中，可以使用JaegerTracing::startSpan()方法来创建一个Span，使用JaegerTracing::finishSpan()方法来结束一个Span。关键在于将Span存储在SwooleCoroutine::getContext()中。

<?php

use SwooleCoroutine;
use SwooleCoroutineHttpClient;

Coroutine::create(function () {
    JaegerTracing::init('example-service');

    $span = JaegerTracing::startSpan('parent-operation');

    Coroutine::create(function () use ($span) {
        $childSpan = JaegerTracing::startSpan('child-operation');
        $childSpan->log(['message' => 'This is a log message from the child span.']);

        // 模拟HTTP请求
        $cli = new Client('127.0.0.1', 9501);
        $carrier = [];
        JaegerTracing::injectContext($childSpan, $carrier); // 将Context注入到carrier
        $cli->setHeaders($carrier);

        $cli->get('/api/endpoint'); // 模拟请求另一个服务

        $childSpan->log(['response' => $cli->body]);
        JaegerTracing::finishSpan(); // 结束child span
        $cli->close();
    });

    sleep(1); // 模拟一些耗时操作

    JaegerTracing::finishSpan(); // 结束parent span
});

// 模拟 HTTP Server (简化版)
$server = new SwooleHttpServer("127.0.0.1", 9501);
$server->on("Request", function ($request, $response) {
    $carrier = $request->header;
    $spanContext = JaegerTracing::extractContext($carrier);

    // 创建 server span (模拟)
    $serverSpan = JaegerTracing::getTracer()->startSpan('server-endpoint', ['child_of' => $spanContext]); // 重要: 使用 extracted context 作为 parent

    $response->header("Content-Type", "text/plain");
    $response->end("Hello Worldn");
    $serverSpan->finish();

});
$server->start();

在这个例子中，我们首先使用JaegerTracing::init()方法初始化Jaeger的Tracer实例。然后，我们使用JaegerTracing::startSpan()方法创建一个Span，并将其存储到SwooleCoroutine::getContext()中。在协程中发起HTTP请求时，我们使用JaegerTracing::injectContext()方法将Context注入到HTTP Header中，传递给下游服务。下游服务使用JaegerTracing::extractContext()从HTTP Header中提取Context，并创建一个新的Span，作为父Span的子Span。

4.3 集成Zipkin

集成Zipkin的步骤与集成Jaeger类似。首先，我们需要安装Zipkin的PHP客户端。可以使用Composer安装：

composer require openzipkin/zipkin-php

接下来，我们需要创建一个Zipkin的Tracer实例。

<?php

use ZipkinEndpoint;
use ZipkinSamplersBinarySampler;
use ZipkinTracingBuilder;
use OpenTracingGlobalTracer;
use const OpenTracingFormatsTEXT_MAP;

class ZipkinTracing
{
    private static $tracer;

    public static function init(string $serviceName, string $endpointUrl): void
    {
        $endpoint = Endpoint::create($serviceName, inet_pton('127.0.0.1'), 0);
        $sampler = BinarySampler::createAsAlwaysSample();

        $tracer = TracingBuilder::create()
            ->havingLocalEndpoint($endpoint)
            ->havingSampler($sampler)
            ->build();

        self::$tracer = $tracer;
        GlobalTracer::set($tracer); // 设置全局Tracer
    }

    public static function startSpan(string $operationName): OpenTracingSpan
    {
        $span = GlobalTracer::get()->startSpan($operationName);
        $context = SwooleCoroutine::getContext();
        $context->span = $span; // 将 Span 存储到协程 Context 中
        return $span;
    }

    public static function finishSpan(): void
    {
        $context = SwooleCoroutine::getContext();
        if (isset($context->span) && $context->span instanceof OpenTracingSpan) {
            $context->span->finish();
            unset($context->span); // 清理 Context
        }
    }

    public static function injectContext(OpenTracingSpan $span, &$carrier): void
    {
        GlobalTracer::get()->inject($span->getContext(), TEXT_MAP, $carrier);
    }

    public static function extractContext(array $carrier): ?OpenTracingSpanContext
    {
        try {
            return GlobalTracer::get()->extract(TEXT_MAP, $carrier);
        } catch (Exception $e) {
            // 处理提取失败的情况，例如记录日志
            return null;
        }
    }

    public static function getTracer()
    {
        return self::$tracer;
    }
}

然后，在你的代码中，可以使用ZipkinTracing::startSpan()方法来创建一个Span，使用ZipkinTracing::finishSpan()方法来结束一个Span。关键同样在于将Span存储在SwooleCoroutine::getContext()中。

<?php

use SwooleCoroutine;
use SwooleCoroutineHttpClient;

Coroutine::create(function () {
    ZipkinTracing::init('example-service', 'http://localhost:9411/api/v2/spans'); // Zipkin Server URL

    $span = ZipkinTracing::startSpan('parent-operation');

    Coroutine::create(function () use ($span) {
        $childSpan = ZipkinTracing::startSpan('child-operation');
        $childSpan->log(['message' => 'This is a log message from the child span.']);

        // 模拟HTTP请求
        $cli = new Client('127.0.0.1', 9501);
        $carrier = [];
        ZipkinTracing::injectContext($childSpan, $carrier); // 将Context注入到carrier
        $cli->setHeaders($carrier);

        $cli->get('/api/endpoint'); // 模拟请求另一个服务

        $childSpan->log(['response' => $cli->body]);
        ZipkinTracing::finishSpan(); // 结束child span
        $cli->close();
    });

    sleep(1); // 模拟一些耗时操作

    ZipkinTracing::finishSpan(); // 结束parent span
});

// 模拟 HTTP Server (简化版)
$server = new SwooleHttpServer("127.0.0.1", 9501);
$server->on("Request", function ($request, $response) {
    $carrier = $request->header;
    $spanContext = ZipkinTracing::extractContext($carrier);

    // 创建 server span (模拟)
    $serverSpan = ZipkinTracing::getTracer()->startSpan('server-endpoint', ['child_of' => $spanContext]); // 重要: 使用 extracted context 作为 parent

    $response->header("Content-Type", "text/plain");
    $response->end("Hello Worldn");
    $serverSpan->finish();

});
$server->start();

5. 更进一步的思考

  • 采样率： 在生产环境中，为了减少对性能的影响，通常不会对所有的请求进行追踪。可以通过配置采样率来控制追踪的请求比例。Jaeger和Zipkin都支持多种采样策略。

  • Baggage： Baggage是一种在调用链中传递自定义数据的机制。可以使用Baggage来传递用户ID、请求ID等信息。

  • 中间件： 可以使用中间件来自动地创建和结束Span，减少手动编写代码的工作量。例如，可以使用中间件来追踪HTTP请求、数据库查询等操作。

  • 异步任务/消息队列： 当使用异步任务或者消息队列时，也需要考虑Context的传递。可以将Context信息序列化后放入消息中，在消费者端反序列化后恢复Context。

  • 错误处理： 在出现错误时，应该将错误信息记录到Span中，方便排查问题。

代码示例：在Guzzle中使用中间件传递Context

<?php

use GuzzleHttpClient;
use GuzzleHttpHandlerStack;
use OpenTracingGlobalTracer;
use const OpenTracingFormatsTEXT_MAP;

// Guzzle 中间件
$tracingMiddleware = function (callable $handler) {
    return function (PsrHttpMessageRequestInterface $request, array $options) use ($handler) {
        $span = GlobalTracer::get()->startSpan('guzzle-request', ['attributes' => ['http.method' => $request->getMethod(), 'http.url' => (string) $request->getUri()]]);

        $carrier = [];
        GlobalTracer::get()->inject($span->getContext(), TEXT_MAP, $carrier);

        foreach ($carrier as $key => $value) {
            $request = $request->withHeader($key, $value);
        }

        return $handler($request, $options)->then(
            function (PsrHttpMessageResponseInterface $response) use ($span) {
                $span->setAttribute('http.status_code', $response->getStatusCode());
                $span->finish();
                return $response;
            },
            function ($reason) use ($span) {
                $span->log(['error' => $reason]);
                $span->finish();
                throw $reason;
            }
        );
    };
};

$handlerStack = HandlerStack::create();
$handlerStack->push($tracingMiddleware);

$client = new Client(['handler' => $handlerStack]);
try {
    $response = $client->get('http://example.com');
    echo $response->getStatusCode();
} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
}

6. 一些建议

  • 尽早引入链路追踪： 在项目初期就应该考虑引入链路追踪，而不是等到出现问题后再亡羊补牢。

  • 选择合适的链路追踪系统： 根据具体的业务需求和技术栈选择合适的链路追踪系统。

  • 规范化Span的命名： Span的命名应该清晰、简洁、易于理解。

  • 添加有意义的Tag和Log： Tag和Log可以提供更多的上下文信息，帮助我们更好地理解请求的处理过程。

  • 监控链路追踪系统的性能： 链路追踪系统本身也会消耗一定的资源，需要监控其性能，避免对业务系统造成影响。

协程环境下的Context传递是关键

本文重点介绍了在PHP协程环境下集成Jaeger和Zipkin时，如何使用SwooleCoroutineContext来解决Context传递的问题，确保每个协程拥有独立的Context，并可以在协程之间正确传递Context。

链路追踪的实践建议

总结了一些链路追踪的实践建议，包括尽早引入、选择合适的系统、规范Span命名、添加有意义的Tag和Log，以及监控链路追踪系统的性能。

希望今天的分享对大家有所帮助。谢谢！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注