使用OpenTelemetry/OpenTracing集成PHP：实现跨服务请求的分布式追踪 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

好的，下面是一篇关于使用 OpenTelemetry/OpenTracing 集成 PHP 以实现跨服务请求的分布式追踪的技术文章，以讲座的形式呈现：

OpenTelemetry/OpenTracing 与 PHP：实现分布式追踪

大家好！今天我们来聊聊如何使用 OpenTelemetry（或者说，曾经的 OpenTracing）集成 PHP，实现跨服务请求的分布式追踪。在微服务架构日益流行的今天，理解和排查跨多个服务的请求变得至关重要。分布式追踪正是解决这个问题的关键技术。

1. 分布式追踪的概念和必要性

首先，我们要明确什么是分布式追踪。简单来说，它是一种监控和诊断分布式系统性能的手段。在单体应用中，请求的调用链通常在一个进程内，我们可以很容易地通过日志或者调试器来追踪。但在微服务架构中，一个用户请求可能会经过多个服务，每个服务可能使用不同的技术栈。追踪这些请求的路径，并分析每个服务的性能瓶颈，就变得非常困难。

分布式追踪通过为每个请求分配一个唯一的 ID，并在请求经过的每个服务中记录相关信息（例如时间戳、服务名、操作名等），最终将这些信息汇集起来，形成一个完整的调用链。我们可以通过可视化工具（例如 Jaeger、Zipkin）来查看这些调用链，从而快速定位问题。

2. OpenTracing 和 OpenTelemetry 的关系

OpenTracing 是一个早期的分布式追踪规范，它定义了一套标准的 API，允许开发者以一种与具体追踪系统无关的方式来编写代码。OpenTelemetry 是 OpenTracing 和 OpenCensus 的合并项目，旨在提供更全面的可观测性解决方案，包括追踪、指标和日志。

虽然 OpenTracing 在历史上很重要，但 OpenTelemetry 现在是更推荐的选择，因为它提供了更广泛的功能和更好的社区支持。OpenTelemetry 兼容 OpenTracing，所以如果你已经使用了 OpenTracing，迁移到 OpenTelemetry 相对容易。

3. OpenTelemetry 的核心概念

OpenTelemetry 的核心概念包括：

Trace: 一个完整的请求调用链，由一个或多个 Span 组成。
Span: 一个独立的、具有时间跨度的操作，例如一个函数调用、一个数据库查询或一个 HTTP 请求。每个 Span 都有一个唯一的 ID，并且可以包含属性（Attributes）、事件（Events）和上下文（Context）。
Context: 在服务之间传递追踪信息的机制，通常包含 Trace ID 和 Span ID。
Attributes: 用于描述 Span 的键值对，例如 HTTP 方法、URL、状态码等。
Events: 用于记录 Span 中发生的特定事件，例如异常或重要的业务逻辑。
Exporters: 用于将追踪数据发送到后端存储系统的组件，例如 Jaeger、Zipkin 或 OpenTelemetry Collector。
Propagators: 用于在服务之间传递 Context 的组件，例如 B3 或 W3C Trace Context。

4. 使用 OpenTelemetry 集成 PHP

接下来，我们来看一个具体的例子，演示如何使用 OpenTelemetry 集成 PHP。

4.1 安装必要的扩展

首先，你需要安装 OpenTelemetry PHP 扩展。你可以通过 PECL 来安装：

pecl install opentelemetry

确保你的 php.ini 文件中启用了该扩展：

extension=opentelemetry.so

如果你的环境不支持 PECL，或者你想使用最新的开发版本，你可以从 GitHub 上克隆 OpenTelemetry PHP SDK，然后手动编译安装。

4.2 配置 OpenTelemetry SDK

安装完扩展后，你需要配置 OpenTelemetry SDK。你需要选择一个 Exporter，将追踪数据发送到后端存储系统。这里我们以 Jaeger 为例。

<?php

