Zipkin OpenTracing PHP

OpenTracingTracer implementation for Zipkin 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 and Brave work, you can look at Zipkin Architecture and Zipkin Api documentation.

Installation

composer require jcchavezs/zipkin-opentracing

Setup

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);
$clientFactory = CurlFactory::create();
$reporter = new Zipkin\Reporters\Http($clientFactory, $logger);
$sampler = BinarySampler::createAsAlwaysSample();
$tracing = TracingBuilder::create()
	->havingLocalEndpoint($endpoint)
   ->havingSampler($sampler)
   ->havingReporter($reporter)
   ->build();

$zipkinTrcer = new ZipkinOpenTracing\Tracer($tracing);

GlobalTracer::set($tracer);