summaryrefslogtreecommitdiff
path: root/bin/custodian-queue
blob: cb4c3ce0aa317b536268ea4294d1461167d6018c (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
#!/usr/bin/ruby1.8
#
# NAME
#  custodian-queue - Work with the queue.
#
# SYNOPSIS
#  custodian-queue  [ -h | --help ]
#                   [ -m | --manual ]
#                   [ -M | --monitor ]
#                   [ -f | --flush ]
#                   [ -s | --stats ]
#                   [ -S | --server 1.2.3.4:123 ]
#
# OPTIONS
#
#  -h, --help          Show a help message, and exit.
#
#  -m, --manual        Show this manual, and exit.
#
#  -M, --monitor       Alert, via mauve, if our queue is too full.
#
#  -f, --flush         Flush the queue, removing all jobs.
#
#  -s, --stats         Show the pending jobs.
#
#  -S, --server        Specify the host:port for the beanstalkd queue.
#
#
# ABOUT
#
#  This tool is designed to inspect the beanstalkd queue.
#
#
# AUTHOR
#
#  Steve Kemp  <steve@bytemark.co.uk>
#



#
# Standard modules
#
require 'beanstalk-client'
require 'getoptlong'


#
# Our code
#
require 'custodian/settings'



#
#  Entry-point to our code.
#
if __FILE__ == $0 then

  $FLUSH   = false
  $STATS   = false
  $help    = false
  $manual  = false
  $MONITOR = false

  #
  #  The beanstalkd server address.
  #
  settings = Custodian::Settings.instance()
  $SERVER  = settings.queue_server

  begin
    opts = GetoptLong.new(
                          [ "--flush",   "-f", GetoptLong::NO_ARGUMENT ],
                          [ "--help",    "-h", GetoptLong::NO_ARGUMENT ],
                          [ "--manual",  "-m", GetoptLong::NO_ARGUMENT ],
                          [ "--monitor", "-M", GetoptLong::NO_ARGUMENT ],
                          [ "--server",  "-S", GetoptLong::REQUIRED_ARGUMENT ],
                          [ "--stats",   "-s", GetoptLong::NO_ARGUMENT ]
                          )
    opts.each do |opt, arg|
      case opt
      when "--monitor" then
          $MONITOR = true
      when "--stats" then
          $STATS = true
      when "--flush" then
          $FLUSH = true
      when "--server" then
          $SERVER = arg
      when "--help" then
          $help = true
      when "--manual" then
          $manual = true
      end
    end
  rescue StandardError => ex
    puts "Option parsing failed: #{ex.to_s}"
    exit
  end

  #
  # CAUTION! Here be quality kode.
  #
  if $manual or $help

    # Open the file, stripping the shebang line
    lines = File.open(__FILE__){|fh| fh.readlines}[1..-1]

    found_synopsis = false

    lines.each do |line|

      line.chomp!
      break if line.empty?

      if $help and !found_synopsis
        found_synopsis = (line =~ /^#\s+SYNOPSIS\s*$/)
        next
      end

      puts line[2..-1].to_s

      break if $help and found_synopsis and line =~ /^#\s*$/

    end

    exit 0
  end

  #
  #  Create the object
  #
  queue = Beanstalk::Pool.new([$SERVER])

  #
  # Alerting on a queue that is too-full?
  #
  if ( $MONITOR )

    #
    # Find the number of jobs
    #
    stats = queue.stats()
    jobs  = stats['current-jobs-ready'] || 0

    max = 5000

    if ( jobs > max )
      system( "mauvesend alert.bytemark.co.uk -i custodian -r now -s \"Our queue has #{jobs} [alert-threshold is: #{max}]  in it\" --detail=\"<p>The custodian queue doesn't seem to be emptying.  Is there a bug, or do we need to add more workers?  See https://wiki.bytemark.co.uk/Main/CustodianMonitoring</p>\" " )
    else
      system( "mauvesend alert.bytemark.co.uk -i custodian -c now -s \"Our queue has #{jobs} [alert-threshold is: #{max} in it\" --detail=\"<p>The custodian queue doesn't seem to be emptying.  Is there a bug, or do we need to add more workers? See https://wiki.bytemark.co.uk/Main/CustodianMonitoring</p>\" " )
    end
    exit( 0 )
  end


  #
  # Showing stats?
  #
  if ( $STATS )
     stats = queue.stats()
     puts "There are #{stats['current-jobs-ready'] || 0} jobs pending."
     exit( 0 )
  end


  #
  #  Are we flushing the queue?
  #
  if ( $FLUSH )
    while( true )
      begin
        job = queue.reserve(1)
        job.delete
      rescue Beanstalk::TimedOut => ex
        exit( 0 )
      end
    end
  end


end