summaryrefslogtreecommitdiffstats
path: root/python.d/beanstalk.chart.py
blob: 8880afdd986c4f5efbb1d921b04561f199183821 (plain)
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# -*- coding: utf-8 -*-
# Description: beanstalk netdata python.d module
# Author: l2isbad

try:
    import beanstalkc
    BEANSTALKC = True
except ImportError:
    BEANSTALKC = False

try:
    import yaml
    YAML = True
except ImportError:
    YAML = False

from bases.FrameworkServices.SimpleService import SimpleService

# default module values (can be overridden per job in `config`)
# update_every = 2
priority = 60000
retries = 60

ORDER = ['cpu_usage', 'jobs_rate', 'connections_rate', 'commands_rate', 'current_tubes', 'current_jobs',
         'current_connections', 'binlog', 'uptime']

CHARTS = {
    'cpu_usage': {
        'options': [None, 'Cpu Usage', 'cpu time', 'server statistics', 'beanstalk.cpu_usage', 'area'],
        'lines': [
            ['rusage-utime', 'user', 'incremental'],
            ['rusage-stime', 'system', 'incremental']
        ]
    },
    'jobs_rate': {
        'options': [None, 'Jobs Rate', 'jobs/s', 'server statistics', 'beanstalk.jobs_rate', 'line'],
        'lines': [
            ['total-jobs', 'total', 'incremental'],
            ['job-timeouts', 'timeouts', 'incremental']
        ]
    },
    'connections_rate': {
        'options': [None, 'Connections Rate', 'connections/s', 'server statistics', 'beanstalk.connections_rate',
                    'area'],
        'lines': [
            ['total-connections', 'connections', 'incremental']
        ]
    },
    'commands_rate': {
        'options': [None, 'Commands Rate', 'commands/s', 'server statistics', 'beanstalk.commands_rate', 'stacked'],
        'lines': [
            ['cmd-put', 'put', 'incremental'],
            ['cmd-peek', 'peek', 'incremental'],
            ['cmd-peek-ready', 'peek-ready', 'incremental'],
            ['cmd-peek-delayed', 'peek-delayed', 'incremental'],
            ['cmd-peek-buried', 'peek-buried', 'incremental'],
            ['cmd-reserve', 'reserve', 'incremental'],
            ['cmd-use', 'use', 'incremental'],
            ['cmd-watch', 'watch', 'incremental'],
            ['cmd-ignore', 'ignore', 'incremental'],
            ['cmd-delete', 'delete', 'incremental'],
            ['cmd-release', 'release', 'incremental'],
            ['cmd-bury', 'bury', 'incremental'],
            ['cmd-kick', 'kick', 'incremental'],
            ['cmd-stats', 'stats', 'incremental'],
            ['cmd-stats-job', 'stats-job', 'incremental'],
            ['cmd-stats-tube', 'stats-tube', 'incremental'],
            ['cmd-list-tubes', 'list-tubes', 'incremental'],
            ['cmd-list-tube-used', 'list-tube-used', 'incremental'],
            ['cmd-list-tubes-watched', 'list-tubes-watched', 'incremental'],
            ['cmd-pause-tube', 'pause-tube', 'incremental']
        ]
    },
    'current_tubes': {
        'options': [None, 'Current Tubes', 'tubes', 'server statistics', 'beanstalk.current_tubes', 'area'],
        'lines': [
            ['current-tubes', 'tubes']
        ]
    },
    'current_jobs': {
        'options': [None, 'Current Jobs', 'jobs', 'server statistics', 'beanstalk.current_jobs', 'stacked'],
        'lines': [
            ['current-jobs-urgent', 'urgent'],
            ['current-jobs-ready', 'ready'],
            ['current-jobs-reserved', 'reserved'],
            ['current-jobs-delayed', 'delayed'],
            ['current-jobs-buried', 'buried']
        ]
    },
    'current_connections': {
        'options': [None, 'Current Connections', 'connections', 'server statistics',
                    'beanstalk.current_connections', 'line'],
        'lines': [
            ['current-connections', 'written'],
            ['current-producers', 'producers'],
            ['current-workers', 'workers'],
            ['current-waiting', 'waiting']
        ]
    },
    'binlog': {
        'options': [None, 'Binlog', 'records/s', 'server statistics', 'beanstalk.binlog', 'line'],
        'lines': [
            ['binlog-records-written', 'written', 'incremental'],
            ['binlog-records-migrated', 'migrated', 'incremental']
        ]
    },
    'uptime': {
        'options': [None, 'Uptime', 'seconds', 'server statistics', 'beanstalk.uptime', 'line'],
        'lines': [
            ['uptime'],
            ]
    }
}


