PHP APCu

PHP APCu

Agent Check Agent Check

Supported OS Linux Mac OS Windows

Integrationv0.0.2

Overview

This check monitors PHP APCu through the Datadog Agent.

Setup

The PHP APCu check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the PHP APCu check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.

  1. Run the following command to install the Agent integration:

    datadog-agent integration install -t datadog-php_apcu==<INTEGRATION_VERSION>
    
  2. Configure your integration similar to core integrations.

APCu

APCu does not expose metrics by default so this integration includes a metric exporter, located here:

/opt/datadog-agent/embedded/lib/python3.8/site-packages/datadog_checks/php_apcu/assets/exporter/apcu-dd-handler.php

You can download the exporter here.

When you configure your Agent (the instances setting, described next), you can refer to the exporter directly by this file name, or you can configure an alias for it on your web server. For example, if you’re using Apache, the alias in the web server configuration file would look like this:

Alias /apcu-status /opt/datadog-agent/embedded/lib/python3.8/site-packages/datadog_checks/php_apcu/assets/exporter/apcu-dd-handler.php
<Location /apcu-status>
    Require all denied
    Require local
</Location>

Configuration

  1. Edit the php_apcu.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your php_apcu performance data. See the sample php_apcu.d/conf.yaml file for all available configuration options.

    instances
      - url: http://localhost/apcu-status
    
  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for php_apcu under the Checks section.

Data Collected

Metrics

php_apcu.cache.mem_size
(gauge)
used memory size
Shown as byte
php_apcu.cache.num_slots
(gauge)
number of cache slots
Shown as unit
php_apcu.cache.ttl
(gauge)
default ttl
Shown as second
php_apcu.cache.num_hits
(gauge)
cache hit count
Shown as hit
php_apcu.cache.num_misses
(gauge)
cache miss count
Shown as miss
php_apcu.cache.num_inserts
(gauge)
cache insert count
Shown as set
php_apcu.cache.num_entries
(gauge)
number of cache entries
Shown as item
php_apcu.cache.num_expunges
(gauge)
number of cache expunges
Shown as eviction
php_apcu.cache.uptime
(gauge)
uptime
Shown as second
php_apcu.sma.avail_mem
(gauge)
available memory size
Shown as byte
php_apcu.sma.seg_size
(gauge)
total memory size
Shown as byte
php_apcu.sma.num_seg
(gauge)
number of cache segments
Shown as unit

Events

The PHP APCu integration does not include any events.

Service Checks

php_apcu.can_connect
Returns CRITICAL if the Agent is unable to connect to and collect metrics from the monitored APCu instance. Returns OK otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.