Configure the PHP instrumentation for Splunk Observability Cloud 🔗

The following sections describe all available settings for configuring the SignalFx Tracing Library for PHP.

General settings 🔗

The following settings are specific to the Splunk Distribution of OpenTelemetry Python:

Environment variable	Description
`SIGNALFX_SERVICE_NAME`	Service name in Observability Cloud. The default value is `unnamed-php-service`.
`SIGNALFX_ENDPOINT_URL`	Endpoint URL. The default value is `http://localhost:9080/v1/trace`.
`SIGNALFX_TRACING_ENABLED`	Whether to enable automatic tracer creation and instrumentation. The default value is `true`.
`SIGNALFX_TRACE_CLI_ENABLED`	Whether to enable automatic tracer creation and instrumentation for the `cli` SAPI. See Tracing CLI sessions for more information. The default value is `false`.
`SIGNALFX_TRACE_DEBUG`	Whether to enable debug logging. The default value is `false`.
`SIGNALFX_DISTRIBUTED_TRACING`	Whether to enable B3 context propagation. The default value is `true`.
`SIGNALFX_RECORDED_VALUE_MAX_LENGTH`	Maximum length an attribute value can have. Values longer than this are truncated. The default value is `1200`.
`SIGNALFX_CAPTURE_ENV_VARS`	List of environment variables to attach to the root span, separated by commas.
`SIGNALFX_CAPTURE_REQUEST_HEADERS`	Comma-separated list of incoming request headers to turn into spans. For example, `User-Agent` is captured as `http.request.headers.user_agent`.
`SIGNALFX_ACCESS_TOKEN`	Splunk authentication token that lets the library send data directly to Splunk Observability Cloud. Unset by default. Not required unless you need to send data to the Observability Cloud ingest endpoint. See Send data directly to Observability Cloud for more information.

Tracing CLI sessions 🔗

To trace the CLI SAPI functionality, you have to enable it manually using the SIGNALFX_TRACE_CLI_ENABLED environment variable. When you enable CLI tracing, the instrumentation automatically creates a root span to track the lifetime of your CLI session.

export SIGNALFX_TRACE_CLI_ENABLED=true
php artisan migrate:fresh
php myTracedCliScript.php

Caution

This SAPI is disabled by default to avoid undesired tracing of system activity.

Was this topic useful?

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

Comment should have minimum 5 characters and maximum of 1000 characters.

Feedback submitted, thanks!