chequeo 0.2.0.beta → 0.2.1.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 170c778706448e9be5cb4c364a0e74a2daeb35cb
-  data.tar.gz: 469cd91e6a037e35287a4884d11f04c67f3f21ef
+  metadata.gz: bfd2fc040568a3d2ae75fc6aa67855e153ab2c67
+  data.tar.gz: ba2a716587283238846b140bb89a1d2098f4cfb9
 SHA512:
-  metadata.gz: a87218a7eae2d41ec696676115a930a932cc49d3938d114f93113e9f1f8af49c5a0f0c3e7dd0936c205c8fabab3d0e941b21115aabbc411973653b6c4e26139a
-  data.tar.gz: 27e7c79fdfd7b9025f2a832c890c685c55afbeb6cf9cb83975e0724c4ec69603395864ac4523466c96b33e9a5086fc22128b73d0ea634253f01cd41f580e2871
+  metadata.gz: f7ed410b34dc40dcf933cf10927e8e0131b03c220ce179116cedc9789366fb510e4d9c1774c4f770b941fa5a80825124f24fa401a52d5de4367e57776fd3617e
+  data.tar.gz: f3da80b9c0b61e4dab56d1e68b1db76c1e0d6e8321b820fc1c357632d46bd70646e094d11994bdba120999f1f8afb7e10cdbabf5a01eb4d52ab2aeda52cf2c01

data/README.md

@@ -1,4 +1,5 @@
-# chequeo
+# chequeo 
+*Spanish for Check Ups!*
 
 Chequeo provides a framework for running checkups on your application. The goal of checkups is to detect problems in your application and take actions to alert or repair  the issue.
 
