Skip to main content


Plugin: python.d.plugin Module: gearman


Monitor Gearman metrics for proficient system task distribution. Track job counts, worker statuses, and queue lengths for effective distributed task management.

This collector connects to a Gearman instance via either TCP or unix socket.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior


When no configuration file is found, the collector tries to connect to TCP/IP socket: localhost:4730.


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.


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 Gearman instance

These metrics refer to the entire monitored application.

This scope has no labels.


gearman.total_jobsPending, RunningJobs

Per gearman job

Metrics related to Gearman jobs. Each job produces its own set of the following metrics.

This scope has no labels.


gearman.single_jobPending, Idle, RunnningJobs


The following alerts are available:

Alert nameOn metricDescription
gearman_workers_queued gearman.single_jobaverage number of queued jobs over the last 10 minutes



Socket permissions

The gearman UNIX socket should have read permission for user netdata.



The configuration file name for this integration is python.d/gearman.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 python.d/gearman.conf


There are 2 sections:

  • Global variables
  • One or more JOBS that can define multiple different instances to monitor.

The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.

Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.

Every configuration JOB starts with a job_name value which will appear in the dashboard, unless a name parameter is specified.

Config options
update_everySets the default data collection frequency.5no
priorityControls the order of charts at the netdata dashboard.60000no
autodetection_retrySets the job re-check interval in seconds.0no
penaltyIndicates whether to apply penalty to update_every in case of failures.yesno
nameJob name. This value will overwrite the job_name value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that
hostURL or IP where gearman is running.localhostno
portPort of URL or IP where gearman is running.4730no
tlsUse tls to connect to gearman.falseno
certProvide a certificate file if needed to connect to a TLS gearman
keyProvide a key file if needed to connect to a TLS gearman


Local gearman service

A basic host and port gearman configuration for localhost.

name: 'local'
host: 'localhost'
port: 4730


Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

name: 'local'
host: 'localhost'
port: 4730

name: 'remote'
host: ''
port: 4730


Debug Mode

To troubleshoot issues with the gearman collector, run the python.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.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the python.d.plugin to debug the collector:

    ./python.d.plugin gearman debug trace

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.