use OpenTelemetrySDKTraceTracerProvider;
use OpenTelemetrySDKResourceResourceInfo;
use OpenTelemetrySDKResourceResourceAttributes;
use OpenTelemetryContribOtlpOtlpGrpcTransportFactory;
use OpenTelemetryContribOtlpOtlpExporter;
use OpenTelemetrySDKTraceSpanProcessorSimpleSpanProcessor;
use OpenTelemetryAPICommonAttributes;
use OpenTelemetrySemConvResourceAttributes as SemConvResourceAttributes;

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

// 定义服务名称
$serviceName = 'php-service';

// 创建 Resource
$resource = ResourceInfo::create(
    new Attributes([
        SemConvResourceAttributes::SERVICE_NAME => $serviceName,
        SemConvResourceAttributes::SERVICE_VERSION => '1.0.0',
    ]),
    ResourceInfo::default()
);

// 创建 Exporter
$transport = (new OtlpGrpcTransportFactory())->create('http://localhost:4317'); // 替换为你的 Collector 地址
$exporter = new OtlpExporter($transport);

// 创建 SpanProcessor
$spanProcessor = new SimpleSpanProcessor($exporter);

// 创建 TracerProvider
$tracerProvider = new TracerProvider(
    $spanProcessor,
    $resource
);

// 获取 Tracer
$tracer = $tracerProvider->getTracer('my-app-tracer', '1.0');

// 开始一个 Span
$span = $tracer->startAndActivateSpan('my-span');

// 添加属性
$span->setAttribute('http.method', 'GET');
$span->setAttribute('http.url', '/users');

// 记录事件
$span->addEvent('Processing request');

// 模拟一些业务逻辑
sleep(1);

// 结束 Span
$span->end();

echo "Span created and exported.n";

这段代码做了以下几件事：

定义了服务名称和服务版本。
创建了一个 Resource，用于描述当前服务。
创建了一个 Exporter，将追踪数据发送到 Jaeger Collector。注意，你需要安装并运行 Jaeger Collector。
创建了一个 SpanProcessor，用于处理 Span 的生命周期。
创建了一个 TracerProvider，用于提供 Tracer。
获取一个 Tracer。
开始一个 Span，并添加属性和事件。
模拟一些业务逻辑。
结束 Span。

4.3 跨服务追踪

要实现跨服务追踪，我们需要在服务之间传递 Context。OpenTelemetry 提供了 Propagators 来实现这个功能。

<?php

use OpenTelemetryAPITracePropagationTraceContextPropagator;
use OpenTelemetryContextContext;
use OpenTelemetryAPIGlobals;

// 获取 Propagator
$propagator = TraceContextPropagator::getInstance();

// 从 HTTP Header 中提取 Context
$headers = getallheaders();
$context = $propagator->extract($headers);

// 创建一个新的 Span，并将其链接到提取的 Context
$tracer = Globals::tracerProvider()->getTracer('my-app-tracer');
$span = $tracer->startSpan('downstream-call', ['parent' => $context]);
$scope = $span->activate();

// 将 Context 注入到 HTTP Header 中
$newHeaders = [];
$propagator->inject($newHeaders, Context::getCurrent());

// 发起 HTTP 请求，并将 Header 传递给下游服务
$url = 'http://downstream-service/api/data';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array_map(function ($key, $value) {
    return "$key: $value";
}, array_keys($newHeaders), $newHeaders));
$response = curl_exec($ch);
curl_close($ch);

// 结束 Span
$span->end();
$scope->detach();

这段代码做了以下几件事：

获取一个 Propagator。
从 HTTP Header 中提取 Context。
创建一个新的 Span，并将其链接到提取的 Context。
将 Context 注入到 HTTP Header 中。
发起 HTTP 请求，并将 Header 传递给下游服务。
结束 Span。

在下游服务中，你需要重复这个过程，从 HTTP Header 中提取 Context，并将其链接到新的 Span。

4.4 使用中间件简化集成

手动在每个服务中添加追踪代码可能会很繁琐。为了简化集成，你可以使用中间件。

例如，如果你使用 Laravel 框架，你可以创建一个中间件，自动为每个 HTTP 请求创建一个 Span，并将其链接到提取的 Context。