@@ -14,7 +15,7 @@ After struggeling internally to deal with building health checks into our system
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'galactic-senate'
+gem 'chequeo'
 ```
 
 And then execute:
@@ -23,7 +24,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install galactic-senate
+    $ gem install chequeo
     
 Generate a config file into your initializers directory.
 
@@ -34,5 +35,43 @@ In order to run the checkups we need a processor. Currently we have a standalone
 
 #### Standalone
 
- 
+You can start the daemon by running `chequeo`. This works well locally but we suggest running it using SystemD or another method to run and fork the process in the background and ensure it is running.
+
+We have an example SystemD script in `examples`.
+
+### Jobs
+*Generator coming soon!*
+#### Creating Jobs
+In your models directory simply create a model file, say my_cool_new_checkup.rb and add the following into that file
+
+```ruby
+# frozen_string_literal: true
+class MyCoolNewCheckup < Chequeo::HealthChecks::Base
+
+  def process
+
+  end
+
+end
+```
+To implement your custom Job you will simply add code into the process method. In order to report back status there are several varaibale you can use to send back status to the worker. For example to send **errors** back to the worker simply add `@errors << "My error message I would like to include"`. And to pass **warnings** back to the worker you can add `@warnings << "Your warning message goes here"`. You can also add some text to the completion message by setting `@completion_text = "My Text"`. This allows you to send data to the notifications without having to do anything complex. On completion the worker will send any notifications based on the notifications setup and the state of the job.
+
+**Note:** In the future we will probably add helper methods vs directly accessing the variables to modify the actions and data sent through the notifications.
+
+#### Scheduling Jobs
+To schedule your job to run, you simply need to call `.schedule` in your initiailizer's configuration block. This is ment to mimic the job scheduling you are probably used to from Sidekiq or Resque. 
+
+```ruby
+Chequeo.configure do |config|
+    config.schedule('*/1 * * * *', MyCoolNewCheckup)
+end
+```
+
+You can also pass parameters by adding a 3rd parameter to your schedule method call. For example if you want to override the `on_completion` rule set by either the default, or your notification block you can specify this in the options hash of the job scheduling.
+
+```ruby
+Chequeo.configure do |config|
+    config.schedule('*/1 * * * *', MyCoolNewCheckup, {rules: { on_completion: false } })
+end
+```
 

data/examples/chequeo.systemd.service

@@ -0,0 +1,27 @@
+
+[Unit]
+Description=Chequeo Service
+Documentation=https://github.com/jdejong/chequeo
+After=syslog.target network.target
+
+[Service]
+Type=simple
+User=ubuntu
+
+RestartSec=1
+Restart=on-failure
+
+LimitNOFILE=infinity
+LimitNPROC=infinity
+LimitCORE=infinity
+
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=chequeo
+
+WorkingDirectory=/<YOUR_PROJECT_CODE_PATH>/current
+ExecStart=/home/ubuntu/.rvm/gems/ruby-2.4.3/wrappers/bundle exec chequeo
+
+
+[Install]
+WantedBy=multi-user.target

data/lib/chequeo.rb

@@ -20,6 +20,7 @@ module Chequeo
 end
 
 require 'chequeo/configuration'
+require 'chequeo/version'
 
 require 'chequeo/processor'
 require 'chequeo/scheduler'

data/lib/chequeo/cli.rb

@@ -35,8 +35,6 @@ module Chequeo
             Rails.logger.warn "Thread TID-#{(thread.object_id ^ ::Process.pid).to_s(36)}"
             if thread.backtrace
               Rails.logger.warn thread.backtrace.join("\n")
-            else
-              Rails.logger.warn "<no backtrace available>"
             end
           end
         },
@@ -94,9 +92,7 @@ module Chequeo
         end
       rescue Interrupt
         Rails.logger.info 'Shutting down'
-        #launcher.stop
 
-        Rails.logger.info "Bye!"
         exit(0)
       end
 
@@ -117,7 +113,6 @@ module Chequeo
     def setup_options(args)
       opts = parse_options(args)
 
-
       options.merge!(opts)
     end
 
@@ -133,26 +128,10 @@ module Chequeo
           opts[:daemon] = arg
         end
 
-        args.on '-e', '--environment ENV', "Application environment" do |arg|
-          opts[:environment] = arg
-        end
-
         args.on "-v", "--verbose", "Print more verbose output" do |arg|
           opts[:verbose] = arg
         end
 
-        args.on '-C', '--config PATH', "path to YAML config file" do |arg|
-          opts[:config_file] = arg
-        end
-
-        args.on '-L', '--logfile PATH', "path to writable logfile" do |arg|
-          opts[:logfile] = arg
-        end
-
-        args.on '-P', '--pidfile PATH', "path to pidfile" do |arg|
-          opts[:pidfile] = arg
-        end
-
         args.on '-V', '--version', "Print version and exit" do |arg|
           puts "Chequeo #{Chequeo::VERSION}"
           exit(0)
@@ -164,7 +143,6 @@ module Chequeo
       opts
     end
 
-
     def require_system
       ENV['RACK_ENV'] = ENV['RAILS_ENV']
 

data/lib/chequeo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chequeo
-  VERSION = "0.2.0.beta"
+  VERSION = "0.2.1.beta"
 end

data/lib/generators/chequeo/templates/initializer.rb

@@ -1,3 +1,27 @@
 Chequeo.configure do |config|
+  #
+  #
   # config.logger = Rails.logger
+  #
+  # config.logger.level = Logger::DEBUG
+  #
+  # config.redis = Redis.current
+  #
+  # config.schedule('*/5 * * * *', Chequeo::HealthChecks::TestCheck)
+  #
+  # config.add_notification(Chequeo::Notifications::Slack, {},
+  #                              {
+  #                                  token: "TOKEN",
+  #                                  channel: "CHANNEL"
+  #                              })
+  #
+  # config.add_notification(Chequeo::Notifications::Logger, {},
+  #                             {
+  #                                 logger: Rails.logger
+  #                             })
+  #
+  #
+  # config.dead_mans_switch do
+  #
+  # end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chequeo
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta
+  version: 0.2.1.beta
 platform: ruby
 authors:
 - jdejong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twilio-ruby
@@ -178,6 +178,7 @@ files:
 - Rakefile
 - bin/chequeo
 - chequeo.gemspec
+- examples/chequeo.systemd.service
 - init.rb
 - lib/chequeo.rb
 - lib/chequeo/checkup_processor.rb