Zipkin是一款开源的分布式实时数据追踪系统（Distributed Tracking System），由Twitter公司开发和贡献。其主要功能是聚合来自各个异构系统的实时监控数据。在链路追踪Tracing
Analysis中，您可以通过Zipkin上报PHP应用数据。
代码埋点
要通过Zipkin将PHP应用数据上报至链路追踪控制台，首先需要完成埋点工作。
- 安装Zipkin的PHP插件。
composer require openzipkin/zipkin
- 创建Tracer。Tracer对象可以用来创建Span对象（记录分布式操作时间）。Tracer对象还配置了上报数据的网关地址、本机IP、采样频率等数据，您可以通过调整采样率来减少因上报数据产生的开销。
function create_tracing($endpointName, $ipv4)
{
$endpoint = Endpoint::create($endpointName, $ipv4, null, 2555);
/* Do not copy this logger into production.
* Read https://github.com/Seldaek/monolog/blob/master/doc/01-usage.md#log-levels
*/
$logger = new \Monolog\Logger('log');
$logger->pushHandler(new \Monolog\Handler\ErrorLogHandler());
$reporter = new Zipkin\Reporters\Http(\Zipkin\Reporters\Http\CurlFactory::create());
$sampler = BinarySampler::createAsAlwaysSample();
$tracing = TracingBuilder::create()
->havingLocalEndpoint($endpoint)
->havingSampler($sampler)
->havingReporter($reporter)
->build();
return $tracing;
}
- 记录请求数据。
$rootSpan = $tracer->newTrace();
$rootSpan->setName('encode');
$rootSpan->start();
try {
doSomethingExpensive();
} finally {
$rootSpan->finish();
}
说明
以上代码用于记录请求的根操作，如果需要记录请求的上一步和下一步操作，则需要传入上下文。示例：
$span = $tracer->newChild($parentSpan->getContext());
$span->setName('encode');
$span->start();
try {
doSomethingExpensive();
} finally {
$span->finish();
}
- 可选：为了快速排查问题，您可以为某个记录添加一些自定义标签，例如记录是否发生错误、请求的返回值等。
$span->tag('http.status_code', $resultCode);
- 可选：请求上的采样率是由根操作决定的，一般在创建Tracer对象时会创建采样策略，但是您也可以在局部进行替换。例如：
private function newTrace(Request $request) {
$flags = SamplingFlags::createAsEmpty();
if (strpos($request->getUri(), '/experimental') === 0) {
$flags = DefaultSamplingFlags::createAsSampled();
} else if (strpos($request->getUri(), '/static') === 0) {
$flags = DefaultSamplingFlags::createAsSampled();
}
return $tracer->newTrace($flags);
}
- 在分布式系统中发送RPC请求时会带上Tracing数据，包括TraceId、ParentSpanId、SpanId、Sampled等。您可以在HTTP请求中使用Extract/Inject方法在HTTP
Request Headers上透传数据。总体流程如下：
Client Span Server Span
┌──────────────────┐ ┌──────────────────┐
│ │ │ │
│ TraceContext │ Http Request Headers │ TraceContext │
│ ┌──────────────┐ │ ┌───────────────────┐ │ ┌──────────────┐ │
│ │ TraceId │ │ │ X-B3-TraceId │ │ │ TraceId │ │
│ │ │ │ │ │ │ │ │ │
│ │ ParentSpanId │ │ Inject │ X-B3-ParentSpanId │Extract │ │ ParentSpanId │ │
│ │ ├─┼─────────>│ ├────────┼>│ │ │
│ │ SpanId │ │ │ X-B3-SpanId │ │ │ SpanId │ │
│ │ │ │ │ │ │ │ │ │
│ │ Sampled │ │ │ X-B3-Sampled │ │ │ Sampled │ │
│ └──────────────┘ │ └───────────────────┘ │ └──────────────┘ │
│ │ │ │
└──────────────────┘ └──────────────────┘
- 在客户端调用Inject方法传入Context信息。
// configure a function that injects a trace context into a request
$injector = $tracing->getPropagation()->getInjector(new RequestHeaders);
// before a request is sent, add the current span's context to it
$injector->inject($span->getContext(), $request);
- Extract方法解析Context信息。
// configure a function that extracts the trace context from a request
$extracted = $tracing->getPropagation()->extractor(new RequestHeaders);
$span = $tracer->newChild($extracted)
$span->setKind(Kind\SERVER);
快速入门
接下来以Zipkin的官方示例演示如何通过Zipkin上报PHP应用数据。
- 下载示例文件。
- 在functions.php文件中修改上报数据的网关地址，将
$reporter = new Zipkin\Reporters\Http(\Zipkin\Reporters\Http\CurlFactory::create());替换为以下内容：
注意 请将
<endpoint>替换成链路追踪控制台
概览页面上相应客户端和相应地域的接入点。关于获取接入点信息的方法，请参见前提条件中的
获取接入点信息。
reporter = new Zipkin\Reporters\Http(\Zipkin\Reporters\Http\CurlFactory::create(),
['endpoint_url' => '<endpoint>
',]);
- 安装依赖包。
// As of zipkin php is still in 1.0.0-betaX
rm composer.lock && composer install
- 启动服务。
# 在终端1中执行composer run-frontend
# 在终端2中执行composer run-backend
- 访问前端页面上报数据，并在链路追踪控制台查看上报的数据。
curl http://localhost:8081
常见问题
问：为什么按照快速入门的步骤操作没有上报数据？
答：请检查endpoint_url的配置是否正确。
