# jaeger-php

**Repository Path**: beatwade/jaeger-php

## Basic Information

- **Project Name**: jaeger-php
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-03
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.com/jukylin/jaeger-php.svg?branch=master)](https://travis-ci.com/jukylin/jaeger-php)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg)](https://php.net/)
[![License](https://img.shields.io/github/license/jukylin/jaeger-php.svg)](https://github.com/jukylin/jaeger-php/blob/master/LICENSE)
[![Coverage Status](https://coveralls.io/repos/github/jukylin/jaeger-php/badge.svg?branch=master)](https://coveralls.io/github/jukylin/jaeger-php?branch=master)

# jaeger-php

## Install

Install via composer.

```
composer config minimum-stability dev
composer require jukylin/jaeger-php
```

## Init Jaeger-php

```php
$config = Config::getInstance();
$tracer = $config->initTracer('example', '0.0.0.0:6831');
```

## 128bit

```php
$config->gen128bit();
```

## Extract from Superglobals

```php
$spanContext = $tracer->extract(Formats\TEXT_MAP, $_SERVER);
```

## Start Span

```php
$serverSpan = $tracer->startSpan('example HTTP', ['child_of' => $spanContext]);
```

## Distributed context propagation
```php
$serverSpan->addBaggageItem("version", "2.0.0");
```

## Inject into Superglobals

```php
$clientTrace->inject($clientSpan1->spanContext, Formats\TEXT_MAP, $_SERVER);
```

## Tags and Log

```php
// tags are searchable in Jaeger UI
$span->setTag('http.status', '200');

// log record
$span->log(['error' => 'HTTP request timeout']);
```

## Close Tracer

```php
$config->setDisabled(true);
```

## Zipkin B3 Propagation

*no support for* `Distributed context propagation`

```php
$config::$propagator = \Jaeger\Constants\PROPAGATOR_ZIPKIN;
```

## Finish span and flush Tracer

```php
$span->finish();
$config->flush();
```

## More example

- [HTTP](https://github.com/jukylin/jaeger-php/blob/master/example/HTTP.php)
- [Hprose](https://github.com/jukylin/blog/blob/master/Uber%E5%88%86%E5%B8%83%E5%BC%8F%E8%BF%BD%E8%B8%AA%E7%B3%BB%E7%BB%9FJaeger%E4%BD%BF%E7%94%A8%E4%BB%8B%E7%BB%8D%E5%92%8C%E6%A1%88%E4%BE%8B%E3%80%90PHP%20%20%20Hprose%20%20%20Go%E3%80%91.md#跨语言调用案例)
- [Istio](https://github.com/jukylin/jaeger-php/blob/master/example/README.md)

## Features

- Transports
    - via Thrift over UDP

- Sampling
    - ConstSampler
    - ProbabilisticSampler

## Reference

[OpenTracing](https://opentracing.io/)

[Jaeger](https://uber.github.io/jaeger/)