jcchavezs / zipkin-opentracing
A Zipkin bridge with OpenTracing
Fund package maintenance!
Paypal
Installs: 1 865 171
Dependents: 14
Suggesters: 2
Security: 0
Stars: 23
Watchers: 3
Forks: 21
Open Issues: 2
Requires
- php: >=7.4 || ^8.0
- opentracing/opentracing: ^1.0.1
- openzipkin/zipkin: ^3.0.0
Requires (Dev)
- phpspec/prophecy-phpunit: ^2.0
- phpstan/phpstan: ^0.12.26
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: 3.*
Provides
- opentracing/opentracing: 1.0.0
This package is auto-updated.
Last update: 2024-10-29 05:40:28 UTC
README
Zipkin implementation for OpenTracingTracer in PHP.
This library allows OpenTracing API consumers to use Zipkin as their tracing backend. For details on how to work with spans and traces we suggest looking at the documentation and README from the OpenTracing API.
Getting started
Required Reading
In order to understand OpenTracing API, one must first be familiar with the OpenTracing project and terminology more generally.
To understand how Zipkin works, you can look at Zipkin Architecture and Zipkin PHP documentation.
Installation
composer require jcchavezs/zipkin-opentracing
Usage
Firstly, we need to setup a tracer:
use OpenTracing\GlobalTracer; use Psr\Log\NullLogger; use Zipkin\Endpoint; use Zipkin\Samplers\BinarySampler; use Zipkin\TracingBuilder; use Zipkin\Reporters\Http; $endpoint = Endpoint::create('my_service', '127.0.0.1', null, 8081); $reporter = new Zipkin\Reporters\Http(); $sampler = BinarySampler::createAsAlwaysSample(); $tracing = TracingBuilder::create() ->havingLocalEndpoint($endpoint) ->havingSampler($sampler) ->havingReporter($reporter) ->build(); $zipkinTracer = new ZipkinOpenTracing\Tracer($tracing); GlobalTracer::set($zipkinTracer); // optional
Creating Spans
- Starting a root span
- Starting a span for a given request
- Active span and scope manager
- Using span options
Propagation of context
Flushing Spans to the agent
PHP as a request scoped language has no simple means to pass the collected spans data to a background process without
blocking the main request thread/process. It is mandatory to execute the Tracer::flush()
after the response is served
to the client by using register_shutdown_function
.
use OpenTracing\GlobalTracer; $application->run(); register_shutdown_function(function() { GlobalTracer::get()->flush(); });
Contribution
Run tests
composer test
Fix lint
composer fix-lint