PHPackages                             instana/instana-php-opentracing - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. instana/instana-php-opentracing

ActiveLibrary[Logging & Monitoring](/categories/logging)

instana/instana-php-opentracing
===============================

Instana Opentracing Client

v2.1.0(6y ago)43845[1 issues](https://github.com/instana/instana-php-opentracing/issues)[1 PRs](https://github.com/instana/instana-php-opentracing/pulls)MITPHPPHP ^7.1CI failing

Since Jul 12Pushed 1mo ago48 watchersCompare

[ Source](https://github.com/instana/instana-php-opentracing)[ Packagist](https://packagist.org/packages/instana/instana-php-opentracing)[ Docs](http://instana.com)[ RSS](/packages/instana-instana-php-opentracing/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (6)Dependencies (4)Versions (8)Used By (0)

Instana OpenTracing for PHP
===========================

[](#instana-opentracing-for-php)

A PHP implementation of the OpenTracing interfaces for usage with Instana.

Requirements
------------

[](#requirements)

Requires an Instana Agent running at the configured InstanaSpanFlusher endpoint. By default, traces will be sent to the PHP sensor's trace acceptor listening on port 16816 on any network interface on the host machine. If no PHP sensor is running on the machine receiving the traces, consider using the alternative REST SDK endpoint. To do so, set the global tracers as follows:

```
use Instana\OpenTracing\InstanaTracer;

\OpenTracing\GlobalTracer::set(InstanaTracer::restSdk());
```

Using the restSdk tracer will send traces to the endpoint in the agent listening on port 42699.

Starting with v2.0.0 the minimum PHP version required is PHP 5.4.
The 1.x branch will only work on PHP 7+.

BC breaks between the 1.x version and the 2.x version
-----------------------------------------------------

[](#bc-breaks-between-the-1x-version-and-the-2x-version)

The methods `InstanaSpanType::entry()`, `InstanaSpanType::local()` and `InstanaSpanType::exit()`have been renamed to `InstanaSpanType::entryType()`, `InstanaSpanType::localType()` and `InstanaSpanType::exitType()` to provide compatibility with PHP < 7. Direct invocations of these methods in your code will need to be renamed.

Installation
------------

[](#installation)

This library is available on Packagist.

```
composer req "instana/instana-php-opentracing:^2.0"
```

You can include it manually in your composer.json like this:

```
{
    "require": {
        "instana/instana-php-opentracing": "^2.0"
    }
}
```

Because OpenTracing v1.0.0 is still in beta, you will also need to set

```
{
    "config": {
        "prefer-stable": true,
        "minimum-stability": "beta",
    }
}
```

Otherwise, Composer will refuse to install the package.

Example usage
-------------

[](#example-usage)

```
use Instana\OpenTracing\InstanaTracer;

\OpenTracing\GlobalTracer::set(InstanaTracer::getDefault());

$parentScope = \OpenTracing\GlobalTracer::get()->startActiveSpan('one');
$parentSpan = $parentScope->getSpan();
$parentSpan->setTag(\Instana\OpenTracing\InstanaTags\SERVICE, "example-service");
$parentSpan->setTag(\OpenTracing\Tags\COMPONENT, 'PHP simple example app');
$parentSpan->setTag(\OpenTracing\Tags\SPAN_KIND, \OpenTracing\Tags\SPAN_KIND_RPC_SERVER);
$parentSpan->setTag(\OpenTracing\Tags\PEER_HOSTNAME, 'localhost');
$parentSpan->setTag(\OpenTracing\Tags\HTTP_URL, '/php/simple/one');
$parentSpan->setTag(\Instana\OpenTracing\InstanaTags\HTTP_PATH_TPL, '/php/simple/{id}');
$parentSpan->setTag(\OpenTracing\Tags\HTTP_METHOD, 'GET');
$parentSpan->setTag(\OpenTracing\Tags\HTTP_STATUS_CODE, 200);
$parentSpan->log(['event' => 'bootstrap', 'type' => 'kernel.load', 'waiter.millis' => 1500]);

$childScope = \OpenTracing\GlobalTracer::get()->startActiveSpan('two');
$childSpan = $childScope->getSpan();
$childSpan->setTag(\OpenTracing\Tags\SPAN_KIND, \OpenTracing\Tags\SPAN_KIND_RPC_CLIENT);
$childSpan->setTag(\OpenTracing\Tags\PEER_HOSTNAME, 'localhost');
$childSpan->setTag(\OpenTracing\Tags\HTTP_URL, '/php/simple/two');
$childSpan->setTag(\OpenTracing\Tags\HTTP_METHOD, 'POST');
$childSpan->setTag(\OpenTracing\Tags\HTTP_STATUS_CODE, 204);

$childScope->close();
$parentScope->close();

\OpenTracing\GlobalTracer::get()->flush();
```

Containerized applications
--------------------------

[](#containerized-applications)

When instrumenting a containerized app, you will need to provide the endpointURI to point to the agent running the container, e.g. for sending traces to the PHP Sensor you instantiate the tracer with

```
use Instana\OpenTracing\InstanaTracer;

InstanaTracer::phpSensor('tcp://172.17.0.1:16816');
```

For sending traces to the REST SDK, you instantiate the tracer with

```
use Instana\OpenTracing\InstanaTracer;

InstanaTracer::restSdk('http://172.17.0.1:42699/com.instana.plugin.generic.trace');
```

Adjust the URI to whatever URI allows communication from the container to the host.

License
-------

[](#license)

This library is licensed under the [MIT License](https://opensource.org/licenses/MIT)

> Copyright 2018 Instana, Inc
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance55

Moderate activity, may be stable

Popularity19

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~72 days

Recently: every ~103 days

Total

7

Last Release

2476d ago

Major Versions

v1.0.4 → v2.0.02018-11-08

PHP version history (2 changes)v1.0.0PHP >=5.4

v2.1.0PHP ^7.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/370948?v=4)[Gordon Oheim](/maintainers/gooh)[@gooh](https://github.com/gooh)

---

Top Contributors

[![gooh](https://avatars.githubusercontent.com/u/370948?v=4)](https://github.com/gooh "gooh (11 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/instana-instana-php-opentracing/health.svg)

```
[![Health](https://phpackages.com/badges/instana-instana-php-opentracing/health.svg)](https://phpackages.com/packages/instana-instana-php-opentracing)
```

###  Alternatives

[jonahgeorge/jaeger-client-php

Jaeger Bindings for PHP OpenTracing API

1484.7M19](/packages/jonahgeorge-jaeger-client-php)[jukylin/jaeger-php

php client for jaeger

2251.6M6](/packages/jukylin-jaeger-php)[jcchavezs/zipkin-opentracing

A Zipkin bridge with OpenTracing

243.0M14](/packages/jcchavezs-zipkin-opentracing)[oat-sa/tao-core

TAO core extension

66140.1k109](/packages/oat-sa-tao-core)[lvht/jaeger

php client for jaeger

1240.6k](/packages/lvht-jaeger)[extraswoft/jaeger

jaeger-sdk for swoft

204.9k](/packages/extraswoft-jaeger)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)