sidekiq-killswitch 1.0.0.pre1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +2 -0
- data/.rubocop.yml +679 -0
- data/CHANGES.md +2 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +155 -0
- data/Rakefile +18 -0
- data/examples/killswitch-web-ui.png +0 -0
- data/examples/square-logo.png +0 -0
- data/lib/sidekiq/extensions/dead_set.rb +23 -0
- data/lib/sidekiq/killswitch/config.rb +37 -0
- data/lib/sidekiq/killswitch/middleware/client.rb +20 -0
- data/lib/sidekiq/killswitch/middleware/load_all.rb +19 -0
- data/lib/sidekiq/killswitch/middleware/server.rb +20 -0
- data/lib/sidekiq/killswitch/version.rb +7 -0
- data/lib/sidekiq/killswitch/web.rb +62 -0
- data/lib/sidekiq/killswitch.rb +92 -0
- data/sidekiq-killswitch.gemspec +25 -0
- data/spec/config_spec.rb +33 -0
- data/spec/dead_set_spec.rb +47 -0
- data/spec/killswitch_spec.rb +145 -0
- data/spec/middleware/client_spec.rb +25 -0
- data/spec/middleware/server_spec.rb +46 -0
- data/spec/spec_helper.rb +23 -0
- data/spec/web_spec.rb +110 -0
- data/web/locales/en.yml +15 -0
- data/web/views/kill_switches.html.erb +75 -0
- metadata +148 -0
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright 2017 Square Inc.
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,155 @@
|
|
1
|
+
# Sidekiq::Killswitch
|
2
|
+
<a href="https://squareup.com/careers" title="Brought to you by Square"><img alt="Brought to you by Square" src="https://github.com/square/sidekiq-killswitch/raw/master/examples/square-logo.png" /></a>
|
3
|
+
|
4
|
+
## Description
|
5
|
+
|
6
|
+
Cross-host Sidekiq worker killswitches.
|
7
|
+
|
8
|
+
## Features
|
9
|
+
- Blackhole a worker - new jobs won't be pushed to Redis. Already queued jobs will be marked as processed without being executed.
|
10
|
+
- Send a worker to the dead queue - Sidekiq will put all jobs for this worker to the "Dead jobs" list without executing them.
|
11
|
+
- Sidekiq Web UI integration.
|
12
|
+
- Worker class verification. Disabled by default.
|
13
|
+
|
14
|
+
|
15
|
+
### How does it work?
|
16
|
+
|
17
|
+
`Sidekiq::Killswitch` works as Sidekiq server and client middleware.
|
18
|
+
|
19
|
+
*Blackholed workers* - when `YourWorker#perform_async` is called, `Sidekiq::Killswitch::Middleware::Client` checks
|
20
|
+
if `YourWorker` was blackholed. If yes, it will reject pushing a job to Redis. When someone blackholes a worker that
|
21
|
+
already has some jobs in the queue, `Sidekiq::Killswitch::Middleware::Server` will mark those as processed without
|
22
|
+
actually executing them.
|
23
|
+
|
24
|
+
*Dead-queued workers* - before executing job on the server, `Sidekiq::Killswitch::Middleware::Server` checks if the worker
|
25
|
+
was dead-queued. If yes, it sends a job directly to the Sidekiq "Dead jobs", without running it.
|
26
|
+
_\* Sidekiq does not store unlimited number of jobs in Dead queue forever.
|
27
|
+
By default, right after adding a new job to the Dead queue,
|
28
|
+
it removes all but last `10_000` dead jobs (`Sidekiq.options[:dead_max_jobs]`),
|
29
|
+
it also removes all dead jobs older than 6 months (`Sidekiq.options[:dead_timeout_in_seconds]`)._
|
30
|
+
|
31
|
+
*Worker class validation (Web UI)* - since you need to type in worker class name manually in the web interface to either
|
32
|
+
blackhole it or add it to the dead-queue, there is an optional feature that performs Sidekiq Worker class validation.
|
33
|
+
When worker class name is being submitted for dead-queuing or blackholing **via Web UI (only)**,
|
34
|
+
`Sidekiq::Killswitch` will only allow it if it includes `Sidekiq::Worker` in it's ancestor list.
|
35
|
+
To enable it:
|
36
|
+
```ruby
|
37
|
+
# In your ./config/initializer/sidekiq_killswitch.rb
|
38
|
+
|
39
|
+
Sidekiq::Killswitch.configure do |config|
|
40
|
+
config.validate_worker_class_in_web # Enables Sidekiq Worker class validation in Web UI. Optional. Disabled by default.
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
It's disabled by default, because Sidekiq Web UI by default is a standalone Rack application which doesn't have to know
|
45
|
+
anything about your main Ruby app.
|
46
|
+
|
47
|
+
|
48
|
+
`Sidekiq::Killswitch` uses the same Redis database as `Sidekiq` under the hood.
|
49
|
+
|
50
|
+
The logs are written to `Sidekiq::Killswitch.logger` which you can customize (see *Configuration* section).
|
51
|
+
|
52
|
+
|
53
|
+
## Installation
|
54
|
+
|
55
|
+
Add this line to your application's Gemfile:
|
56
|
+
```ruby
|
57
|
+
gem 'sidekiq-killswitch'
|
58
|
+
```
|
59
|
+
And then execute:
|
60
|
+
```ruby
|
61
|
+
bundle
|
62
|
+
```
|
63
|
+
|
64
|
+
## Configuration
|
65
|
+
```ruby
|
66
|
+
# In your ./config/initializer/sidekiq_killswitch.rb
|
67
|
+
|
68
|
+
Sidekiq::Killswitch.configure do |config|
|
69
|
+
config.logger = MyLogger.new # Defaults to Rails.logger first, then Sidekiq.logger. Optional.
|
70
|
+
config.validate_worker_class_in_web # Enables Sidekiq Worker class validation in Web UI. Optional. Disabled by default.
|
71
|
+
config.web_ui_worker_validator = proc do |worker_name| # Manually set Web UI worker class validator
|
72
|
+
!worker_name.nil? && worker_name.end_with?('Worker') # Only allow to dead-queue/blackhole classes that end with "Worker" suffix. <= bad idea, only used here as an example.
|
73
|
+
end
|
74
|
+
end
|
75
|
+
```
|
76
|
+
|
77
|
+
Add Killswitch middleware to Sidekiq:
|
78
|
+
```ruby
|
79
|
+
# In your config/initializers/sidekiq.rb
|
80
|
+
require 'sidekiq/killswitch/middleware/load_all'
|
81
|
+
```
|
82
|
+
or you can load all parts manually:
|
83
|
+
```ruby
|
84
|
+
# In your config/initializers/sidekiq.rb
|
85
|
+
|
86
|
+
Sidekiq.configure_server do |config|
|
87
|
+
config.server_middleware do |chain|
|
88
|
+
chain.add Sidekiq::Killswitch::Middleware::Server
|
89
|
+
end
|
90
|
+
|
91
|
+
config.client_middleware do |chain|
|
92
|
+
# The jobs running in the Sidekiq server can themselves push new jobs to Sidekiq.
|
93
|
+
chain.add Sidekiq::Killswitch::Middleware::Client
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
Sidekiq.configure_client do |config|
|
98
|
+
config.client_middleware do |chain|
|
99
|
+
chain.add Sidekiq::Killswitch::Middleware::Client
|
100
|
+
end
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
Load Killswitch Sidekiq Web UI extension:
|
105
|
+
1. Find a file where you `require 'sidekiq/web'`
|
106
|
+
2. Add `require 'sidekiq/killswitch/web'` after that line.
|
107
|
+
```
|
108
|
+
# In your ./config/routes.rb or ./config.ru
|
109
|
+
|
110
|
+
require 'sidekiq/web'
|
111
|
+
require 'sidekiq/killswitch/web'
|
112
|
+
...
|
113
|
+
```
|
114
|
+
|
115
|
+
## Usage
|
116
|
+
|
117
|
+
### Web UI
|
118
|
+
![Web UI](https://github.com/square/sidekiq-killswitch/raw/master/examples/killswitch-web-ui.png)
|
119
|
+
|
120
|
+
`Sidekiq::Killswitch` integrates into Sidekiq Web app. A new tab "Kill Switches" will be added to Sidekiq admin panel
|
121
|
+
when you load the extension (see steps above for how to load it).
|
122
|
+
There are two sections in Web UI: "Blackholed Workers" and "Dead Queue Workers". Each section lists all Blackholed/Dead-Queued
|
123
|
+
workers, also allows you add or remove workers from those lists.
|
124
|
+
|
125
|
+
### API
|
126
|
+
```ruby
|
127
|
+
# worker_name argument can be a String or a Class
|
128
|
+
#
|
129
|
+
# Blackhole
|
130
|
+
Sidekiq::Killswitch.blackhole_add_worker(worker_name)
|
131
|
+
Sidekiq::Killswitch.blackhole_remove_worker(worker_name)
|
132
|
+
Sidekiq::Killswitch.blackhole_worker?(worker_name)
|
133
|
+
Sidekiq::Killswitch.blackhole_workers
|
134
|
+
# Dead queue
|
135
|
+
Sidekiq::Killswitch.dead_queue_add_worker(worker_name)
|
136
|
+
Sidekiq::Killswitch.dead_queue_remove_worker(worker_name)
|
137
|
+
Sidekiq::Killswitch.dead_queue_worker?(worker_name)
|
138
|
+
Sidekiq::Killswitch.dead_queue_workers
|
139
|
+
```
|
140
|
+
|
141
|
+
## Copyright
|
142
|
+
|
143
|
+
Copyright 2017 Square Inc.
|
144
|
+
|
145
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
146
|
+
you may not use this file except in compliance with the License.
|
147
|
+
You may obtain a copy of the License at
|
148
|
+
|
149
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
150
|
+
|
151
|
+
Unless required by applicable law or agreed to in writing, software
|
152
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
153
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
154
|
+
See the License for the specific language governing permissions and
|
155
|
+
limitations under the License.
|
data/Rakefile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
def safe_load(&block)
|
4
|
+
yield
|
5
|
+
rescue LoadError
|
6
|
+
end
|
7
|
+
|
8
|
+
safe_load do
|
9
|
+
require 'rspec/core/rake_task'
|
10
|
+
RSpec::Core::RakeTask.new(:spec)
|
11
|
+
end
|
12
|
+
|
13
|
+
safe_load do
|
14
|
+
require 'rubocop/rake_task'
|
15
|
+
RuboCop::RakeTask.new
|
16
|
+
end
|
17
|
+
|
18
|
+
task default: %w(spec rubocop)
|
Binary file
|
Binary file
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require 'sidekiq/api'
|
3
|
+
|
4
|
+
# this is a monkey-patch!
|
5
|
+
# TODO: delete this patch after we explicitly depend on Sidekiq version that
|
6
|
+
# includes this PR: https://github.com/mperham/sidekiq/pull/3573
|
7
|
+
|
8
|
+
module Sidekiq
|
9
|
+
module DeadSetKill
|
10
|
+
def kill(message)
|
11
|
+
now = Time.now.to_f
|
12
|
+
Sidekiq.redis do |conn|
|
13
|
+
conn.multi do
|
14
|
+
conn.zadd(name, now.to_f.to_s, message)
|
15
|
+
conn.zremrangebyscore(name, '-inf', now - self.class.timeout)
|
16
|
+
conn.zremrangebyrank(name, 0, - self.class.max_jobs)
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
Sidekiq::DeadSet.include(Sidekiq::DeadSetKill) unless Sidekiq::DeadSet.method_defined?(:kill)
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Sidekiq::Killswitch
|
4
|
+
class Config
|
5
|
+
attr_accessor :web_ui_worker_validator
|
6
|
+
attr_writer :logger
|
7
|
+
|
8
|
+
def initialize
|
9
|
+
self.web_ui_worker_validator = ->(worker_name) { !worker_name.nil? && worker_name != '' }
|
10
|
+
end
|
11
|
+
|
12
|
+
def logger
|
13
|
+
@logger ||= Sidekiq.logger
|
14
|
+
end
|
15
|
+
|
16
|
+
def validate_worker_class_in_web
|
17
|
+
self.web_ui_worker_validator = proc do |worker_name|
|
18
|
+
begin
|
19
|
+
constantize(worker_name).include?(Sidekiq::Worker)
|
20
|
+
rescue NameError
|
21
|
+
false
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
private
|
27
|
+
|
28
|
+
def constantize(str)
|
29
|
+
names = str.split('::')
|
30
|
+
names.shift if names.empty? || names.first.empty?
|
31
|
+
|
32
|
+
names.inject(Object) do |constant, name|
|
33
|
+
constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Sidekiq
|
4
|
+
module Killswitch
|
5
|
+
module Middleware
|
6
|
+
class Client
|
7
|
+
def call(worker_class, job, _queue, _redis_pool)
|
8
|
+
worker_name = Sidekiq::Killswitch.class_to_str(worker_class)
|
9
|
+
|
10
|
+
if Killswitch.blackhole_worker?(worker_name)
|
11
|
+
Killswitch.logger.info "#{worker_name} is currently disabled. Job #{job} was not executed."
|
12
|
+
false
|
13
|
+
else
|
14
|
+
yield
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require 'sidekiq'
|
3
|
+
|
4
|
+
Sidekiq.configure_server do |config|
|
5
|
+
config.server_middleware do |chain|
|
6
|
+
chain.add Sidekiq::Killswitch::Middleware::Server
|
7
|
+
end
|
8
|
+
|
9
|
+
config.client_middleware do |chain|
|
10
|
+
# The jobs running in the Sidekiq server can themselves push new jobs to Sidekiq.
|
11
|
+
chain.add Sidekiq::Killswitch::Middleware::Client
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
Sidekiq.configure_client do |config|
|
16
|
+
config.client_middleware do |chain|
|
17
|
+
chain.add Sidekiq::Killswitch::Middleware::Client
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Sidekiq
|
4
|
+
module Killswitch
|
5
|
+
module Middleware
|
6
|
+
class Server
|
7
|
+
def call(worker, job, _queue)
|
8
|
+
if Killswitch.dead_queue_worker?(worker.class)
|
9
|
+
DeadSet.new.kill(job)
|
10
|
+
Killswitch.logger.info "#{worker.class.name} marked as dead queue worker. Job #{job} was killed."
|
11
|
+
elsif Killswitch.blackhole_worker?(worker.class)
|
12
|
+
Killswitch.logger.info "#{worker.class.name} is currently disabled. Job #{job} was not executed."
|
13
|
+
else
|
14
|
+
yield
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Sidekiq
|
4
|
+
module Killswitch
|
5
|
+
module Web
|
6
|
+
VIEW_PATH = File.expand_path('../../../../web/views', __FILE__)
|
7
|
+
|
8
|
+
module Helpers
|
9
|
+
def validate_worker_name(worker)
|
10
|
+
return true unless Killswitch.config.web_ui_worker_validator
|
11
|
+
|
12
|
+
is_worker_valid = Killswitch.config.web_ui_worker_validator.call(worker)
|
13
|
+
session[:worker_name_invalid] = true unless is_worker_valid
|
14
|
+
is_worker_valid
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
def self.registered(app)
|
19
|
+
Sidekiq::WebApplication.helpers Helpers
|
20
|
+
|
21
|
+
app.get '/kill-switches' do
|
22
|
+
@worker_name_invalid = session.delete(:worker_name_invalid)
|
23
|
+
@blackhole_workers = Killswitch.blackhole_workers
|
24
|
+
@dead_queue_workers = Killswitch.dead_queue_workers
|
25
|
+
|
26
|
+
erb File.read(File.join(VIEW_PATH, 'kill_switches.html.erb'))
|
27
|
+
end
|
28
|
+
|
29
|
+
# We should not worry about String escaping and NoSQL injection
|
30
|
+
# https://redis.io/topics/security#string-escaping-and-nosql-injection
|
31
|
+
app.post '/kill-switches/blackhole_add' do
|
32
|
+
Killswitch.blackhole_add_worker(params['worker_name']) if validate_worker_name(params['worker_name'])
|
33
|
+
|
34
|
+
redirect "#{root_path}kill-switches"
|
35
|
+
end
|
36
|
+
|
37
|
+
app.post '/kill-switches/blackhole_remove' do
|
38
|
+
Killswitch.blackhole_remove_worker(params['worker_name']) if validate_worker_name(params['worker_name'])
|
39
|
+
|
40
|
+
redirect "#{root_path}kill-switches"
|
41
|
+
end
|
42
|
+
|
43
|
+
app.post '/kill-switches/dead_queue_add' do
|
44
|
+
Killswitch.dead_queue_add_worker(params['worker_name']) if validate_worker_name(params['worker_name'])
|
45
|
+
|
46
|
+
redirect "#{root_path}kill-switches"
|
47
|
+
end
|
48
|
+
|
49
|
+
app.post '/kill-switches/dead_queue_remove' do
|
50
|
+
Killswitch.dead_queue_remove_worker(params['worker_name']) if validate_worker_name(params['worker_name'])
|
51
|
+
|
52
|
+
redirect "#{root_path}kill-switches"
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
require 'sidekiq/web' unless defined?(Sidekiq::Web)
|
60
|
+
Sidekiq::Web.register(Sidekiq::Killswitch::Web)
|
61
|
+
Sidekiq::Web.tabs['kill_switches'] = 'kill-switches'
|
62
|
+
Sidekiq::Web.locales << File.expand_path(File.dirname(__FILE__) + '/../../../web/locales')
|
@@ -0,0 +1,92 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
require 'sidekiq/extensions/dead_set'
|
3
|
+
require 'sidekiq/killswitch/config'
|
4
|
+
require 'sidekiq/killswitch/middleware/server'
|
5
|
+
require 'sidekiq/killswitch/middleware/client'
|
6
|
+
|
7
|
+
module Sidekiq::Killswitch
|
8
|
+
BLACKHOLE_WORKERS_KEY_NAME = 'sidekiq.disabled-workers'
|
9
|
+
DEAD_QUEUE_WORKERS_KEY_NAME = 'sidekiq.dead-queue-workers'
|
10
|
+
|
11
|
+
class << self
|
12
|
+
def config
|
13
|
+
@config ||= Config.new
|
14
|
+
end
|
15
|
+
|
16
|
+
def configure(&block)
|
17
|
+
yield config
|
18
|
+
end
|
19
|
+
|
20
|
+
def logger
|
21
|
+
config.logger
|
22
|
+
end
|
23
|
+
|
24
|
+
def redis_pool(&block)
|
25
|
+
Sidekiq.redis(&block)
|
26
|
+
end
|
27
|
+
|
28
|
+
def blackhole_add_worker(worker_name)
|
29
|
+
worker_name = class_to_str(worker_name)
|
30
|
+
|
31
|
+
redis_pool do |redis|
|
32
|
+
redis.hset(BLACKHOLE_WORKERS_KEY_NAME, worker_name, Time.now)
|
33
|
+
end
|
34
|
+
logger.warn "#{worker_name} added to blackhole workers"
|
35
|
+
end
|
36
|
+
|
37
|
+
def blackhole_remove_worker(worker_name)
|
38
|
+
worker_name = class_to_str(worker_name)
|
39
|
+
|
40
|
+
redis_pool do |redis|
|
41
|
+
redis.hdel(BLACKHOLE_WORKERS_KEY_NAME, worker_name)
|
42
|
+
end
|
43
|
+
logger.warn "#{worker_name} removed from blackhole workers"
|
44
|
+
end
|
45
|
+
|
46
|
+
def blackhole_worker?(worker_name)
|
47
|
+
redis_pool do |redis|
|
48
|
+
redis.hexists(BLACKHOLE_WORKERS_KEY_NAME, class_to_str(worker_name))
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
def blackhole_workers
|
53
|
+
redis_pool do |redis|
|
54
|
+
redis.hgetall(BLACKHOLE_WORKERS_KEY_NAME)
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
def dead_queue_add_worker(worker_name)
|
59
|
+
worker_name = class_to_str(worker_name)
|
60
|
+
|
61
|
+
redis_pool do |redis|
|
62
|
+
redis.hset(DEAD_QUEUE_WORKERS_KEY_NAME, worker_name, Time.now)
|
63
|
+
end
|
64
|
+
logger.warn "#{worker_name} added to dead queue workers"
|
65
|
+
end
|
66
|
+
|
67
|
+
def dead_queue_remove_worker(worker_name)
|
68
|
+
worker_name = class_to_str(worker_name)
|
69
|
+
|
70
|
+
redis_pool do |redis|
|
71
|
+
redis.hdel(DEAD_QUEUE_WORKERS_KEY_NAME, worker_name)
|
72
|
+
end
|
73
|
+
logger.warn "#{worker_name} removed from dead queue workers"
|
74
|
+
end
|
75
|
+
|
76
|
+
def dead_queue_worker?(worker_name)
|
77
|
+
redis_pool do |redis|
|
78
|
+
redis.hexists(DEAD_QUEUE_WORKERS_KEY_NAME, class_to_str(worker_name))
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
def dead_queue_workers
|
83
|
+
redis_pool do |redis|
|
84
|
+
redis.hgetall(DEAD_QUEUE_WORKERS_KEY_NAME)
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
def class_to_str(class_or_string)
|
89
|
+
class_or_string.is_a?(String) ? class_or_string : class_or_string.name
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|