bluepill 0.1.6 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +50 -1
  3. data/CONTRIBUTING.md +2 -2
  4. data/README.md +105 -8
  5. data/bin/bluepill +25 -30
  6. data/bluepill.gemspec +21 -28
  7. data/lib/bluepill/application/lifecycle.rb +166 -0
  8. data/lib/bluepill/application/listener.rb +124 -0
  9. data/lib/bluepill/application/previous_daemon.rb +81 -0
  10. data/lib/bluepill/application.rb +57 -254
  11. data/lib/bluepill/base_directory.rb +93 -0
  12. data/lib/bluepill/condition_watch.rb +134 -56
  13. data/lib/bluepill/controller/directory.rb +59 -0
  14. data/lib/bluepill/controller.rb +99 -94
  15. data/lib/bluepill/daemonize.rb +234 -0
  16. data/lib/bluepill/dsl/app_proxy.rb +30 -6
  17. data/lib/bluepill/dsl/process_factory/children.rb +71 -0
  18. data/lib/bluepill/dsl/process_factory/registry.rb +69 -0
  19. data/lib/bluepill/dsl/process_factory.rb +81 -92
  20. data/lib/bluepill/dsl/process_proxy.rb +109 -21
  21. data/lib/bluepill/group.rb +187 -78
  22. data/lib/bluepill/logger.rb +139 -48
  23. data/lib/bluepill/pid_file.rb +23 -0
  24. data/lib/bluepill/process/attributes.rb +379 -0
  25. data/lib/bluepill/process/children.rb +70 -0
  26. data/lib/bluepill/process/pid.rb +154 -0
  27. data/lib/bluepill/process/state_machine.rb +196 -0
  28. data/lib/bluepill/process/transition.rb +45 -0
  29. data/lib/bluepill/process/transition_callbacks.rb +101 -0
  30. data/lib/bluepill/process/user_commands.rb +71 -0
  31. data/lib/bluepill/process/watches.rb +141 -0
  32. data/lib/bluepill/process.rb +56 -653
  33. data/lib/bluepill/process_commands/execution.rb +89 -0
  34. data/lib/bluepill/process_commands/hooks.rb +186 -0
  35. data/lib/bluepill/process_commands/stop_signals.rb +114 -0
  36. data/lib/bluepill/process_commands.rb +104 -172
  37. data/lib/bluepill/process_conditions/always_true.rb +1 -1
  38. data/lib/bluepill/process_conditions/below_threshold.rb +36 -0
  39. data/lib/bluepill/process_conditions/cpu_usage.rb +1 -25
  40. data/lib/bluepill/process_conditions/file_time.rb +4 -5
  41. data/lib/bluepill/process_conditions/http.rb +52 -24
  42. data/lib/bluepill/process_conditions/mem_usage.rb +9 -22
  43. data/lib/bluepill/process_conditions/process_condition.rb +34 -3
  44. data/lib/bluepill/process_conditions/running_time.rb +1 -25
  45. data/lib/bluepill/process_conditions/zombie_process.rb +1 -1
  46. data/lib/bluepill/process_conditions.rb +3 -2
  47. data/lib/bluepill/process_journal/cleanup.rb +200 -0
  48. data/lib/bluepill/process_journal/lock.rb +106 -0
  49. data/lib/bluepill/process_journal.rb +126 -233
  50. data/lib/bluepill/process_statistics.rb +2 -2
  51. data/lib/bluepill/socket.rb +60 -20
  52. data/lib/bluepill/system/command_setup.rb +98 -0
  53. data/lib/bluepill/system/commands.rb +219 -248
  54. data/lib/bluepill/system/daemon.rb +161 -0
  55. data/lib/bluepill/system/ps.rb +85 -0
  56. data/lib/bluepill/system/ps_table.rb +163 -0
  57. data/lib/bluepill/system.rb +45 -126
  58. data/lib/bluepill/trigger.rb +52 -26
  59. data/lib/bluepill/triggers/flapping.rb +7 -15
  60. data/lib/bluepill/units.rb +126 -0
  61. data/lib/bluepill/util/inflections.rb +34 -0
  62. data/lib/bluepill/util/levenshtein.rb +53 -0
  63. data/lib/bluepill/util/rotational_array.rb +1 -1
  64. data/lib/bluepill/version.rb +13 -12
  65. data/lib/bluepill.rb +33 -36
  66. data/sig/bluepill/application.rbs +257 -0
  67. data/sig/bluepill/checks.rbs +203 -0
  68. data/sig/bluepill/dsl.rbs +126 -0
  69. data/sig/bluepill/logger.rbs +104 -0
  70. data/sig/bluepill/process.rbs +542 -0
  71. data/sig/bluepill/system.rbs +316 -0
  72. data/sig/bluepill.rbs +47 -873
  73. metadata +39 -45
