Docs » Available host and application monitors » Configure application receivers for hosts and servers » Collectd PHP FPM

Collectd PHP FPM 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the collectd/php-fpm monitor type by using the SignalFx Smart Agent Receiver.

Use this integration to monitor PHP-FastCGI Process Manager (FPM) using the pool status URL.

This monitor is available on Linux.

Requirements 🔗

To configure the PHP-FPM service itself to expose status metrics, follow these steps:

  1. Enable the status path. See the PHP documentation for more information.

  2. Configure access through the web server. The following example shows how to configure access for NGINX:

     location ~ ^/(status|ping)$ {
       access_log off;
       fastcgi_pass unix:/run/php/php-fpm.sock;
       include fastcgi_params;
       fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
     }
    
  3. Restart both the web server and PHP-FPM.

Make sure that the URL you provide to reach the FPM status page through your web server ends in ?json. This returns the metrics as json, which this plugin requires.

Benefits 🔗

After you configure the integration, you can access these features:

  • View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.

  • View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.

  • Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which you’ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

receivers:
  smartagent/ collectd/php-fpm:
    type: collectd/php-fpm
    ... # Additional config

To complete the integration, include the Smart Agent receiver using this monitor in a metrics pipeline. To do this, add the receiver to the service > pipelines > metrics > receivers section of your configuration file.

service:
  pipelines:
    metrics:
      receivers: [smartagent/collectd/php-fpm]

Configuration settings 🔗

The following table shows the configuration options for the collectd/php-fpm receiver:

Option

Required

Type

Description

host

no

string

The host name of the web server. For example, 127.0.0.1.

port

no

integer

The port number of the web server. For example, 80. The default value is 0.

useHTTPS

no

bool

Whether the monitor connects to Supervisor via HTTPS instead of HTTP. The default value is false.

path

no

string

The scrape URL for Supervisor. The default value is /status.

url

no

string

URL or Go template that to be populated with the host, port, and path values.

name

no

string

The plugin_instance dimension. It can take any value.

Configuration examples 🔗

The following example shows how to configure the host and port for the monitor:

monitors:
 - type: collectd/php-fpm
   host: localhost
   port: 80

If the FPM status page is exposed on an endpoint other than /status, use the path config option as in the following example:

monitors:
 - type: collectd/php-fpm
   host: localhost
   port: 80
   path: "/status"

You can also define the entire URL yourself using the url config option. In that case, the useHTTPS setting is ignored.

monitors:
 - type: collectd/php-fpm
   host: localhost
   port: 80
   useHTTPS: true # will be ignored
   url: "http://{{.host}}:{{.port}}/fpm-status?json"

Metrics 🔗

The following metrics are available for this integration:

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.