Beanstalkd Exporter is a beanstalkd stats exporter for Prometheus.
Every now and then a goroutine connects to a beanstalkd server and asks for stats. These stats are then stored in memory for later.
Every now and then Prometheus requests for stats. We read those from memory and respond.
Running beanstalkd_exporter is as easy as executing beanstalkd_exporter
on the command line. Two arguments are required: -config
and -mapping-config
(see below for what they need).
$ beanstalkd_exporter -config examples/servers.conf -mapping-config examples/mapping.conf
Use the -h flag to get help information.
$ beanstalkd_exporter -h
Usage of ./bin/beanstalkd_exporter:
-beanstalkd.address string
Beanstalkd server address (default "localhost:11300")
-log.level string
The log level. (default "warning")
-mapping-config string
A file that describes a mapping of tube names.
-poll int
The number of seconds that we poll the beanstalkd server for stats. (default 30)
-sleep-between-tube-stats int
The number of milliseconds to sleep between tube stats. (default 5000)
-web.listen-address string
Address to listen on for web interface and telemetry. (default ":8080")
-web.telemetry-path string
Path under which to expose metrics. (default "/metrics")
Sometimes tubes names are complicated. Sometimes tubes are dedicated to entities like users and carry on their names the user id. But it is interesting to stat all these diffent but similar tubes together. To do this you can give beastalkd_exporter a mapping config file.
Say you have many tube names like
incoming-emails-7822
incoming-emails-1235
incoming-emails-8882
...
These tubes hold incoming emails for specific users. If you ran beanstalkd_exporter without any mapping you would get stats like this:
tube_current_jobs_ready{tube="incoming-emails-7822"}
tube_current_jobs_ready{tube="incoming-emails-1235"}
tube_current_jobs_ready{tube="incoming-emails-8882"}
...
And it would be hard to group all of them together to know things like "what is the total size of 'incoming emails' tubes".
So we create a mapping config file ("./mapping.conf") with this contents:
incoming-emails-(\d+)
name="incoming-emails"
user_id="$1"
some-other-tube-(\w+)-processor-(\d+)
name="some-other-tube"
processor="$1"
node_id="$2"
(the file format was heavily inspired by statsd_exporter's stat mapping format.)
Run beanstalkd_exporter with the option "-mapping-config" like this:
beanstalkd_exporter -mapping-config="./mapping.conf"
and the resulting stats will be like
tube_current_jobs_ready{tube="incoming-emails",user_id="7822"}
tube_current_jobs_ready{tube="incoming-emails",user_id="1235"}
tube_current_jobs_ready{tube="incoming-emails",user_id="8882"}
beanstalkd_exporter is licensed under The BSD 2-Clause License. Copyright (c) 2016, MessageBird