<?php

namespace AppHttpMiddleware;

use Closure;
use OpenTelemetryAPIGlobals;
use OpenTelemetryAPITracePropagationTraceContextPropagator;
use OpenTelemetryContextContext;

class OpenTelemetryMiddleware
{
    public function handle($request, Closure $next)
    {
        $propagator = TraceContextPropagator::getInstance();
        $headers = $request->headers->all();
        $context = $propagator->extract($headers);

        $tracer = Globals::tracerProvider()->getTracer('laravel-app');
        $span = $tracer->startSpan($request->method() . ' ' . $request->path(), ['parent' => $context]);
        $scope = $span->activate();

        $response = $next($request);

        $span->setAttribute('http.status_code', $response->getStatusCode());
        $span->end();
        $scope->detach();

        return $response;
    }
}

然后，你需要在 app/Http/Kernel.php 文件中注册这个中间件。

5. OpenTelemetry Collector

OpenTelemetry Collector 是一个可选但非常有用的组件。它可以接收来自多个服务的追踪数据，并对其进行处理和导出。Collector 可以执行以下操作：

数据转换: 将不同格式的追踪数据转换为统一的格式。
数据过滤: 过滤掉不必要的追踪数据。
数据聚合: 将多个 Span 合并成一个 Span。
数据导出: 将追踪数据导出到多个后端存储系统。

使用 Collector 可以简化你的架构，并提高可观测性的灵活性。

6. 选择合适的后端存储系统

OpenTelemetry 支持多种后端存储系统，例如 Jaeger、Zipkin、Prometheus、Loki 等。选择合适的后端存储系统取决于你的需求和预算。

Jaeger: 一个开源的分布式追踪系统，易于部署和使用。
Zipkin: 另一个开源的分布式追踪系统，与 Jaeger 类似。
Prometheus: 一个开源的监控系统，主要用于指标收集和告警。
Loki: 一个开源的日志聚合系统，可以与 Grafana 集成，用于可视化日志数据。

7. 总结：追踪请求，洞察性能

通过使用 OpenTelemetry 集成 PHP，你可以轻松地实现跨服务请求的分布式追踪。这可以帮助你理解你的系统的行为，并快速定位性能瓶颈。记住，选择合适的 Exporter 和后端存储系统，以及使用中间件简化集成，是成功实现分布式追踪的关键。

8. 代码示例精简与问题排查

代码示例虽然提供了基础框架，但实际应用中需要根据具体业务逻辑进行调整。例如，对于数据库查询，可以使用 PDO::setAttribute(PDO::ATTR_STATEMENT_CLASS, ['OpenTelemetryContribInstrumentationPDOPDOStatement', [$this->tracer]]); 自动追踪。

排查问题时，首先确认 OpenTelemetry 扩展是否正确安装和启用。检查 Collector 是否正常运行，以及服务是否能够连接到 Collector。查看 Jaeger 或 Zipkin 的 UI，确认是否有追踪数据。如果缺少数据，检查 Span 是否正确创建和结束，以及 Context 是否正确传递。

9. 性能考量与采样策略

分布式追踪会对系统性能产生一定的影响。为了减少性能开销，可以采用采样策略，只追踪一部分请求。OpenTelemetry 提供了多种采样器，例如 AlwaysOnSampler、AlwaysOffSampler 和 TraceIdRatioBasedSampler。你可以根据你的需求选择合适的采样器。

此外，还可以通过优化代码，减少 Span 的数量和属性的大小，来降低性能开销。

10. 未来展望与发展趋势

OpenTelemetry 正在快速发展，未来将提供更多的功能和更好的集成。例如，OpenTelemetry 将支持自动检测和自动注入，进一步简化集成过程。此外，OpenTelemetry 将提供更强大的数据分析和可视化工具，帮助你更好地理解你的系统的行为。

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

OpenTelemetry/OpenTracing 与 PHP：实现分布式追踪

发表回复 取消回复

发表回复取消回复