adept_scale_active_job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4e3a36d958c31232ac69c135b4501541914b997
+  data.tar.gz: cf5a7f10fe02baef20f99764331923f500e4574c
+SHA512:
+  metadata.gz: 126c6a0f26c6206a40a276ee0cebddb82d10f824e5f6cfd26c15ff1c56726aaf1fe4ed41286ef92ceac34a152d60e20eb118515a9e4ac376158e83b9c21a671f
+  data.tar.gz: c1f5aea8cf560365c0a95a51b05d1006b0ff39ba3eb1ea96ed78005754d1de31eff8acc8f47b1f0a771a92fff0b7a2565621dc0a68b62c787fed9db358158c91

data/LICENSE

@@ -0,0 +1,3 @@
+Copyright 2018 AdeptLabs INC, All rights reserved.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# AdeptScaleActiveJob
+Short description and motivation.
+
+## Usage
+This plugin extends the `ActiveJob::Base` class in order to insert ADEPT_SCALE tagged logs into your app's STDOUT. The tags include ```['JOB_QUEUED', 'JOB_STARTING', 'JOB_STATUS', 'JOB_COMPLETE', 'JOB_FAILED']``` and are used by AdeptScale to keep the current state of your job queue for the purpose of scaling worker dynos.
+More explanation of how these work can be found on our [Documentation](https://devcenter.heroku.com/articles/adept-scale)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adept_scale_active_job'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install adept_scale_active_job
+```
+
+## Configuration
+
+### Inherit Job Model from AdeptScaleActiveJob
+After installation, change any ActiveJob based object to inherit from ```AdeptScaleActiveJob::Base``` instead of the default ```AdeptScaleActiveJob::Base```.
+For example, the simplest method would be at the ApplicationJob level:
+```
+# /app/jobs/applicaiton_job.rb
+
+class ApplicationJob < AdeptScaleActiveJob::Base
+end
+```
+
+### Procfile
+In delivered form this gem assumes that the job queue has the same name as the dyno it runs on. If this is not the case, you will need to make necessary changes to support your particular use case.
+Future plans include adding support for a procfile where you can define a mapping between queue names and which dyno types they run on. Contributions in this regard are greatly welcome.
+
+## Contribution
+
+We encourage all contributors and love to hear your feedback. Hopefully this will be a bare-bones example for similar plugins in other languages.
+
+## License
+Copyright 2018 AdeptLabs INC, All rights reserved.
+
+

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AdeptScaleActiveJob'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/adept_scale_active_job.rb

@@ -0,0 +1,50 @@
+module AdeptScaleActiveJob 
+	class Base < ActiveJob::Base
+		rescue_from Exception, :with => :log_exception
+
+		def adept_scale_logger
+			@@adept_scale_logger ||= Logger.new(STDOUT)
+		end
+
+		#@param BasicProcessJob | [@job_id, @queue_name, @priority, @executions, @scheduled_at, @provider_job_id]
+		after_enqueue do |job|
+			#NOTE: For this basic-use gem we will assume the queue_name is also the dyno type.
+			#TODO: either figure out how to obtain the queue_name->dyno_type mapping from config, or build an initializer for the user to set it themselves
+			job_params = {:dyno_type => job.queue_name, :scheduled_at => job.scheduled_at}
+			adept_scale_logger.add(6, "ADEPT_SCALE JOB_QUEUED #{format_params job_params}")
+		end
+
+		#@param BasicProcessJob | [@job_id, @queue_name, @priority, @executions, @provider_job_id]
+		before_perform do |job|
+			job_params = {:job_id => job.provider_job_id}
+			adept_scale_logger.add(6, "ADEPT_SCALE JOB_STARTING #{format_params job_params}")
+		end
+
+		#@param BasicProcessJob | [@job_id, @queue_name, @priority, @executions, @provider_job_id]
+		after_perform do |job|
+			job_params = {:job_id => job.provider_job_id}
+			adept_scale_logger.add(6, "ADEPT_SCALE JOB_COMPLETE #{format_params job_params}")
+		end
+
+	private
+		#Catch all Object level base Exceptions, if we can, so we can remove them from the running process list
+		def log_exception e
+			#Don't log the exception to Adept, this is the clients' private business.
+			adept_scale_logger.add(6, "ADEPT_SCALE JOB_FAILED")
+			#reraise so as to hopefully not interefere with other error handling
+			raise e
+		end
+
+		#@param BasicProcessJob | [@job_id, @queue_name, @priority, @executions, @scheduled_at, @provider_job_id]
+		#ie. #<BasicProcessJob:0x00007fd0218ab3a0 @arguments=[30], @job_id="4970c4ee-67b7-4cf6-9519-f1bc4513fa4b", @queue_name="worker", @priority=nil, @executions=0, @scheduled_at=1525461719.492488, @provider_job_id="1da86e157a6cd6dc21791b38">
+		#@param Hash | a key/value hash of our params.
+		def format_params job_params
+			#Only allow these params to be stringified
+			params = [:dyno_type, :job_id, :scheduled_at, :scheduled_at, :total_queue, :running_jobs]
+			params.reduce([]) do |ary, param|
+				ary << "#{param}=#{job_params[param]}" if job_params.has_key?(param)
+				ary
+			end.join(' ')
+		end
+	end
+end

data/lib/adept_scale_active_job/version.rb

@@ -0,0 +1,3 @@
+module AdeptScaleActiveJob
+	VERSION = '0.1.0'
+end

data/lib/tasks/adept_scale_active_job_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :adept_scale_active_job do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: adept_scale_active_job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Burnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for ActiveJob to provide tags to STDOUT for use with AdeptScale
+  worker scaling.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/adept_scale_active_job/version.rb
+- lib/adept_scale_active_job.rb
+- lib/tasks/adept_scale_active_job_tasks.rake
+- LICENSE
+- Rakefile
+- README.md
+homepage: http://adeptscale.com
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: ActiveJob wrapper for AdeptScale
+test_files: []