cronitor 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d91bccffc3a53dfe487e4740c00aa83b47fe31c4347a1bdc93e017bbb3467751
-  data.tar.gz: 5730c8a4742bab773c1e3582fa4f00298890171e91ef96b83fda8e0a6ebd6470
+  metadata.gz: 1c33ade0ff17f4941318a1483b1255556d2b5d7b3c89c41fa70ffb9d6bc05a4b
+  data.tar.gz: 2e2c69fe75cf72f65964d59994a3dce7e58266449bd21be76428b4c1f32d354a
 SHA512:
-  metadata.gz: '054173538e57d465de2cc25786a42ccdb80c2be0532f0526634153de3fd7c46f428cdeaded4dd84e6169a9aa5717439bab0b1b4cc9672b56b93543ae58183ae3'
-  data.tar.gz: 311901851f90644a7d0c46eeed1b2bd821880816090799d1601008e29fa19a4cad2199905f317a9a08225296d579ba054bc87456dadf19fe427f3487c0ac42ce
+  metadata.gz: 98a47cd2ded8d3661ea8527b4dfd4b457b6b6d92ed101fac6f58e5d43eb791564b7f074dbfed5019036f9b1a01ed3f6f0687d8bbd90c5c19f3a7cf21cbe5d5d0
+  data.tar.gz: f69e2de58e9cfa009e4255c6613e5338d68babdac5bd3848e9b1aea8ee4e6411694750b4e933dadaa447a0033b51f4ef120801e5305f704785c7bfedb4ce79ee

data/.rubocop.yml

@@ -12,6 +12,9 @@ AllCops:
   TargetRubyVersion: 2.5
   Exclude:
     - 'spec/cronitor_spec.rb'
+    
+RequireMFA: 
+  Enabled: false
 
 Metrics/AbcSize:
   Enabled: false

data/README.md

@@ -8,13 +8,12 @@
 
 In this guide:
 