def tube_chart_template(name):
    order = ['{0}_jobs_rate'.format(name),
             '{0}_jobs'.format(name),
             '{0}_connections'.format(name),
             '{0}_commands'.format(name),
             '{0}_pause'.format(name)
             ]
    family = 'tube {0}'.format(name)

    charts = {
        order[0]: {
            'options': [None, 'Job Rate', 'jobs/s', family, 'beanstalk.jobs_rate', 'area'],
            'lines': [
                ['_'.join([name, 'total-jobs']), 'jobs', 'incremental']
            ]},
        order[1]: {
            'options': [None, 'Jobs', 'jobs', family, 'beanstalk.jobs', 'stacked'],
            'lines': [
                ['_'.join([name, 'current-jobs-urgent']), 'urgent'],
                ['_'.join([name, 'current-jobs-ready']), 'ready'],
                ['_'.join([name, 'current-jobs-reserved']), 'reserved'],
                ['_'.join([name, 'current-jobs-delayed']), 'delayed'],
                ['_'.join([name, 'current-jobs-buried']), 'buried']
            ]},
        order[2]: {
            'options': [None, 'Connections', 'connections', family, 'beanstalk.connections', 'stacked'],
            'lines': [
                ['_'.join([name, 'current-using']), 'using'],
                ['_'.join([name, 'current-waiting']), 'waiting'],
                ['_'.join([name, 'current-watching']), 'watching']
            ]},
        order[3]: {
            'options': [None, 'Commands', 'commands/s', family, 'beanstalk.commands', 'stacked'],
            'lines': [
                ['_'.join([name, 'cmd-delete']), 'deletes', 'incremental'],
                ['_'.join([name, 'cmd-pause-tube']), 'pauses', 'incremental']
            ]},
        order[4]: {
            'options': [None, 'Pause', 'seconds', family, 'beanstalk.pause', 'stacked'],
            'lines': [
                ['_'.join([name, 'pause']), 'since'],
                ['_'.join([name, 'pause-time-left']), 'left']
            ]}

    }

    return order, charts


class Service(SimpleService):
    def __init__(self, configuration=None, name=None):
        SimpleService.__init__(self, configuration=configuration, name=name)
        self.configuration = configuration
        self.order = list(ORDER)
        self.definitions = dict(CHARTS)
        self.conn = None
        self.alive = True

    def check(self):
        if not BEANSTALKC:
            self.error("'beanstalkc' module is needed to use beanstalk.chart.py")
            return False

        if not YAML:
            self.error("'yaml' module is needed to use beanstalk.chart.py")
            return False

        self.conn = self.connect()

        return True if self.conn else False

    def get_data(self):
        """
        :return: dict
        """
        if not self.is_alive():
            return None

        active_charts = self.charts.active_charts()
        data = dict()

        try:
            data.update(self.conn.stats())

            for tube in self.conn.tubes():
                stats = self.conn.stats_tube(tube)

                if tube + '_jobs_rate' not in active_charts:
                    self.create_new_tube_charts(tube)

                for stat in stats:
                    data['_'.join([tube, stat])] = stats[stat]

        except beanstalkc.SocketError:
            self.alive = False
            return None

        return data or None

    def create_new_tube_charts(self, tube):
        order, charts = tube_chart_template(tube)

        for chart_name in order:
            params = [chart_name] + charts[chart_name]['options']
            dimensions = charts[chart_name]['lines']

            new_chart = self.charts.add_chart(params)
            for dimension in dimensions:
                new_chart.add_dimension(dimension)

    def connect(self):
        host = self.configuration.get('host', '127.0.0.1')
        port = self.configuration.get('port', 11300)
        timeout = self.configuration.get('timeout', 1)
        try:
            return beanstalkc.Connection(host=host,
                                         port=port,
                                         connect_timeout=timeout,
                                         parse_yaml=yaml.load)
        except beanstalkc.SocketError as error:
            self.error('Connection to {0}:{1} failed: {2}'.format(host, port, error))
            return None

    def reconnect(self):
        try:
            self.conn.reconnect()
            self.alive = True
            return True
        except beanstalkc.SocketError:
            return False

    def is_alive(self):
        if not self.alive:
            return self.reconnect()
        return True