netdata/collectors/python.d.plugin/gearman/metadata.yaml

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: gearman
      monitored_instance:
        name: Gearman
        link: "http://gearman.org/"
        categories:
          - data-collection.distributed-computing-systems
        icon_filename: "gearman.png"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - gearman
        - gearman job server
      most_popular: false
    overview:
      data_collection:
        metrics_description: "Monitor Gearman metrics for proficient system task distribution. Track job counts, worker statuses, and queue lengths for effective distributed task management."
        method_description: "This collector connects to a Gearman instance via either TCP or unix socket."
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: "When no configuration file is found, the collector tries to connect to TCP/IP socket: localhost:4730."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: "Socket permissions"
            description: The gearman UNIX socket should have read permission for user netdata.
      configuration:
        file:
          name: python.d/gearman.conf
        options:
          description: |
            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.
          folding:
            title: "Config options"
            enabled: true
          list:
            - name: update_every
              description: Sets the default data collection frequency.
              default_value: 5
              required: false
            - name: priority
              description: Controls the order of charts at the netdata dashboard.
              default_value: 60000
              required: false
            - name: autodetection_retry
              description: Sets the job re-check interval in seconds.
              default_value: 0
              required: false
            - name: penalty
              description: Indicates whether to apply penalty to update_every in case of failures.
              default_value: yes
              required: false
            - name: name
              description: Job 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 works.
              default_value: ""
              required: false
            - name: host
              description: URL or IP where gearman is running.
              default_value: "localhost"
              required: false
            - name: port
              description: Port of URL or IP where gearman is running.
              default_value: "4730"
              required: false
            - name: tls
              description: Use tls to connect to gearman.
              default_value: "false"
              required: false
            - name: cert
              description: Provide a certificate file if needed to connect to a TLS gearman instance.
              default_value: ""
              required: false
            - name: key
              description: Provide a key file if needed to connect to a TLS gearman instance.
              default_value: ""
              required: false
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: Local gearman service
              description: A basic host and port gearman configuration for localhost.
              folding:
                enabled: false
              config: |
                localhost:
                  name: 'local'
                  host: 'localhost'
                  port: 4730
            - name: Multi-instance
              description: |
                > **Note**: When you define multiple jobs, their names must be unique.
                
                Collecting metrics from local and remote instances.
              config: |
                localhost:
                  name: 'local'
                  host: 'localhost'
                  port: 4730
                
                remote:
                  name: 'remote'
                  host: '192.0.2.1'
                  port: 4730
    troubleshooting:
      problems:
        list: []
    alerts:
      - name: gearman_workers_queued
        link: https://github.com/netdata/netdata/blob/master/health/health.d/gearman.conf
        metric: gearman.single_job
        info: average number of queued jobs over the last 10 minutes
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored application."
          labels: []
          metrics:
            - name: gearman.total_jobs
              description: Total Jobs
              unit: "Jobs"
              chart_type: line
              dimensions:
                - name: Pending
                - name: Running
        - name: gearman job
          description: "Metrics related to Gearman jobs. Each job produces its own set of the following metrics."
          labels: []
          metrics:
            - name: gearman.single_job
              description: "{job_name}"
              unit: "Jobs"
              chart_type: stacked
              dimensions:
                - name: Pending
                - name: Idle
                - name: Runnning