Overview
This check monitors Puma through the Datadog Agent with the Puma metrics endpoint provided by the control and status server.
Setup
The Puma 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 Puma check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.
Run the following command to install the Agent integration:
datadog-agent integration install -t datadog-puma==<INTEGRATION_VERSION>
Configure your integration similar to core integrations.
Configuration
Edit the puma.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Puma performance data. See the sample puma.d/conf.yaml for all available configuration options.
Restart the Agent.
Validation
Run the Agent’s status subcommand and look for puma under the Checks section.
Data Collected
Metrics
puma.backlog
(gauge) | Pending request backlog
Shown as unit |
puma.booted_workers
(gauge) | Number of booted puma workers
Shown as unit |
puma.max_threads
(gauge) | Maximum threads
Shown as unit |
puma.pool_capacity
(gauge) | Pool capacity
Shown as unit |
puma.requests_count
(gauge) | Request count
Shown as unit |
puma.running
(gauge) | Running threads
Shown as unit |
puma.workers
(gauge) | Total number of puma workers
Shown as unit |
Events
Puma does not include any events.
Service Checks
puma.connection
Returns CRITICAL if the Agent is unable to connect to the monitored Puma instance. Returns OK otherwise.
Statuses: ok, critical
Troubleshooting
Need help? Contact Datadog support.
