signalfx/signalfx-tracing

PHP APM Client

dev-main 2024-02-27 14:50 UTC

Requires

• php: ^5.4 || ^7.0 || ^8.0.0
• ext-curl: *
• ext-json: *

Requires (Dev)

• ext-posix: *
• g1a/composer-test-scenarios: ~3.0
• mockery/mockery: *
• phpunit/phpunit: <10
• squizlabs/php_codesniffer: ^3.3.0
• symfony/process: <5

BSD-3-Clause

• José Carlos Chávez
• DataDog

• php
• DataDog
• tracing

README

Important

The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the date, the library will be archived and no longer maintained.

New customers should use the OpenTelemetry PHP instrumentation, which offers similar capabilities. Existing customers should consider migrating to OpenTelemetry PHP instrumentation which offers similar capabilities. To learn how to migrate, see the migration guide. To learn how to use OpenTelmetry PHP instrumentation refer to the Splunk documentation.

SignalFx Tracing Library for PHP

This library provides an OpenTracing-compatible tracer and automatically configurable instrumentations for many popular PHP libraries and frameworks. It is a native extension that supports PHP versions 7.0+ running on the Zend Engine.

The SignalFx Tracing Library for PHP is in beta.

Get started

For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry JS, see Instrument PHP applications for Splunk Observability Cloud in the official documentation.

Supported Libraries and Frameworks

These are the PHP libraries and frameworks you can instrument. All italicized libraries are in beta.

If your web framework isn't supported, the instrumentation creates a span for any fielded request using the $_SERVER execution environment.

Library	Versions supported
CakePHP	2.x
Curl	All supported PHP versions
ElasticSearch	1.x
Eloquent	All supported Laravel versions
Guzzle	5.0+
Laravel	4.2, 5.0+
Lumen	5.2-5.8
Memcached	All supported PHP versions
MongoDB	1.4
MySQLi	All supported PHP versions
PDO	All supported PHP versions
Predis	1.1
Slim	3.x
Symfony	3.3, 3.4, 4.x, 5.x
Zend	1.12

About

This library is a fork of the DataDog Tracing PHP Client that has been modifed to provide Zipkin v2 JSON formatting, B3 trace propagation functionality, and properly annotated trace data for handling by SignalFx Microservices APM. It is released under the terms of the BSD 3-Clause license. See the license file for more details.