This is a client-side library that can be used to instrument PHP apps for distributed trace collection, and to send those traces to Jaeger. See the OpenTracing PHP API for additional detail.
Please see CONTRIBUTING.md.
Jaeger client can be installed via Composer:
composer require jonahgeorge/jaeger-client-php<?php
require_once 'vendor/autoload.php';
use Jaeger\Config;
use OpenTracing\GlobalTracer;
$config = new Config(
[
'sampler' => [
'type' => Jaeger\SAMPLER_TYPE_CONST,
'param' => true,
],
'logging' => true,
],
'your-app-name'
);
$config->initializeTracer();
$tracer = GlobalTracer::get();
$scope = $tracer->startActiveSpan('TestSpan', []);
$scope->close();
$tracer->flush();List of supported samplers, for more info about samplers, please read Jaeger Sampling guide.
This sampler either samples everything, or nothing.
'sampler' => [
'type' => Jaeger\SAMPLER_TYPE_CONST,
'param' => true, // boolean wheter to trace or not
],
This sampler samples request by given rate.
'sampler' => [
'type' => Jaeger\SAMPLER_TYPE_PROBABILISTIC,
'param' => 0.5, // float [0.0, 1.0]
],
Samples maximum specified number of traces (requests) per second.
psr/cachePSR-6 cache component to store and retrieve sampler state between requests. Cache component is passed toJaeger\Configtrough its constructor.hrtime()function, that can retrieve time in nanoseconds. You need eitherphp 7.3or PECL/hrtime extension.
'sampler' => [
'type' => Jaeger\SAMPLER_TYPE_RATE_LIMITING,
'param' => 100 // integer maximum number of traces per second,
'cache' => [
'currentBalanceKey' => 'rate.currentBalance' // string
'lastTickKey' => 'rate.lastTick' // string
]
],
The library supports 3 ways of sending data to Jaeger Agent:
Zipkin.thriftover Compact protocol (socket - UDP) - defaultJaeger.thriftover Binary protocol (socket - UDP)Jaeger.thriftover Binary protocol (HTTP)
If you want to enable "Jaeger.thrift over Binary protocol" one or other, than
you need to set dispatch_mode config option or JAEGER_DISPATCH_MODE env
variable.
Allowed values for dispatch_mode are:
jaeger_over_binary_udpjaeger_over_binary_httpzipkin_over_compact_udp
There are 3 constants available, so it is better to use them:
class Config
{
const ZIPKIN_OVER_COMPACT_UDP = "zipkin_over_compact_udp";
const JAEGER_OVER_BINARY_UDP = "jaeger_over_binary_udp";
const JAEGER_OVER_BINARY_HTTP = "jaeger_over_binary_http";
...
}A possible config with custom dispatch_mode can look like this:
// config.php
use Jaeger\Config;
return [
'sampler' => [
'type' => Jaeger\SAMPLER_TYPE_CONST,
'param' => true,
],
'logging' => true,
"tags" => [
// process. prefix works only with JAEGER_OVER_HTTP, JAEGER_OVER_BINARY
// otherwise it will be shown as simple global tag
"process.process-tag-key-1" => "process-value-1", // all tags with `process.` prefix goes to process section
"process.process-tag-key-2" => "process-value-2", // all tags with `process.` prefix goes to process section
"global-tag-key-1" => "global-tag-value-1", // this tag will be appended to all spans
"global-tag-key-2" => "global-tag-value-2", // this tag will be appended to all spans
],
"local_agent" => [
"reporting_host" => "localhost",
// You can override port by setting local_agent.reporting_port value
"reporting_port" => 6832
],
// Different ways to send data to Jaeger. Config::ZIPKIN_OVER_COMPACT - default):
'dispatch_mode' => Config::JAEGER_OVER_BINARY_UDP,
];The full example you can see at examples directory.
By default, for each dispatch_mode there is default reporting_port config value. Table with
default values you can see below:
dispatch_mode |
default reporting_port |
|---|---|
| ZIPKIN_OVER_COMPACT_UDP | 5775 |
| JAEGER_OVER_BINARY_UDP | 6832 |
| JAEGER_OVER_BINARY_HTTP | 14268 |
In case you need IPv6 support you need to set ip_version Config variable.
By default, IPv4 is used. There is an alias Config::IP_VERSION which you can use
as an alternative to raw ip_version.
Example:
use Jaeger\Config;
$config = new Config(
[
"ip_version" => Config::IPV6, // <-- or use Config::IP_VERSION constant
'logging' => true,
'dispatch_mode' => Config::JAEGER_OVER_BINARY_UDP,
],
'serviceNameExample',
);
$config->initializeTracer();or
use Jaeger\Config;
$config = new Config(
[
Config::IP_VERSION => Config::IPV6, // <--
'logging' => true,
'dispatch_mode' => Config::JAEGER_OVER_BINARY_UDP,
],
'serviceNameExample',
);
$config->initializeTracer();Tests are located in the tests directory. See tests/README.md.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent