openzipkin/zipkin-php là dự án phía máy chủ trên GitHub với 276 sao, viết chủ yếu bằng PHP. Zipkin instrumentation for PHP
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Zipkin PHP is the official PHP Tracer implementation for Zipkin, supported by the OpenZipkin community.
Installation
composer require openzipkin/zipkin
Setup
use Zipkin\Annotation;
use Zipkin\Endpoint;
use Zipkin\Samplers\BinarySampler;
use Zipkin\TracingBuilder;
use Zipkin\Reporters\Http;
// First we create the endpoint that describes our service
$endpoint = Endpoint::create('my_service');
$reporter = new Http(['endpoint_url' => 'http://myzipkin:9411/api/v2/spans']);
$sampler = BinarySampler::createAsAlwaysSample();
$tracing = TracingBuilder::create()
->havingLocalEndpoint($endpoint)
->havingSampler($sampler)
->havingReporter($reporter)
->build();
$tracer = $tracing->getTracer();
...
$tracer->flush();
Obs. for a more complete frontend/backend example, check this repository.
Tracing
The tracer creates and joins spans that model the latency of potentially
distributed work. It can employ sampling to reduce overhead in process
or to reduce the amount of data sent to Zipkin.
Spans returned by a tracer report data to Zipkin when finished, or do
nothing if unsampled. After starting a span, you can annotate events of
interest or add tags containing details or lookup keys.
Spans have a context which includes trace identifiers that place it at
the correct spot in the tree representing the distributed operation.
Local Tracing
When tracing local code, just run it inside a span
In the above example, the span is the root of the trace. In many cases,
you will be a part of an existing trace. When this is the case, call
newChild instead of newTrace
Once you have a span, you can add tags to it, which can be used as lookup
keys or details. For example, you might add a tag with your runtime
version.
$span->tag('http.status_code', '200');
RPC tracing
RPC tracing is often done automatically by interceptors. Under the scenes,
they add tags and events that relate to their role in an RPC operation.
Here's an example of a client span:
// before you send a request, add metadata that describes the operation
$span = $tracer->newTrace();
$span->setName('get');
$span->setKind(Kind\CLIENT);
$span->tag('http.status_code', '200');
$span->tag(Tags\HTTP_PATH, '/api');
$span->setRemoteEndpoint(Endpoint::create('backend', 127 << 24 | 1, null, 8080));
// when the request is scheduled, start the span
$span->start();
// if you have callbacks for when data is on the wire, note those events
$span->annotate(Annotation\WIRE_SEND);
$span->annotate(Annotation\WIRE_RECV);
// when the response is complete, finish the span
$span->finish();
Sampling
Sampling may be employed to reduce the data collected and reported out
of process. When a span isn't sampled, it adds no overhead (noop).
Sampling is an up-front decision, meaning that the decision to report
data is made at the first operation in a trace, and that decision is
propagated downstream.
By default, there's a global sampler that applies a single rate to all
traced operations. Sampler is how you indicate this,
and it defaults to trace every request.
Custom sampling
You may want to apply different policies depending on what the operation
is. For example, you might not want to trace requests to static resources
such as images, or you might want to trace all requests to a new api.
Most users will use a framework interceptor which automates this sort of
policy. Here's how they might work internally.
Propagation is needed to ensure activity originating from the same root
are collected together in the same trace. The most common propagation
approach is to copy a trace context from a client sending an RPC request
to a server receiving it.
For example, when an downstream Http call is made, its trace context is
sent along with it, encoded as request headers:
The names above are from B3 Propagation,
which is built-in to Brave and has implementations in many languages and
frameworks.
Most users will use a framework interceptor which automates propagation.
Here's how they might work internally.
Here's what client-side propagation might look like
// 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($span->getContext(), $request);
Here's what server-side propagation might look like
// configure a function that extracts the trace context from a request
$extractor = $tracing->getPropagation()->getExtractor(new RequestHeaders);
$extracted = $extractor($request);
$span = $tracer->newChild($extracted);
$span->setKind(Kind\SERVER);
If you aren't using a framework or don't have access to the Request object, you
can extract the context from the $_SERVER variable
The Extractor reads trace identifiers and sampling status
from an incoming request or message. The carrier is usually a request object
or headers.
SamplingFlags|TraceContext is usually only used with $tracer->newChild(extracted), unless you are
sharing span IDs between a client and a server.
Implementing Propagation
Extractor will output a SamplingFlags|TraceContext with one of the following:
TraceContext if trace and span IDs were present.
SamplingFlags if no identifiers were present
Current Span
Zipkin supports a "current span" concept which represents the in-flight
operation. Tracer::currentSpan() can be used to add custom tags to a
span and Tracer::nextSpan() can be used to create a child of whatever
is in-flight.
A common use case for the current span is to instrument RPC clients. For example:
/**
* This http clients composes an http client using PSR7
*/
class TraceClient implements ClientInterface
{
public function request($method, $uri = '', array $options = [])
{
/* Gets the child Span of the current one */
$span = $this->tracer->nextSpan();
$span->setKind(Zipkin\Kind\CLIENT);
$span->tag(Tags\HTTP_PATH, $uri);
try {
$response = $this->client->request($method, $uri, $options);
$span->tag(Tags\HTTP_STATUS_CODE, (string) $response->getStatusCode());
return $response;
catch (Throwable $e) {
$span->setError($e);
throw $e;
} finally {
$span->finish();
}
}
}
Setting a span in scope manually
When writing new instrumentation, it is important to place a span you
created in scope as the current span.
In edge cases, you may need to clear the current span temporarily. For
example, launching a task that should not be associated with the current
request. To do this, simply pass null to openScope.
openzipkin/zipkin-php thuộc nhóm Backend trên TopGit, cùng 7 topic GitHub. Trang Trending và Topics liệt kê các repo cùng số sao và cùng ngôn ngữ để so sánh.
Đọc thêm về openzipkin/zipkin-php ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/openzipkin/zipkin-php là nguồn chính thức.
openzipkin/zipkin-php có bao nhiêu sao?
openzipkin/zipkin-php có 276 sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/openzipkin/zipkin-php. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
openzipkin/zipkin-php có phải mã nguồn mở không?
Có — openzipkin/zipkin-php phát hành theo license Apache-2.0, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/openzipkin/zipkin-php.
openzipkin/zipkin-php có website riêng không?
TopGit chưa ghi nhận URL trang chủ cho openzipkin/zipkin-php. Phần README ở tab phía trên thường có link demo, hoặc xem mô tả GitHub của repo.
openzipkin/zipkin-php là gì?
openzipkin/zipkin-php (openzipkin/zipkin-php) là dự án PHP trên GitHub. Theo mô tả gốc: Zipkin instrumentation for PHP
openzipkin/zipkin-php so với các dự án Backend khác thế nào?
openzipkin/zipkin-php được TopGit xếp vào nhóm Backend, với 276 sao GitHub và viết bằng PHP. Xem trang chủ đề Backend trên TopGit để so sánh với các dự án tương tự theo số sao và mức độ hoạt động.
Đọc đầy đủ README ở tab phía trên.
Chưa chắc zipkin-php có hợp với bạn?
Để ChatGPT, Claude hoặc Perplexity tìm hiểu giúp — bấm bên dưới và xem AI nói gì về zipkin-php.