-- [Installation](##Installation)
-- [Monitoring Background Jobs](##monitoring-background-jobs)
-- [Sending Telemetry Events](##sending-telemetry-events)
-- [Configuring Monitors](##configuring-monitors)
-- [Package Configuration & Env Vars](##package-configuration)
-- [Command Line Usage](##command-line-usage)
-- [Contributing](##contributing)
+- [Installation](#Installation)
+- [Monitoring Background Jobs](#monitoring-background-jobs)
+- [Sending Telemetry Events](#sending-telemetry-events)
+- [Configuring Monitors](#configuring-monitors)
+- [Package Configuration & Env Vars](#package-configuration)
+- [Contributing](#contributing)
 
 ## Installation
 
@@ -70,7 +69,7 @@ a deployment or build process. For details on all of the attributes that can be
 require 'cronitor'
 Cronitor.api_key = 'api_key_123'
 
-# read config file and set credentials (if included).
+# read config file.
 Cronitor.read_config('./cronitor.yaml')
 
 # sync config file's monitors to Cronitor.
@@ -79,9 +78,12 @@ Cronitor.apply_config
 # send config file's monitors to Cronitor to validate correctness.
 # monitors will not be saved.
 Cronitor.validate_config
+
+# generate a new config file from the Cronitor API.
+Cronitor.generate_config
 ```
 
-The `cronitor.yaml` file includes three top level keys `jobs`, `checks`, `events`. You can configure monitors under each key by defining [monitors](https://cronitor.io/docs/monitor-api#attributes).
+The `cronitor.yaml` file includes three top level keys `jobs`, `checks`, `heartbeats`. You can configure monitors under each key by defining [monitors](https://cronitor.io/docs/monitor-api#attributes).
 
 ```yaml
 jobs:
@@ -179,6 +181,11 @@ require 'cronitor'
 Cronitor.api_key = 'apiKey123'
 Cronitor.api_version = '2020-10-01'
 Cronitor.environment = 'cluster_1_prod'
+
+Cronitor.timeout = 20 # defaults to 10 can also be set with ENV['CRONITOR_TIMEOUT']
+Cronitor.logger = nil # defaults to Logger.new($stdout)
+# faster timeout for potentially more time sensitive call
+Cronitor.ping_timeout = 10 # defaults to 5 can also be set with ENV['CRONITOR_PING_TIMEOUT']
 ```
 
 ## Contributing

data/lib/cronitor/config.rb

@@ -1,33 +1,27 @@
 # frozen_string_literal: true
 
 module Cronitor
-  TYPE_JOB = 'job'
-  TYPE_HEARTBEAT = 'heartbeat'
-  TYPE_CHECK = 'check'
-  MONITOR_TYPES = [TYPE_JOB, TYPE_HEARTBEAT, TYPE_CHECK].freeze
-  YAML_KEYS = %w[
-    api_key
-    api_version
-    environment
-  ] + MONITOR_TYPES.map { |t| "#{t}s" }
+  MONITOR_TYPES = [
+    TYPE_JOB = 'job',
+    TYPE_HEARTBEAT = 'heartbeat',
+    TYPE_CHECK = 'check'
+  ].freeze
+  YAML_KEYS = MONITOR_TYPES.map { |t| "#{t}s" }
 
   class << self
-    attr_accessor :api_key, :api_version, :environment, :logger, :config, :_headers
+    attr_accessor :api_key, :api_version, :environment, :logger, :config, :timeout, :ping_timeout
 
     def configure(&block)
       block.call(self)
     end
   end
 
-  self.api_key = ENV['CRONITOR_API_KEY']
-  self.api_version = ENV['CRONITOR_API_VERSION']
-  self.environment = ENV['CRONITOR_ENVIRONMENT']
-  self.config = ENV['CRONITOR_CONFIG']
+  self.api_key = ENV.fetch('CRONITOR_API_KEY', nil)
+  self.api_version = ENV.fetch('CRONITOR_API_VERSION', nil)
+  self.environment = ENV.fetch('CRONITOR_ENVIRONMENT', nil)
+  self.timeout = ENV.fetch('CRONITOR_TIMEOUT', nil) || 10
+  self.ping_timeout = ENV.fetch('CRONITOR_PING_TIMEOUT', nil) || 5
+  self.config = ENV.fetch('CRONITOR_CONFIG', nil)
   self.logger = Logger.new($stdout)
   logger.level = Logger::INFO
-  self._headers = {
-    'Content-Type': 'application/json',
-    'User-Agent': 'cronitor-ruby',
-    'Cronitor-Version': Cronitor.api_version
-  }
 end

data/lib/cronitor/monitor.rb

@@ -6,56 +6,89 @@ module Cronitor
 
     PING_RETRY_THRESHOLD = 5
 
+    module Formats
+      ALL = [
+        JSON = 'json',
+        YAML = 'yaml'
+      ].freeze
+    end
+
+    module Headers
+      JSON = {
+        'Content-Type': 'application/json',
+        'User-Agent': "cronitor-ruby-#{Cronitor::VERSION}",
+        'Cronitor-Version': Cronitor.api_version
+      }.freeze
+      YAML = JSON.merge({
+                          'Content-Type': 'application/yaml'
+                        })
+    end
+
     def self.put(opts = {})
       rollback = opts[:rollback] || false
       opts.delete(:rollback)
 
       monitors = opts[:monitors] || [opts]
 
+      if opts[:format] == Cronitor::Monitor::Formats::YAML
+        url = "#{Cronitor.monitor_api_url}.yaml"
+        monitors['rollback'] = true if rollback
+        body = YAML.dump(monitors)
+        headers = Cronitor::Monitor::Headers::YAML
+      else
+        url = Cronitor.monitor_api_url
+        body = {
+          monitors: monitors,
+          rollback: rollback
+        }.to_json
+        headers = Cronitor::Monitor::Headers::JSON
+      end
+
       resp = HTTParty.put(
-        Cronitor.monitor_api_url,
+        url,
         basic_auth: {
           username: Cronitor.api_key,
           password: ''
         },
-        body: {
-          monitors: monitors,
-          rollback: rollback
-        }.to_json,
-        headers: Cronitor._headers,
-        timeout: 10
+        body: body,
+        headers: headers,
+        timeout: opts[:timeout] || Cronitor.timeout
       )
 
       case resp.code
       when 200
-        out = []
-        data = JSON.parse(resp.body)
-
-        (data['monitors'] || []).each do |md|
-          m = Monitor.new(md['key'])
-          m.data = Cronitor.symbolize_keys(md)
-          out << m
+        if opts[:format] == Cronitor::Monitor::Formats::YAML
+          YAML.safe_load(resp.body)
+        else
+          out = []
+          data = JSON.parse(resp.body)
+
+          (data['monitors'] || []).each do |md|
+            m = Monitor.new(md['key'])
+            m.data = Cronitor.symbolize_keys(md)
+            out << m
+          end
+          out.length == 1 ? out[0] : out
         end
-        out.length == 1 ? out[0] : out
       when 400
         raise ValidationError.new(resp.body)
       else
-        raise Error.new("Error connecting to Cronitor: #{resp.code}")
+        raise Error.new("Error connecting to Cronitor: #{resp.code}\n #{resp.body}")
       end
     end
 
     def self.delete(key)
       resp = HTTParty.delete(
         "#{Cronitor.monitor_api_url}/#{key}",
-        timeout: 10,
+        timeout: Cronitor.timeout,
         basic_auth: {
           username: Cronitor.api_key,
           password: ''
         },
-        headers: Cronitor._headers
+        headers: Cronitor::Monitor::Headers::JSON
       )
       if resp.code != 204
-        Cronitor.logger.error("Error deleting monitor: #{key}")
+        Cronitor.logger&.error("Error deleting monitor: #{key}")
         return false
       end
       true
@@ -81,7 +114,7 @@ module Cronitor
     def ping(params = {})
       retry_count = params[:retry_count] || 0
       if api_key.nil?
-        Cronitor.logger.error('No API key detected. Set Cronitor.api_key or initialize Monitor with an api_key:')
+        Cronitor.logger&.error('No API key detected. Set Cronitor.api_key or initialize Monitor with an api_key:')
         return false
       end
 
@@ -92,8 +125,8 @@ module Cronitor
         response = HTTParty.get(
           ping_url,
           query: clean_params(params),
-          timeout: 5,
-          headers: Cronitor._headers,
+          timeout: Cronitor.ping_timeout,
+          headers: Cronitor::Monitor::Headers::JSON,
           query_string_normalizer: lambda do |query|
             query.compact!
             metrics = query[:metric]
@@ -106,18 +139,18 @@ module Cronitor
         )
 
         if response.code != 200
-          Cronitor.logger.error("Cronitor Telemetry Error: #{response.code}")
+          Cronitor.logger&.error("Cronitor Telemetry Error: #{response.code}")
           return false
         end
         true
       rescue StandardError => e
         # rescue instances of StandardError i.e. Timeout::Error, SocketError, etc
-        Cronitor.logger.error("Cronitor Telemetry Error: #{e}")
+        Cronitor.logger&.error("Cronitor Telemetry Error: #{e}")
         return false if retry_count >= Monitor::PING_RETRY_THRESHOLD
 
         # apply a backoff before sending the next ping
         sleep(retry_count * 1.5 * rand)
-        ping(params.merge(retry_count: params[:retry_count] + 1))
+        ping(params.merge(retry_count: retry_count + 1))
       end
     end
 
@@ -131,8 +164,8 @@ module Cronitor
 
       resp = HTTParty.get(
         pause_url,
-        timeout: 5,
-        headers: Cronitor._headers,
+        timeout: Cronitor.timeout,
+        headers: Cronitor::Monitor::Headers::JSON,
         basic_auth: {
           username: api_key,
           password: ''
@@ -162,13 +195,13 @@ module Cronitor
 
     def fetch
       unless api_key
-        Cronitor.logger.error(
+        Cronitor.logger&.error(
           'No API key detected. Set Cronitor.api_key or initialize Monitor with the api_key kwarg'
         )
         return
       end
 
-      HTTParty.get(monitor_api_url, timeout: 10, headers: Cronitor._headers, format: :json)
+      HTTParty.get(monitor_api_url, timeout: Cronitor.timeout, headers: Cronitor::Monitor::Headers::JSON, format: :json)
     end
 
     def clean_params(params)

data/lib/cronitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cronitor
-  VERSION = '4.1.0'
+  VERSION = '5.0.0'
 end

data/lib/cronitor.rb

@@ -13,7 +13,7 @@ require 'cronitor/version'
 require 'cronitor/monitor'
 
 module Cronitor
-  def self.read_config(path = nil, output: false)
+  def self.read_config(path = nil)
     Cronitor.config = path || Cronitor.config
     unless Cronitor.config
       raise ConfigurationError.new(
@@ -26,39 +26,23 @@ module Cronitor
     conf.each do |k, _v|
       raise ConfigurationError.new("Invalid configuration variable: #{k}") unless Cronitor::YAML_KEYS.include?(k)
     end
-
-    Cronitor.api_key     = conf[:api_key] if conf[:api_key]
-    Cronitor.api_version = conf[:api_version] if conf[:api_version]
-    Cronitor.environment = conf[:environment] if conf[:environment]
-
-    return unless output
-
-    monitors = []
-    Cronitor::MONITOR_TYPES.each do |t|
-      plural_t = "#{t}s"
-      to_parse = conf[t] || conf[plural_t] || nil
-      next unless to_parse
-
-      unless to_parse.is_a?(Hash)
-        raise ConfigurationError.new('A Hash with keys corresponding to monitor keys is expected.')
-      end
-
-      to_parse.each do |key, m|
-        m['key'] = key
-        m['type'] = t
-        monitors << m
-      end
-    end
-    conf['monitors'] = monitors
     conf
   end
 
   def self.apply_config(rollback: false)
-    conf = read_config(output: true)
-    monitors = Monitor.put(monitors: conf.fetch('monitors', []), rollback: rollback)
-    puts("#{monitors.length} monitors #{rollback ? 'validated' : 'synced to Cronitor'}.")
+    conf = read_config
+    # allow a significantly longer timeout on requests that are sending full yaml config. min 30 seconds.
+    timeout = Cronitor.timeout < 30 ? 30 : Cronitor.timeout
+    monitors = Monitor.put(monitors: conf, format: Cronitor::Monitor::Formats::YAML, rollback: rollback,
+                           timeout: timeout)
+    count = 0
+    # step through the different monitor types and count up all the returned configurations
+    Cronitor::YAML_KEYS.each do |k|
+      count += (monitors[k]&.count || 0)
+    end
+    puts("#{count} monitors #{rollback ? 'validated' : 'synced to Cronitor'}.")
   rescue ValidationError => e
-    Cronitor.logger.error(e)
+    Cronitor.logger&.error(e)
   end
 
   def self.validate_config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronitor
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Jeff Byrnes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty