| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-beanstalk |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: beanstalk |
| 7 | monitored_instance: |
| 8 | name: Beanstalk |
| 9 | link: https://beanstalkd.github.io/ |
| 10 | categories: |
| 11 | - data-collection.databases |
| 12 | icon_filename: "beanstalk.svg" |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | info_provided_to_referring_integrations: |
| 17 | description: "" |
| 18 | keywords: |
| 19 | - beanstalk |
| 20 | - beanstalkd |
| 21 | - message |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: | |
| 25 | This collector monitors Beanstalk server performance and provides detailed statistics for each tube. |
| 26 | method_description: | |
| 27 | Using the [beanstalkd protocol](https://github.com/beanstalkd/beanstalkd/blob/master/doc/protocol.txt), it communicates with the Beanstalk daemon to gather essential metrics that help understand the server's performance and activity. |
| 28 | Executed commands: |
| 29 | |
| 30 | - [stats](https://github.com/beanstalkd/beanstalkd/blob/91c54fc05dc759ef27459ce4383934e1a4f2fb4b/doc/protocol.txt#L553). |
| 31 | - [list-tubes](https://github.com/beanstalkd/beanstalkd/blob/91c54fc05dc759ef27459ce4383934e1a4f2fb4b/doc/protocol.txt#L688). |
| 32 | - [stats-tube](https://github.com/beanstalkd/beanstalkd/blob/91c54fc05dc759ef27459ce4383934e1a4f2fb4b/doc/protocol.txt#L497). |
| 33 | supported_platforms: |
| 34 | include: [] |
| 35 | exclude: [] |
| 36 | multi_instance: true |
| 37 | additional_permissions: |
| 38 | description: "" |
| 39 | default_behavior: |
| 40 | auto_detection: |
| 41 | description: | |
| 42 | By default, it detects Beanstalk instances running on localhost that are listening on port 11300. |
| 43 | limits: |
| 44 | description: "" |
| 45 | performance_impact: |
| 46 | description: "" |
| 47 | setup: |
| 48 | prerequisites: |
| 49 | list: [] |
| 50 | configuration: |
| 51 | file: |
| 52 | name: go.d/beanstalk.conf |
| 53 | options: |
| 54 | description: | |
| 55 | The following options can be defined globally: update_every, autodetection_retry. |
| 56 | folding: |
| 57 | title: Config options |
| 58 | enabled: true |
| 59 | list: |
| 60 | - name: update_every |
| 61 | description: Data collection interval (seconds). |
| 62 | default_value: 1 |
| 63 | required: false |
| 64 | group: Collection |
| 65 | - name: autodetection_retry |
| 66 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 67 | default_value: 0 |
| 68 | required: false |
| 69 | group: Collection |
| 70 | |
| 71 | - name: address |
| 72 | description: Beanstalk service address (`IP:PORT`). |
| 73 | default_value: 127.0.0.1:11300 |
| 74 | required: true |
| 75 | group: Target |
| 76 | - name: timeout |
| 77 | description: Connection, read, write, and name resolution timeout (seconds). |
| 78 | default_value: 1 |
| 79 | required: false |
| 80 | group: Target |
| 81 | |
| 82 | - name: tube_selector |
| 83 | description: "Tube selector. Defines which Beanstalk tubes to monitor. Uses [simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#readme)." |
| 84 | default_value: "*" |
| 85 | required: false |
| 86 | group: Filters |
| 87 | |
| 88 | - name: vnode |
| 89 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 90 | default_value: "" |
| 91 | required: false |
| 92 | group: Virtual Node |
| 93 | examples: |
| 94 | folding: |
| 95 | enabled: true |
| 96 | title: Config |
| 97 | list: |
| 98 | - name: Basic |
| 99 | description: A basic example configuration. |
| 100 | config: | |
| 101 | jobs: |
| 102 | - name: local |
| 103 | address: 127.0.0.1:11300 |
| 104 | - name: Multi-instance |
| 105 | description: | |
| 106 | > **Note**: When you define multiple jobs, their names must be unique. |
| 107 | |
| 108 | Collecting metrics from local and remote instances. |
| 109 | config: | |
| 110 | jobs: |
| 111 | - name: local |
| 112 | address: 127.0.0.1:11300 |
| 113 | |
| 114 | - name: remote |
| 115 | address: 203.0.113.0:11300 |
| 116 | troubleshooting: |
| 117 | problems: |
| 118 | list: [] |
| 119 | alerts: |
| 120 | - name: beanstalk_server_buried_jobs |
| 121 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/beanstalkd.conf |
| 122 | metric: beanstalk.current_jobs |
| 123 | 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. |
| 124 | metrics: |
| 125 | folding: |
| 126 | title: Metrics |
| 127 | enabled: false |
| 128 | description: "" |
| 129 | availability: [] |
| 130 | scopes: |
| 131 | - name: global |
| 132 | description: "These metrics refer to the entire monitored application." |
| 133 | labels: [] |
| 134 | metrics: |
| 135 | - name: beanstalk.current_jobs |
| 136 | description: Current Jobs |
| 137 | unit: "jobs" |
| 138 | chart_type: stacked |
| 139 | dimensions: |
| 140 | - name: ready |
| 141 | - name: buried |
| 142 | - name: urgent |
| 143 | - name: delayed |
| 144 | - name: reserved |
| 145 | - name: beanstalk.jobs_rate |
| 146 | description: Jobs Rate |
| 147 | unit: "jobs/s" |
| 148 | chart_type: line |
| 149 | dimensions: |
| 150 | - name: created |
| 151 | - name: beanstalk.jobs_timeouts |
| 152 | description: Timed Out Jobs |
| 153 | unit: "jobs/s" |
| 154 | chart_type: line |
| 155 | dimensions: |
| 156 | - name: timeouts |
| 157 | - name: beanstalk.current_tubes |
| 158 | description: Current Tubes |
| 159 | unit: "tubes" |
| 160 | chart_type: line |
| 161 | dimensions: |
| 162 | - name: tubes |
| 163 | - name: beanstalk.commands_rate |
| 164 | description: Commands Rate |
| 165 | unit: "commands/s" |
| 166 | chart_type: stacked |
| 167 | dimensions: |
| 168 | - name: put |
| 169 | - name: peek |
| 170 | - name: peek-ready |
| 171 | - name: peek-delayed |
| 172 | - name: peek-buried |
| 173 | - name: reserve |
| 174 | - name: reserve-with-timeout |
| 175 | - name: touch |
| 176 | - name: use |
| 177 | - name: watch |
| 178 | - name: ignore |
| 179 | - name: delete |
| 180 | - name: bury |
| 181 | - name: kick |
| 182 | - name: stats |
| 183 | - name: stats-job |
| 184 | - name: stats-tube |
| 185 | - name: list-tubes |
| 186 | - name: list-tube-used |
| 187 | - name: list-tubes-watched |
| 188 | - name: pause-tube |
| 189 | - name: beanstalk.current_connections |
| 190 | description: Current Connections |
| 191 | unit: "connections" |
| 192 | chart_type: line |
| 193 | dimensions: |
| 194 | - name: open |
| 195 | - name: producers |
| 196 | - name: workers |
| 197 | - name: waiting |
| 198 | - name: beanstalk.connections_rate |
| 199 | description: Connections Rate |
| 200 | unit: "connections/s" |
| 201 | chart_type: area |
| 202 | dimensions: |
| 203 | - name: created |
| 204 | - name: beanstalk.binlog_records |
| 205 | description: Binlog Records |
| 206 | unit: "records/s" |
| 207 | chart_type: line |
| 208 | dimensions: |
| 209 | - name: written |
| 210 | - name: migrated |
| 211 | - name: beanstalk.cpu_usage |
| 212 | description: Cpu Usage |
| 213 | unit: "percent" |
| 214 | chart_type: stacked |
| 215 | dimensions: |
| 216 | - name: user |
| 217 | - name: system |
| 218 | - name: beanstalk.uptime |
| 219 | description: seconds |
| 220 | unit: "seconds" |
| 221 | chart_type: line |
| 222 | dimensions: |
| 223 | - name: uptime |
| 224 | - name: tube |
| 225 | description: "Metrics related to Beanstalk tubes. This set of metrics is provided for each tube." |
| 226 | labels: |
| 227 | - name: tube_name |
| 228 | description: Tube name. |
| 229 | metrics: |
| 230 | - name: beanstalk.tube_current_jobs |
| 231 | description: Tube Current Jobs |
| 232 | unit: "jobs" |
| 233 | chart_type: stacked |
| 234 | dimensions: |
| 235 | - name: ready |
| 236 | - name: buried |
| 237 | - name: urgent |
| 238 | - name: delayed |
| 239 | - name: reserved |
| 240 | - name: beanstalk.tube_jobs_rate |
| 241 | description: Tube Jobs Rate |
| 242 | unit: "jobs/s" |
| 243 | chart_type: line |
| 244 | dimensions: |
| 245 | - name: created |
| 246 | - name: beanstalk.tube_commands_rate |
| 247 | description: Tube Commands |
| 248 | unit: "commands/s" |
| 249 | chart_type: stacked |
| 250 | dimensions: |
| 251 | - name: delete |
| 252 | - name: pause-tube |
| 253 | - name: beanstalk.tube_current_connections |
| 254 | description: Tube Current Connections |
| 255 | unit: "connections" |
| 256 | chart_type: stacked |
| 257 | dimensions: |
| 258 | - name: using |
| 259 | - name: waiting |
| 260 | - name: watching |
| 261 | - name: beanstalk.tube_pause_time |
| 262 | description: Tube Pause Time |
| 263 | unit: "seconds" |
| 264 | chart_type: line |
| 265 | dimensions: |
| 266 | - name: since |
| 267 | - name: left |