@@ -0,0 +1,316 @@
1
+ module Bluepill
2
+ # The parts of the daemons gem that bluepill uses
3
+ module Daemonize
4
+ class Error < RuntimeError
5
+ end
6
+
7
+ MAX_FD: Integer
8
+
9
+ def self.safefork: () -> Integer?
10
+
11
+ def self.call_as_daemon: (^() -> void block, ?String? name) -> Integer
12
+
13
+ def self.read_daemon_pid: (Integer intermediate, IO reader, IO writer) -> Integer
14
+
15
+ def self.run_daemon: (^() -> void block, String? name, IO writer) -> bot
16
+
17
+ def self.daemonize: () -> Integer
18
+
19
+ def self.detach: () -> Integer
20
+
21
+ def self.become_daemon: (?String? name) -> void
22
+
23
+ def self.close_io: () -> void
24
+
25
+ def self.close_fds: () -> void
26
+
27
+ def self.redirect_io: () -> void
28
+
29
+ def self.quietly: () { () -> void } -> void
30
+ end
31
+
32
+ # Memoizes ps output for a tick, and runs commands as daemons or until
33
+ # they finish
34
+ module System
35
+ extend Ps
36
+ extend Commands
37
+ extend Daemon
38
+
39
+ # Options for daemonize and execute_blocking
40
+ type command_options = {
41
+ ?uid: String?,
42
+ ?gid: String?,
43
+ ?working_dir: String?,
44
+ ?environment: Hash[_ToS, _ToS]?,
45
+ ?pid_file: String?,
46
+ ?logger: Logger,
47
+ ?stdin: String?,
48
+ # Hooks are killed after this many seconds
49
+ ?timeout: seconds,
50
+ ?stdout: String?,
51
+ ?stderr: String?,
52
+ ?supplementary_groups: Array[String]?
53
+ }
54
+
55
+ type blocking_result = { exit_code: Integer?, stdout: String, stderr: String }
56
+
57
+ type grandchild_pipes = { out: [IO, IO], err: [IO, IO], result: IO }
58
+
59
+ APPEND_MODE: String
60
+
61
+ PS_MUTEX: Thread::Mutex
62
+
63
+ NO_PIDS: Array[Integer]
64
+
65
+ # Raised when ps could not be run, so there is no data for this tick
66
+ class PsError < StandardError
67
+ end
68
+
69
+ # A tick's table of processes, as ps listed them
70
+ class PsTable
71
+ PID: Integer
72
+ PPID: Integer
73
+ PCPU: Integer
74
+ RSS: Integer
75
+ ETIME: Integer
76
+ COMMAND: Integer
77
+
78
+ @rows: Hash[Integer, Array[String]]
79
+ @children_by_parent: Hash[Integer, Array[Integer]]?
80
+
81
+ def self.parse: (String output) -> PsTable
82
+
83
+ attr_reader rows: Hash[Integer, Array[String]]
84
+
85
+ def initialize: (Hash[Integer, Array[String]] rows) -> void
86
+
87
+ def row: (Integer? pid) -> Array[String]?
88
+
89
+ def children: (Integer? pid) -> Array[Integer]
90
+
91
+ # The pid must be above 0
92
+ def descendants: (Integer? pid) -> Array[Integer]
93
+
94
+ # Adds the column to total, which starts at 0.0
95
+ def sum: (Array[Integer] pids, Integer column, ?Float total) -> Float
96
+
97
+ private
98
+
99
+ def children_by_parent: () -> Hash[Integer, Array[Integer]]
100
+ end
101
+
102
+ # Runs ps once a tick, and reads its table of processes
103
+ module Ps
104
+ # The store lives on System, which extends this module
105
+ @store: Hash[Symbol, PsTable | String]
106
+ # The table get_children read this tick
107
+ @children_table: PsTable?
108
+
109
+ def store: () -> Hash[Symbol, PsTable | String]
110
+
111
+ def reset_data: () -> void
112
+
113
+ def ps_axu: () -> PsTable
114
+
115
+ def read_ps_table: () -> (PsTable | String)
116
+
117
+ def get_children: (Integer? parent_pid) -> Array[Integer]
118
+ end
119
+
120
+ def self.pid_alive?: (Integer pid) -> bool
121
+
122
+ def self.started_at: (Integer pid) -> Integer?
123
+
124
+ def self.boot_time: () -> Integer?
125
+
126
+ def self.cpu_usage: (Integer? pid, boolish include_children) -> Float?
127
+
128
+ def self.memory_usage: (Integer? pid, boolish include_children) -> Float?
129
+
130
+ def self.usage: (Integer? pid, boolish include_children, Integer column) -> Float?
131
+
132
+ def self.running_time: (Integer? pid) -> Integer?
133
+
134
+ def self.command: (Integer? pid) -> String?
135
+
136
+ def self.delete_if_exists: (String? filename) -> void
137
+
138
+ def self.parse_elapsed_time: (String? str) -> Integer
139
+
140
+ # Sets up the process that a command runs in
141
+ module CommandSetup
142
+ def setup_command_environment: (command_options options) -> void
143
+
144
+ def drop_privileges: (String? uid, String? gid, Array[String]? supplementary_groups) -> void
145
+
146
+ def join_groups: (Etc::Passwd? user, Integer? gid_num) -> Integer?
147
+
148
+ def add_supplementary_groups: (Array[String]? supplementary_groups) -> void
149
+
150
+ def switch_to_user: (Etc::Passwd user) -> void
151
+ end
152
+
153
+ # Runs commands in the background, as daemons
154
+ module Daemon
155
+ include CommandSetup
156
+
157
+ # Returns the daemon's pid
158
+ def daemonize: (String cmd, ?command_options options) -> Integer?
159
+
160
+ def read_daemon_pid: (IO reader, IO writer) -> Integer?
161
+
162
+ def start_daemon: (String cmd, command_options options, IO pid_pipe) -> bot
163
+
164
+ def daemon_command: (String cmd, command_options options) -> ^() -> void
165
+
166
+ def can_write_pid_file: (String pid_file, Logger logger) -> bool
167
+
168
+ def redirect_io: (String? io_in, String? io_out, String? io_err) -> void
169
+ end
170
+
171
+ # Runs commands until they finish
172
+ module Commands
173
+ include CommandSetup
174
+
175
+ def execute_blocking: (String cmd, ?command_options options) -> blocking_result
176
+
177
+ def start_blocking_child: (String cmd, command_options options, IO reader, IO result_pipe) -> bot
178
+
179
+ def read_blocking_status: (String cmd, seconds? timeout, Integer child, IO reader) -> String
180
+
181
+ def kill_group_after: (Integer child, seconds? timeout, String cmd) -> bot
182
+
183
+ def run_blocking_child: (String cmd, command_options options, IO result_pipe) -> bot
184
+
185
+ def collect_blocking_result: (Integer pid, IO cmd_out_read, IO cmd_err_read) -> blocking_result
186
+
187
+ def report_blocking_result: (IO result_pipe, blocking_result result) -> bot
188
+
189
+ def exec_blocking_grandchild: (String cmd, command_options options, grandchild_pipes pipes) -> bot
190
+
191
+ def reopen_on_pipe: (IO stream, [IO, IO] pipe) -> void
192
+
193
+ def report_grandchild_error: (Exception error, grandchild_pipes pipes) -> bot
194
+ end
195
+ end
196
+
197
+ # Remembers the pids and process groups of the processes bluepill starts,
198
+ # so it can kill any left over from an earlier run
199
+ module ProcessJournal
200
+ extend Cleanup
201
+ extend Lock
202
+
203
+ # What a journal holds: pids, or process group ids
204
+ class Kind < Struct[String | Integer]
205
+ attr_accessor name: String
206
+ attr_accessor label: String
207
+ attr_accessor file_tag: String
208
+ attr_accessor sign: Integer
209
+
210
+ def self.new: (String name, String label, String file_tag, Integer sign) -> Kind
211
+ end
212
+
213
+ PID: Kind
214
+
215
+ PGID: Kind
216
+
217
+ # What the modules that ProcessJournal extends use from it
218
+ interface _Journal
219
+ def logger: () -> Logger
220
+
221
+ def journal_base_dir: () -> String
222
+
223
+ def legacy_journal_dir: () -> String
224
+
225
+ def journal_filename: (Kind kind, String journal_name, ?String dir) -> String
226
+
227
+ def journal_entries: (String filename) -> Array[[Integer, Integer?]]
228
+
229
+ def journal_ids: (Kind kind, String filename) -> Array[Integer]
230
+ end
231
+
232
+ # Kills what an earlier run left in a process's journals
233
+ module Cleanup : _Journal, Lock
234
+ def kill_all_from_journal: (String journal_name) -> void
235
+
236
+ def kill_all_pgids_from_journal: (String journal_name) -> void
237
+
238
+ def kill_all_pids_from_journal: (String journal_name) -> void
239
+
240
+ def kill_all_ids_from_journal: (Kind kind, String journal_name) -> void
241
+
242
+ def journal_dirs: () -> Array[String]
243
+
244
+ def kill_all_from_journal_file: (String filename, Array[Integer] ids, Kind kind) -> void
245
+
246
+ def term_then_kill_journaled: (Array[Integer] ids, Kind kind) -> void
247
+
248
+ def journaled_ids: (String filename, Array[Integer] ids, Kind kind) -> Array[Integer]
249
+
250
+ def same_journaled_process?: (Integer id, Integer? journaled, Integer? boot, Integer written) -> bool
251
+
252
+ def signal_journaled: (String signal, Array[Integer] ids, Kind kind) -> void
253
+ end
254
+
255
+ # Locks a journal while bluepill reads and writes it
256
+ module Lock : _Journal
257
+ def acquire_atomic_fs_lock: [T] (String name) { () -> T } -> T
258
+
259
+ def clear_all_atomic_fs_locks: () -> void
260
+
261
+ def clear_atomic_fs_lock: (String name) -> void
262
+
263
+ def make_atomic_fs_lock: (String lock) -> void
264
+
265
+ def wait_for_atomic_fs_lock: (String lock, Integer attempts) -> void
266
+ end
267
+
268
+ self.@logger: Logger
269
+ self.@journal_base_dir: String
270
+ self.@legacy_journal_dir: String
271
+
272
+ def self.logger: () -> Logger
273
+
274
+ def self.journal_base_dir: () -> String
275
+
276
+ def self.legacy_journal_dir: () -> String
277
+
278
+ # Only the first logger is kept
279
+ def self.logger=: (Logger new_logger) -> Logger
280
+
281
+ def self.setup: (String base_dir, _ToS app_name) -> void
282
+
283
+ def self.skip_pid?: (Integer? pid) -> bool
284
+
285
+ def self.skip_pgid?: (Integer? pgid) -> bool
286
+
287
+ def self.skip_id?: (Integer? id) -> bool
288
+
289
+ def self.pid_journal_filename: (String journal_name, ?String dir) -> String
290
+
291
+ def self.pgid_journal_filename: (String journal_name, ?String dir) -> String
292
+
293
+ def self.journal_filename: (Kind kind, String journal_name, ?String dir) -> String
294
+
295
+ # Each id, with when its process started (nil before 0.2)
296
+ def self.journal_entries: (String filename) -> Array[[Integer, Integer?]]
297
+
298
+ def self.journal_line: (Integer id) -> String
299
+
300
+ def self.pid_journal: (String filename) -> Array[Integer]
301
+
302
+ def self.pgid_journal: (String filename) -> Array[Integer]
303
+
304
+ def self.journal_ids: (Kind kind, String filename) -> Array[Integer]
305
+
306
+ def self.append_pgid_to_journal: (String journal_name, Integer? pgid) -> void
307
+
308
+ def self.append_pid_to_journal: (String journal_name, Integer? pid) -> void
309
+
310
+ def self.append_process_group_to_journal: (String journal_name, Integer pid) -> void
311
+
312
+ def self.append_to_journal: (Kind kind, String journal_name, Integer? id) ?{ (Integer id) -> void } -> void
313
+
314
+ def self.write_to_journal: (String filename, String journal_name, String name, Integer id) { () -> Array[Integer] } -> void
315
+ end
316
+ end