Documentation forSolarWinds Observability

Add a PHP service

The PHP Library provides automatic tracing and metrics for PHP applications without additional code modification. For new features, fixed issues, and updated components, see the PHP Library Release Notes.

Get started

Ensure that your application components are supported and the platform for your APM library is supported. Also, verify your firewall configuration permits TCP/HTTPS/TLS outbound connections to (where xx-yy is determined by the URL you use to access SolarWinds Observability, see Endpoint URIs) using port 443. See Firewall or access control requirements.

Remove other APM libraries from your PHP installation before using the SolarWinds Observability PHP Library. See Can I have more than one APM extension installed?.

The SolarWinds Observability PHP Library is a PHP extension called solarwinds-apm. The PHP Library instruments applications based on the PHP language, covering a variety of popular frameworks and libraries. See Components supported by the PHP Library.

To enable instrumentation for a PHP application and send the data to SolarWinds Observability:

  1. In SolarWinds Observability, click Add Data in the upper-right corner.

  2. In the Add Data dialog, click Services.

  3. Type a Name for your service and select the PHP language.

  4. Create or select an API Ingestion token to use when sending your collected Entity type data by doing either of the following:

    • Select Generate New Token and enter an Ingestion Token Name, then click Next.
    • Select Use Existing Token and select an ingestion token from the list, then click Next.
  5. Download and install the PHP Library on the host system and configure the Service key and correct ingestion endpoint during installation. Use the Service key shown in the Add Data dialog.

  6. Restart your web server of PHP process to load the library and start reporting data to the SolarWinds APM collector

  7. When the PHP Library successfully connects to the SolarWinds APM collector, the Waiting for Connection button in SolarWinds Observability changes to OK.

  8. Click OK to finish setting up the service.

To tailor the installed library to your monitoring needs, see Configure the PHP Library.

Custom instrumentation

Custom instrumentation can be used to get extra application-specific visibility, adding both custom spans for distributed tracing and custom timers/counters for metric reporting and alerting. Check out the SDK.