Collectd PHP FPM 🔗

Description 🔗

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

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

Note

This monitor is not available on Windows as collectd plugins are only supported in Linux and Kubernetes.

Requirements 🔗

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

Activate the status path. See the PHP documentation for more information.

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;
 }

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:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

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

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:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

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

Related Topics