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

PHP FPM 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the collectd/php-fpm monitor type to monitor PHP-FastCGI Process Manager (FPM) using the pool status URL.

This integration is only available on Kubernetes and Linux.

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.

Install PHP 🔗

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

  1. Activate 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.

Configuration 🔗

To use this integration of a Smart Agent monitor with the Collector:

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Example 🔗

To activate this integration, add the following to your Collector configuration:

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

Next, add the monitor 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 collectd/php-fpm:

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 using 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.

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

  • Learn more about the available metric types in Observability Cloud.

  • Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.

  • To add additional metrics, see how to configure extraMetrics using the Collector.

Troubleshooting 🔗

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.