service_skeleton 0.0.0.49.g47046b9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.editorconfig +7 -0
- data/.gitignore +9 -0
- data/.rubocop.yml +1 -0
- data/.travis.yml +11 -0
- data/.yardopts +1 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/CONTRIBUTING.md +13 -0
- data/LICENCE +674 -0
- data/README.md +767 -0
- data/lib/service_skeleton.rb +41 -0
- data/lib/service_skeleton/config.rb +133 -0
- data/lib/service_skeleton/config_class.rb +16 -0
- data/lib/service_skeleton/config_variable.rb +44 -0
- data/lib/service_skeleton/config_variable/boolean.rb +21 -0
- data/lib/service_skeleton/config_variable/enum.rb +27 -0
- data/lib/service_skeleton/config_variable/float.rb +25 -0
- data/lib/service_skeleton/config_variable/integer.rb +25 -0
- data/lib/service_skeleton/config_variable/kv_list.rb +26 -0
- data/lib/service_skeleton/config_variable/path_list.rb +13 -0
- data/lib/service_skeleton/config_variable/string.rb +18 -0
- data/lib/service_skeleton/config_variable/url.rb +36 -0
- data/lib/service_skeleton/config_variable/yaml_file.rb +42 -0
- data/lib/service_skeleton/config_variables.rb +79 -0
- data/lib/service_skeleton/error.rb +10 -0
- data/lib/service_skeleton/filtering_logger.rb +38 -0
- data/lib/service_skeleton/generator.rb +165 -0
- data/lib/service_skeleton/logging_helpers.rb +28 -0
- data/lib/service_skeleton/metric_method_name.rb +9 -0
- data/lib/service_skeleton/metrics_methods.rb +37 -0
- data/lib/service_skeleton/runner.rb +46 -0
- data/lib/service_skeleton/service_name.rb +20 -0
- data/lib/service_skeleton/signal_manager.rb +202 -0
- data/lib/service_skeleton/signals_methods.rb +15 -0
- data/lib/service_skeleton/ultravisor_children.rb +17 -0
- data/lib/service_skeleton/ultravisor_loggerstash.rb +11 -0
- data/service_skeleton.gemspec +55 -0
- metadata +356 -0
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module ServiceSkeleton
|
4
|
+
module SignalsMethods
|
5
|
+
def registered_signal_handlers
|
6
|
+
@registered_signal_handlers || []
|
7
|
+
end
|
8
|
+
|
9
|
+
def hook_signal(sigspec, &blk)
|
10
|
+
@registered_signal_handlers ||= []
|
11
|
+
|
12
|
+
@registered_signal_handlers << [sigspec, blk]
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module ServiceSkeleton
|
2
|
+
module UltravisorChildren
|
3
|
+
def register_ultravisor_children(ultravisor, config:, metrics_registry:)
|
4
|
+
begin
|
5
|
+
ultravisor.add_child(
|
6
|
+
id: self.service_name.to_sym,
|
7
|
+
klass: self,
|
8
|
+
method: :run,
|
9
|
+
args: [config: config, metrics: metrics_registry]
|
10
|
+
)
|
11
|
+
rescue Ultravisor::InvalidKAMError
|
12
|
+
raise ServiceSkeleton::Error::InvalidServiceClassError,
|
13
|
+
"Class #{self.to_s} does not implement the `run' instance method"
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
begin
|
4
|
+
require 'git-version-bump'
|
5
|
+
rescue LoadError
|
6
|
+
nil
|
7
|
+
end
|
8
|
+
|
9
|
+
Gem::Specification.new do |s|
|
10
|
+
s.name = "service_skeleton"
|
11
|
+
|
12
|
+
s.version = GVB.version rescue "0.0.0.1.NOGVB"
|
13
|
+
s.date = GVB.date rescue Time.now.strftime("%Y-%m-%d")
|
14
|
+
|
15
|
+
s.platform = Gem::Platform::RUBY
|
16
|
+
|
17
|
+
s.summary = "The bare bones of a service"
|
18
|
+
s.description = <<~EOF
|
19
|
+
When you need to write a program that provides some sort of persistent
|
20
|
+
service, there are some things you always need. Logging, metrics,
|
21
|
+
extracting configuration from the environment, signal handling, and so on.
|
22
|
+
This gem provides ServiceSkeleton, a template class you can use as a base
|
23
|
+
for your services, as well as a collection of helper classes to manage
|
24
|
+
common aspects of a system service.
|
25
|
+
EOF
|
26
|
+
|
27
|
+
s.authors = ["Matt Palmer"]
|
28
|
+
s.email = ["matt.palmer@discourse.org"]
|
29
|
+
s.homepage = "https://github.com/discourse/service_skeleton"
|
30
|
+
|
31
|
+
s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
|
32
|
+
|
33
|
+
s.required_ruby_version = ">= 2.5.0"
|
34
|
+
|
35
|
+
s.add_runtime_dependency "frankenstein", "~> 2.0"
|
36
|
+
s.add_runtime_dependency "loggerstash", ">= 0.0.9", "< 1"
|
37
|
+
s.add_runtime_dependency "prometheus-client", "~> 2.0"
|
38
|
+
s.add_runtime_dependency "sigdump", "~> 0.2"
|
39
|
+
s.add_runtime_dependency "to_regexp", "~> 0.2"
|
40
|
+
s.add_runtime_dependency "ultravisor", "~> 0.a"
|
41
|
+
|
42
|
+
s.add_development_dependency 'bundler'
|
43
|
+
s.add_development_dependency 'github-release'
|
44
|
+
s.add_development_dependency 'git-version-bump'
|
45
|
+
s.add_development_dependency 'guard-rspec'
|
46
|
+
s.add_development_dependency 'guard-rubocop'
|
47
|
+
s.add_development_dependency 'rack-test'
|
48
|
+
s.add_development_dependency 'rake', "~> 12.0"
|
49
|
+
s.add_development_dependency 'redcarpet'
|
50
|
+
s.add_development_dependency 'rspec'
|
51
|
+
s.add_development_dependency 'rubocop', "~> 0.79"
|
52
|
+
s.add_development_dependency 'rubocop-discourse'
|
53
|
+
s.add_development_dependency 'simplecov'
|
54
|
+
s.add_development_dependency 'yard'
|
55
|
+
end
|
metadata
ADDED
@@ -0,0 +1,356 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: service_skeleton
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.0.49.g47046b9
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Matt Palmer
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-07-22 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: frankenstein
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '2.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '2.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: loggerstash
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 0.0.9
|
34
|
+
- - "<"
|
35
|
+
- !ruby/object:Gem::Version
|
36
|
+
version: '1'
|
37
|
+
type: :runtime
|
38
|
+
prerelease: false
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
40
|
+
requirements:
|
41
|
+
- - ">="
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
version: 0.0.9
|
44
|
+
- - "<"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: prometheus-client
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - "~>"
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '2.0'
|
54
|
+
type: :runtime
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '2.0'
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: sigdump
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '0.2'
|
68
|
+
type: :runtime
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '0.2'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: to_regexp
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '0.2'
|
82
|
+
type: :runtime
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '0.2'
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: ultravisor
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - "~>"
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: 0.a
|
96
|
+
type: :runtime
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: 0.a
|
103
|
+
- !ruby/object:Gem::Dependency
|
104
|
+
name: bundler
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
type: :development
|
111
|
+
prerelease: false
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - ">="
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '0'
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: github-release
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - ">="
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '0'
|
124
|
+
type: :development
|
125
|
+
prerelease: false
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
127
|
+
requirements:
|
128
|
+
- - ">="
|
129
|
+
- !ruby/object:Gem::Version
|
130
|
+
version: '0'
|
131
|
+
- !ruby/object:Gem::Dependency
|
132
|
+
name: git-version-bump
|
133
|
+
requirement: !ruby/object:Gem::Requirement
|
134
|
+
requirements:
|
135
|
+
- - ">="
|
136
|
+
- !ruby/object:Gem::Version
|
137
|
+
version: '0'
|
138
|
+
type: :development
|
139
|
+
prerelease: false
|
140
|
+
version_requirements: !ruby/object:Gem::Requirement
|
141
|
+
requirements:
|
142
|
+
- - ">="
|
143
|
+
- !ruby/object:Gem::Version
|
144
|
+
version: '0'
|
145
|
+
- !ruby/object:Gem::Dependency
|
146
|
+
name: guard-rspec
|
147
|
+
requirement: !ruby/object:Gem::Requirement
|
148
|
+
requirements:
|
149
|
+
- - ">="
|
150
|
+
- !ruby/object:Gem::Version
|
151
|
+
version: '0'
|
152
|
+
type: :development
|
153
|
+
prerelease: false
|
154
|
+
version_requirements: !ruby/object:Gem::Requirement
|
155
|
+
requirements:
|
156
|
+
- - ">="
|
157
|
+
- !ruby/object:Gem::Version
|
158
|
+
version: '0'
|
159
|
+
- !ruby/object:Gem::Dependency
|
160
|
+
name: guard-rubocop
|
161
|
+
requirement: !ruby/object:Gem::Requirement
|
162
|
+
requirements:
|
163
|
+
- - ">="
|
164
|
+
- !ruby/object:Gem::Version
|
165
|
+
version: '0'
|
166
|
+
type: :development
|
167
|
+
prerelease: false
|
168
|
+
version_requirements: !ruby/object:Gem::Requirement
|
169
|
+
requirements:
|
170
|
+
- - ">="
|
171
|
+
- !ruby/object:Gem::Version
|
172
|
+
version: '0'
|
173
|
+
- !ruby/object:Gem::Dependency
|
174
|
+
name: rack-test
|
175
|
+
requirement: !ruby/object:Gem::Requirement
|
176
|
+
requirements:
|
177
|
+
- - ">="
|
178
|
+
- !ruby/object:Gem::Version
|
179
|
+
version: '0'
|
180
|
+
type: :development
|
181
|
+
prerelease: false
|
182
|
+
version_requirements: !ruby/object:Gem::Requirement
|
183
|
+
requirements:
|
184
|
+
- - ">="
|
185
|
+
- !ruby/object:Gem::Version
|
186
|
+
version: '0'
|
187
|
+
- !ruby/object:Gem::Dependency
|
188
|
+
name: rake
|
189
|
+
requirement: !ruby/object:Gem::Requirement
|
190
|
+
requirements:
|
191
|
+
- - "~>"
|
192
|
+
- !ruby/object:Gem::Version
|
193
|
+
version: '12.0'
|
194
|
+
type: :development
|
195
|
+
prerelease: false
|
196
|
+
version_requirements: !ruby/object:Gem::Requirement
|
197
|
+
requirements:
|
198
|
+
- - "~>"
|
199
|
+
- !ruby/object:Gem::Version
|
200
|
+
version: '12.0'
|
201
|
+
- !ruby/object:Gem::Dependency
|
202
|
+
name: redcarpet
|
203
|
+
requirement: !ruby/object:Gem::Requirement
|
204
|
+
requirements:
|
205
|
+
- - ">="
|
206
|
+
- !ruby/object:Gem::Version
|
207
|
+
version: '0'
|
208
|
+
type: :development
|
209
|
+
prerelease: false
|
210
|
+
version_requirements: !ruby/object:Gem::Requirement
|
211
|
+
requirements:
|
212
|
+
- - ">="
|
213
|
+
- !ruby/object:Gem::Version
|
214
|
+
version: '0'
|
215
|
+
- !ruby/object:Gem::Dependency
|
216
|
+
name: rspec
|
217
|
+
requirement: !ruby/object:Gem::Requirement
|
218
|
+
requirements:
|
219
|
+
- - ">="
|
220
|
+
- !ruby/object:Gem::Version
|
221
|
+
version: '0'
|
222
|
+
type: :development
|
223
|
+
prerelease: false
|
224
|
+
version_requirements: !ruby/object:Gem::Requirement
|
225
|
+
requirements:
|
226
|
+
- - ">="
|
227
|
+
- !ruby/object:Gem::Version
|
228
|
+
version: '0'
|
229
|
+
- !ruby/object:Gem::Dependency
|
230
|
+
name: rubocop
|
231
|
+
requirement: !ruby/object:Gem::Requirement
|
232
|
+
requirements:
|
233
|
+
- - "~>"
|
234
|
+
- !ruby/object:Gem::Version
|
235
|
+
version: '0.79'
|
236
|
+
type: :development
|
237
|
+
prerelease: false
|
238
|
+
version_requirements: !ruby/object:Gem::Requirement
|
239
|
+
requirements:
|
240
|
+
- - "~>"
|
241
|
+
- !ruby/object:Gem::Version
|
242
|
+
version: '0.79'
|
243
|
+
- !ruby/object:Gem::Dependency
|
244
|
+
name: rubocop-discourse
|
245
|
+
requirement: !ruby/object:Gem::Requirement
|
246
|
+
requirements:
|
247
|
+
- - ">="
|
248
|
+
- !ruby/object:Gem::Version
|
249
|
+
version: '0'
|
250
|
+
type: :development
|
251
|
+
prerelease: false
|
252
|
+
version_requirements: !ruby/object:Gem::Requirement
|
253
|
+
requirements:
|
254
|
+
- - ">="
|
255
|
+
- !ruby/object:Gem::Version
|
256
|
+
version: '0'
|
257
|
+
- !ruby/object:Gem::Dependency
|
258
|
+
name: simplecov
|
259
|
+
requirement: !ruby/object:Gem::Requirement
|
260
|
+
requirements:
|
261
|
+
- - ">="
|
262
|
+
- !ruby/object:Gem::Version
|
263
|
+
version: '0'
|
264
|
+
type: :development
|
265
|
+
prerelease: false
|
266
|
+
version_requirements: !ruby/object:Gem::Requirement
|
267
|
+
requirements:
|
268
|
+
- - ">="
|
269
|
+
- !ruby/object:Gem::Version
|
270
|
+
version: '0'
|
271
|
+
- !ruby/object:Gem::Dependency
|
272
|
+
name: yard
|
273
|
+
requirement: !ruby/object:Gem::Requirement
|
274
|
+
requirements:
|
275
|
+
- - ">="
|
276
|
+
- !ruby/object:Gem::Version
|
277
|
+
version: '0'
|
278
|
+
type: :development
|
279
|
+
prerelease: false
|
280
|
+
version_requirements: !ruby/object:Gem::Requirement
|
281
|
+
requirements:
|
282
|
+
- - ">="
|
283
|
+
- !ruby/object:Gem::Version
|
284
|
+
version: '0'
|
285
|
+
description: |
|
286
|
+
When you need to write a program that provides some sort of persistent
|
287
|
+
service, there are some things you always need. Logging, metrics,
|
288
|
+
extracting configuration from the environment, signal handling, and so on.
|
289
|
+
This gem provides ServiceSkeleton, a template class you can use as a base
|
290
|
+
for your services, as well as a collection of helper classes to manage
|
291
|
+
common aspects of a system service.
|
292
|
+
email:
|
293
|
+
- matt.palmer@discourse.org
|
294
|
+
executables: []
|
295
|
+
extensions: []
|
296
|
+
extra_rdoc_files: []
|
297
|
+
files:
|
298
|
+
- ".editorconfig"
|
299
|
+
- ".gitignore"
|
300
|
+
- ".rubocop.yml"
|
301
|
+
- ".travis.yml"
|
302
|
+
- ".yardopts"
|
303
|
+
- CODE_OF_CONDUCT.md
|
304
|
+
- CONTRIBUTING.md
|
305
|
+
- LICENCE
|
306
|
+
- README.md
|
307
|
+
- lib/service_skeleton.rb
|
308
|
+
- lib/service_skeleton/config.rb
|
309
|
+
- lib/service_skeleton/config_class.rb
|
310
|
+
- lib/service_skeleton/config_variable.rb
|
311
|
+
- lib/service_skeleton/config_variable/boolean.rb
|
312
|
+
- lib/service_skeleton/config_variable/enum.rb
|
313
|
+
- lib/service_skeleton/config_variable/float.rb
|
314
|
+
- lib/service_skeleton/config_variable/integer.rb
|
315
|
+
- lib/service_skeleton/config_variable/kv_list.rb
|
316
|
+
- lib/service_skeleton/config_variable/path_list.rb
|
317
|
+
- lib/service_skeleton/config_variable/string.rb
|
318
|
+
- lib/service_skeleton/config_variable/url.rb
|
319
|
+
- lib/service_skeleton/config_variable/yaml_file.rb
|
320
|
+
- lib/service_skeleton/config_variables.rb
|
321
|
+
- lib/service_skeleton/error.rb
|
322
|
+
- lib/service_skeleton/filtering_logger.rb
|
323
|
+
- lib/service_skeleton/generator.rb
|
324
|
+
- lib/service_skeleton/logging_helpers.rb
|
325
|
+
- lib/service_skeleton/metric_method_name.rb
|
326
|
+
- lib/service_skeleton/metrics_methods.rb
|
327
|
+
- lib/service_skeleton/runner.rb
|
328
|
+
- lib/service_skeleton/service_name.rb
|
329
|
+
- lib/service_skeleton/signal_manager.rb
|
330
|
+
- lib/service_skeleton/signals_methods.rb
|
331
|
+
- lib/service_skeleton/ultravisor_children.rb
|
332
|
+
- lib/service_skeleton/ultravisor_loggerstash.rb
|
333
|
+
- service_skeleton.gemspec
|
334
|
+
homepage: https://github.com/discourse/service_skeleton
|
335
|
+
licenses: []
|
336
|
+
metadata: {}
|
337
|
+
post_install_message:
|
338
|
+
rdoc_options: []
|
339
|
+
require_paths:
|
340
|
+
- lib
|
341
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
342
|
+
requirements:
|
343
|
+
- - ">="
|
344
|
+
- !ruby/object:Gem::Version
|
345
|
+
version: 2.5.0
|
346
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
347
|
+
requirements:
|
348
|
+
- - ">"
|
349
|
+
- !ruby/object:Gem::Version
|
350
|
+
version: 1.3.1
|
351
|
+
requirements: []
|
352
|
+
rubygems_version: 3.0.3
|
353
|
+
signing_key:
|
354
|
+
specification_version: 4
|
355
|
+
summary: The bare bones of a service
|
356
|
+
test_files: []
|