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

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: beanstalk
      monitored_instance:
        name: Beanstalk
        link: "https://beanstalkd.github.io/"
        categories:
          - data-collection.message-brokers
          - data-collection.task-queues
        icon_filename: "beanstalk.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - beanstalk
        - beanstalkd
        - message
      most_popular: false
    overview:
      data_collection:
        metrics_description: "Monitor Beanstalk metrics to enhance job queueing and processing efficiency. Track job rates, processing times, and queue lengths for better task management."
        method_description: "The collector uses the `beanstalkc` python module to connect to a `beanstalkd` service and gather metrics."
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: "If no configuration is given, module will attempt to connect to beanstalkd on 127.0.0.1:11300 address."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list:
          - title: "beanstalkc python module"
            description: The collector requires the `beanstalkc` python module to be installed.
      configuration:
        file:
          name: python.d/beanstalk.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: IP or URL to a beanstalk service.
              default_value: "127.0.0.1"
              required: false
            - name: port
              description: Port to the IP or URL to a beanstalk service.
              default_value: "11300"
              required: false
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: Remote beanstalk server
              description: A basic remote beanstalk server
              folding:
                enabled: false
              config: |
                remote:
                  name: 'beanstalk'
                  host: '1.2.3.4'
                  port: 11300
            - 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_beanstalk'
                  host: '127.0.0.1'
                  port: 11300
                
                remote_job:
                  name: 'remote_beanstalk'
                  host: '192.0.2.1'
                  port: 113000
    troubleshooting:
      problems:
        list: []
    alerts:
      - name: beanstalk_server_buried_jobs
        link: https://github.com/netdata/netdata/blob/master/health/health.d/beanstalkd.conf
        metric: beanstalk.current_jobs
        info: 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.
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored application."
          labels: []
          metrics:
            - name: beanstalk.cpu_usage
              description: Cpu Usage
              unit: "cpu time"
              chart_type: area
              dimensions:
                - name: user
                - name: system
            - name: beanstalk.jobs_rate
              description: Jobs Rate
              unit: "jobs/s"
              chart_type: line
              dimensions:
                - name: total
                - name: timeouts
            - name: beanstalk.connections_rate
              description: Connections Rate
              unit: "connections/s"
              chart_type: area
              dimensions:
                - name: connections
            - name: beanstalk.commands_rate
              description: Commands Rate
              unit: "commands/s"
              chart_type: stacked
              dimensions:
                - name: put
                - name: peek
                - name: peek-ready
                - name: peek-delayed
                - name: peek-buried
                - name: reserve
                - name: use
                - name: watch
                - name: ignore
                - name: delete
                - name: bury
                - name: kick
                - name: stats
                - name: stats-job
                - name: stats-tube
                - name: list-tubes
                - name: list-tube-used
                - name: list-tubes-watched
                - name: pause-tube
            - name: beanstalk.connections_rate
              description: Current Tubes
              unit: "tubes"
              chart_type: area
              dimensions:
                - name: tubes
            - name: beanstalk.current_jobs
              description: Current Jobs
              unit: "jobs"
              chart_type: stacked
              dimensions:
                - name: urgent
                - name: ready
                - name: reserved
                - name: delayed
                - name: buried
            - name: beanstalk.current_connections
              description: Current Connections
              unit: "connections"
              chart_type: line
              dimensions:
                - name: written
                - name: producers
                - name: workers
                - name: waiting
            - name: beanstalk.binlog
              description: Binlog
              unit: "records/s"
              chart_type: line
              dimensions:
                - name: written
                - name: migrated
            - name: beanstalk.uptime
              description: seconds
              unit: "seconds"
              chart_type: line
              dimensions:
                - name: uptime
        - name: tube
          description: "Metrics related to Beanstalk tubes. Each tube produces its own set of the following metrics."
          labels: []
          metrics:
            - name: beanstalk.jobs_rate
              description: Jobs Rate
              unit: "jobs/s"
              chart_type: area
              dimensions:
                - name: jobs
            - name: beanstalk.jobs
              description: Jobs
              unit: "jobs"
              chart_type: stacked
              dimensions:
                - name: urgent
                - name: ready
                - name: reserved
                - name: delayed
                - name: buried
            - name: beanstalk.connections
              description: Connections
              unit: "connections"
              chart_type: stacked
              dimensions:
                - name: using
                - name: waiting
                - name: watching
            - name: beanstalk.commands
              description: Commands
              unit: "commands/s"
              chart_type: stacked
              dimensions:
                - name: deletes
                - name: pauses
            - name: beanstalk.pause
              description: Pause
              unit: "seconds"
              chart_type: stacked
              dimensions:
                - name: since
                - name: left