collectors/python.d.plugin/beanstalk/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

<!--
title: "Beanstalk monitoring with Netdata"
custom_edit_url: "https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/beanstalk/README.md"
sidebar_label: "Beanstalk"
learn_status: "Published"
learn_topic_type: "References"
learn_rel_path: "Integrations/Monitor/Message brokers"
-->

# Beanstalk collector

Provides server and tube-level statistics.

## Requirements

-   `python-beanstalkc`

**Server statistics:**

1.  **Cpu usage** in cpu time

    -   user
    -   system

2.  **Jobs rate** in jobs/s

    -   total
    -   timeouts

3.  **Connections rate** in connections/s

    -   connections

4.  **Commands rate** in commands/s

    -   put
    -   peek
    -   peek-ready
    -   peek-delayed
    -   peek-buried
    -   reserve
    -   use
    -   watch
    -   ignore
    -   delete
    -   release
    -   bury
    -   kick
    -   stats
    -   stats-job
    -   stats-tube
    -   list-tubes
    -   list-tube-used
    -   list-tubes-watched
    -   pause-tube

5.  **Current tubes** in tubes

    -   tubes

6.  **Current jobs** in jobs

    -   urgent
    -   ready
    -   reserved
    -   delayed
    -   buried

7.  **Current connections** in connections

    -   written
    -   producers
    -   workers
    -   waiting

8.  **Binlog** in records/s

    -   written
    -   migrated

9.  **Uptime** in seconds

    -   uptime

**Per tube statistics:**

1.  **Jobs rate** in jobs/s

    -   jobs

2.  **Jobs** in jobs

    -   using
    -   ready
    -   reserved
    -   delayed
    -   buried

3.  **Connections** in connections

    -   using
    -   waiting
    -   watching

4.  **Commands** in commands/s

    -   deletes
    -   pauses

5.  **Pause** in seconds

    -   since
    -   left

## Configuration

Edit the `python.d/beanstalk.conf` configuration file using `edit-config` from the Netdata [config
directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md), which is typically at `/etc/netdata`.

```bash
cd /etc/netdata   # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/beanstalk.conf
```

Sample:

```yaml
host         : '127.0.0.1'
port         : 11300
```

If no configuration is given, module will attempt to connect to beanstalkd on `127.0.0.1:11300` address


### Troubleshooting

To troubleshoot issues with the `beanstalk` module, run the `python.d.plugin` with the debug option enabled. The 
output will give you the output of the data collection job or error messages on why the collector isn't working.

First, navigate to your plugins directory, usually they are located under `/usr/libexec/netdata/plugins.d/`. If that's 
not the case on your system, open `netdata.conf` and look for the setting `plugins directory`. Once you're in the 
plugin's directory, switch to the `netdata` user.

```bash
cd /usr/libexec/netdata/plugins.d/
sudo su -s /bin/bash netdata
```

Now you can manually run the `beanstalk` module in debug mode:

```bash
./python.d.plugin beanstalk debug trace
```