Beanstalk
Beanstalk
Plugin: go.d.plugin Module: beanstalk
Overview
This collector monitors Beanstalk server performance and provides detailed statistics for each tube.
Using the beanstalkd protocol, it communicates with the Beanstalk daemon to gather essential metrics that help understand the server’s performance and activity. Executed commands:
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior
Auto-Detection
By default, it detects Beanstalk instances running on localhost that are listening on port 11300.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name for this integration is go.d/beanstalk.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/beanstalk.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| address | The IP address and port where the Beanstalk service listens for connections. | 127.0.0.1:11300 | yes |
| timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no |
| tube_selector | Specifies a pattern for which Beanstalk tubes Netdata will collect statistics. | * | no |
Examples
Basic
A basic example configuration.
jobs:
- name: local
address: 127.0.0.1:11300
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
jobs:
- name: local
address: 127.0.0.1:11300
- name: remote
address: 203.0.113.0:11300
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per Beanstalk instance
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| beanstalk.current_jobs | ready, buried, urgent, delayed, reserved | jobs |
| beanstalk.jobs_rate | created | jobs/s |
| beanstalk.jobs_timeouts | timeouts | jobs/s |
| beanstalk.current_tubes | tubes | tubes |
| beanstalk.commands_rate | put, peek, peek-ready, peek-delayed, peek-buried, reserve, reserve-with-timeout, touch, use, watch, ignore, delete, bury, kick, stats, stats-job, stats-tube, list-tubes, list-tube-used, list-tubes-watched, pause-tube | commands/s |
| beanstalk.current_connections | open, producers, workers, waiting | connections |
| beanstalk.connections_rate | created | connections/s |
| beanstalk.binlog_records | written, migrated | records/s |
| beanstalk.cpu_usage | user, system | percent |
| beanstalk.uptime | uptime | seconds |
Per tube
Metrics related to Beanstalk tubes. This set of metrics is provided for each tube.
Labels:
| Label | Description |
|---|---|
| tube_name | Tube name. |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| beanstalk.tube_current_jobs | ready, buried, urgent, delayed, reserved | jobs |
| beanstalk.tube_jobs_rate | created | jobs/s |
| beanstalk.tube_commands_rate | delete, pause-tube | commands/s |
| beanstalk.tube_current_connections | using, waiting, watching | connections |
| beanstalk.tube_pause_time | since, left | seconds |
Alerts
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| beanstalk_server_buried_jobs | beanstalk.current_jobs | number of buried jobs across all tubes. You need to manually kick them so they can be processed. Presence of buried jobs in a tube does not affect new jobs. |
Troubleshooting
Debug Mode
Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
To troubleshoot issues with the beanstalk collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m beanstalk
Getting Logs
If you’re encountering problems with the beanstalk collector, follow these steps to retrieve logs and identify potential issues:
- Run the command specific to your system (systemd, non-systemd, or Docker container).
- Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
System with systemd
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep beanstalk
System without systemd
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:
grep beanstalk /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
Docker Container
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep beanstalk