Limitations
Known limitations and constraints of OpenTelemetry PHP Distro.
This page describes known limitations and constraints of OpenTelemetry PHP Distro.
Running with another PHP telemetry agent
Do not run OpenTelemetry PHP Distro together with another PHP APM or OpenTelemetry agent in the same process. Running both can cause conflicts, duplicate instrumentation, and unstable behavior.
open_basedir
If open_basedir is enabled in php.ini, the distro installation path must be
included in allowed paths, otherwise the agent may fail to load.
xdebug
Running with xdebug is not recommended in production and may cause stability
or memory issues in instrumented processes.
File-based configuration (OTEL_CONFIG_FILE)
When using file-based (declarative) configuration:
- Remote configuration (OpAMP) is not available — file-based and remote configuration are mutually exclusive.
- Resource detectors registered via
Registry::registerResourceDetector()(for example, cloud provider detectors fromopentelemetry-php-contrib) are not automatically active. They must provide aComponentProviderand be explicitly listed in the YAMLresource.detection/development.detectorssection. - The distro ships a built-in
distrodetector fortelemetry.distro.nameandtelemetry.distro.versionattributes. See Configuration for usage. - Environment variable substitution (
${VAR_NAME}) in YAML files relies on$_SERVERto read values. In web server contexts (Apache, nginx+FPM), process environment variables are not automatically available in$_SERVER. To use${VAR_NAME}substitution in your YAML configuration, ensure the variables are exposed to PHP:- Apache (mod_php): Use
PassEnv VAR_NAMEorSetEnv VAR_NAME valuein your virtual host configuration. - PHP-FPM: Set
env[VAR_NAME] = valuein your FPM pool configuration, or setclear_env = noto pass all process environment variables. - Alternatively, hardcode values directly in the YAML file instead of using
${VAR_NAME}substitution.
- Apache (mod_php): Use
Feedback
Was this page helpful?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!