cronitor 5.2.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 256202e94ab78e773be9c52bfd101ba23fb12d33140be4035e03488918db4a09
-  data.tar.gz: 285d0414d43c71968b11b57be219bd8a8bc5f31b49a66b254124677efcc42869
+  metadata.gz: d786e1bcc6b048371b5a9ef9e2c9d4d0db9a7e8d65f30cfd1029cbd3409f9e0e
+  data.tar.gz: df00a0cfe1cd458146b892b145b2919caf51f384dbe4c89348a6f03b3afa4a83
 SHA512:
-  metadata.gz: bc5ffa239b51b869fc73b11fd83900340823e63fe46a82609a96e2c45f13148c1b6514844e1315a7a584927400a5cbb85381c7fa995940d938bfc1528403e7d3
-  data.tar.gz: 4666eea5d6f1cf5631fb9fcccadfa6e11d074a560af1a7a411b6dd8f7720dd8667576752337216ee4bca9c2a2dd6e718ecbc14d0b1656b6a6be642657b9fca51
+  metadata.gz: aaf140a231580c70c6653795e4530f792384602e9c1c5ee6da3cc4da4de2f55fa73d4bdb920af72448be5dcce75963a68f2b3e660593334f64482d05198a8d18
+  data.tar.gz: 4b530de67e7d3f2fbb86fece1a9cdae10a01456d6707a9c4d92f76a09004bc0c9a1a907c665fb6e62006a13b3e5394f41b44946e6cc853754330fdb16a4500b3

data/.github/workflows/test.yml

@@ -39,6 +39,8 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
+          - '3.4'
 
     runs-on: ubuntu-latest
 

data/README.md

@@ -62,7 +62,7 @@ monitor.ping(state: 'complete', metrics: {count: 1000, error_count: 17})
 
 ## Configuring Monitors
 
-### Using a YAML configuration file
+### YAML Configuration File
 
 You can configure all of your monitors using a single YAML file. This can be version controlled and synced to Cronitor as part of
 a deployment or build process. For details on all of the attributes that can be set, see the [Monitor API](https://cronitor.io/docs/monitor-api) documentation.
@@ -128,6 +128,8 @@ heartbeats:
             events: true # send alert when the event occurs
 
 ```
+#### Async Uploads
+If you are working with large YAML files (300+ monitors), you may hit timeouts when trying to sync monitors in a single http request. This workload to be processed asynchronously by adding the key `async: true` to the config file. The request will immediately return a `batch_key`. If a `webhook_url` parameter is included, Cronitor will POST to that URL with the results of the background processing and will include the `batch_key` matching the one returned in the initial response.
 
 ### Using `Cronitor::Monitor.put`
 

data/lib/cronitor/config.rb

@@ -9,12 +9,12 @@ module Cronitor
   YAML_KEYS = MONITOR_TYPES.map { |t| "#{t}s" }
 
   class << self
-    attr_accessor :api_key, :api_version, :environment, :logger, :config, :timeout, :ping_timeout, :auto_discover_sidekiq, :telemetry_domain
+    attr_accessor :api_key, :api_version, :environment, :logger, :config, :timeout, :ping_timeout,
+                  :auto_discover_sidekiq, :telemetry_domain
 
     def configure(&block)
       block.call(self)
     end
-
   end
 
   self.api_key = ENV.fetch('CRONITOR_API_KEY', nil)

data/lib/cronitor/monitor.rb

@@ -5,6 +5,7 @@ module Cronitor
     attr_reader :key, :api_key, :api_version, :env
 
     PING_RETRY_THRESHOLD = 3
+    MONITOR_API_URL = 'https://cronitor.io/api/monitors'
 
     module Formats
       ALL = [
@@ -24,13 +25,12 @@ module Cronitor
                         })
     end
 
-
     def self.put(opts = {})
       rollback = opts[:rollback] || false
       opts.delete(:rollback)
 
       monitors = opts[:monitors] || [opts]
-      url = "https://cronitor.io/api/monitors"
+      url = MONITOR_API_URL
       if opts[:format] == Cronitor::Monitor::Formats::YAML
         url = "#{url}.yaml"
         monitors['rollback'] = true if rollback
@@ -77,12 +77,41 @@ module Cronitor
       end
     end
 
-    def self.delete(key)
+    def self.as_yaml(api_key: nil, api_version: nil)
+      timeout = Cronitor.timeout || 10
+      api_key = api_key || Cronitor.api_key
+
+      unless api_key
+        raise Error.new('No API key detected. Set Cronitor.api_key or pass api_key parameter')
+      end
+
+      headers = Cronitor::Monitor::Headers::YAML.dup
+      headers[:'Cronitor-Version'] = api_version if api_version
+
+      resp = HTTParty.get(
+        "#{MONITOR_API_URL}.yaml",
+        basic_auth: {
+          username: api_key,
+          password: ''
+        },
+        headers: headers,
+        timeout: timeout
+      )
+
+      case resp.code
+      when 200
+        resp.body
+      else
+        raise Error.new("Unexpected error #{resp.code}: #{resp.body}")
+      end
+    end
+
+    def delete
       resp = HTTParty.delete(
-        "#{Cronitor.monitor_api_url}/#{key}",
+        "#{monitor_api_url}/#{key}",
         timeout: Cronitor.timeout,
         basic_auth: {
-          username: Cronitor.api_key,
+          username: api_key,
           password: ''
         },
         headers: Cronitor::Monitor::Headers::JSON
@@ -187,10 +216,9 @@ module Cronitor
     end
 
     def monitor_api_url
-      "https://cronitor.io/api/monitors"
+      MONITOR_API_URL
     end
 
-
     private
 
     def fetch
@@ -219,7 +247,7 @@ module Cronitor
         message: params.fetch(:message, nil),
         series: params.fetch(:series, nil),
         host: params.fetch(:host, Socket.gethostname),
-        metric: params[:metrics] ? params[:metrics].map { |k, v| "#{k}:#{v}" } : nil,
+        metric: params[:metrics]&.map { |k, v| "#{k}:#{v}" },
         stamp: Time.now.to_f,
         env: params.fetch(:env, env)
       }

data/lib/cronitor/version.rb

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

data/lib/cronitor.rb

@@ -32,7 +32,7 @@ module Cronitor
   def self.apply_config(rollback: false)
     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
+    timeout = [Cronitor.timeout, 30].max
     monitors = Monitor.put(monitors: conf, format: Cronitor::Monitor::Formats::YAML, rollback: rollback,
                            timeout: timeout)
     count = 0
@@ -49,6 +49,17 @@ module Cronitor
     apply_config(rollback: true)
   end
 
+  def self.generate_config(path = nil)
+    config_path = path || Cronitor.config || './cronitor.yaml'
+    yaml_content = Monitor.as_yaml
+
+    File.open(config_path, 'w') do |file|
+      file.write(yaml_content)
+    end
+
+    puts("Configuration saved to #{config_path}")
+  end
+
   def self.job(key, &block)
     monitor = Monitor.new(key)
     series = Time.now.to_f
@@ -62,7 +73,6 @@ module Cronitor
       raise e
     end
   end
-
 end
 
 Cronitor.read_config(Cronitor.config) unless Cronitor.config.nil?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronitor
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.3.0
 platform: ruby
 authors:
 - Jeff Byrnes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty