For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/integrations/gearman.md. A documentation index is available at /llms.txt.

Gearman

Supported OS Linux Mac OS

Integration version5.3.0

To find out if this integration is available in your organization, see your Datadog Integrations page or ask your organization administrator.

To initiate an exception request to enable this integration for your organization, email support@ddog-gov.com.

Overview

Collect Gearman metrics to:

  • Visualize Gearman performance.
  • Know how many tasks are queued or running.
  • Correlate Gearman performance with the rest of your applications.

Minimum Agent version: 6.0.0

Setup

Installation

The Gearman check is included in the Datadog Agent package, so you don’t need to install anything else on your Gearman job servers.

Configuration

    Host

    To configure this check for an Agent running on a host:

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

      init_config:

instances:
  - server: localhost
    port: 4730

    2. Restart the Agent

    Containerized

    For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

    ParameterValue
    <INTEGRATION_NAME>gearmand
    <INIT_CONFIG>blank or {}
    <INSTANCE_CONFIG>{"server":"%%host%%", "port":"4730"}

    Log collection

    1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

      logs_enabled: true

    2. Add this configuration block to your gearmand.d/conf.yaml file to start collecting your Gearman logs:

      logs:
  - type: file
    path: /var/log/gearmand.log
    source: gearman

      Change the path parameter value based on your environment. See the sample gearmand.d/conf.yaml for all available configuration options.

    3. Restart the Agent.

    See Kubernetes Log Collection for information on configuring the Agent for log collection in Kubernetes environments.

    Validation

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

    Data Collected

    Metrics

    gearman.queued
    (gauge)    		The total number of jobs in the queue.
    Shown as task
    gearman.queued_by_task
    (gauge)    		The number of jobs in the queue by task.
    Shown as task
    gearman.running
    (gauge)    		The total number of running Gearman jobs.
    Shown as task
    gearman.running_by_task
    (gauge)    		The number of running Gearman jobs by task.
    Shown as task
    gearman.unique_tasks
    (gauge)    		The number of all functions registered with Gearman.
    Shown as task
    gearman.workers
    (gauge)    		The total number of capable Gearman workers.
    Shown as process
    gearman.workers_by_task
    (gauge)    		The number of capable Gearman workers by task.
    Shown as process

    Events

    The Gearman check does not include any events.

    Service Checks

    gearman.can_connect

    Returns CRITICAL if the Agent check is unable to connect to the monitored Gearman instance. Returns OK otherwise.

    Statuses: ok, critical

    Troubleshooting

    Need help? Contact Datadog support.