cronitor 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d5c6dc2547c52ed2ccee489b2ea5428c6badd902f996ea076cd196e6c4bb1c3
-  data.tar.gz: 57b37c91645625096fbe19004d181a6ed375517e02379b6d8365676c4d33839b
+  metadata.gz: d91bccffc3a53dfe487e4740c00aa83b47fe31c4347a1bdc93e017bbb3467751
+  data.tar.gz: 5730c8a4742bab773c1e3582fa4f00298890171e91ef96b83fda8e0a6ebd6470
 SHA512:
-  metadata.gz: 349711cfbefe7cb0519e872862f9f54fd24d877850ac63714db59b62f4d7f7008bc39008fb74bca22eebb85c72d1e90e0fdf7c1a5fcb5ace205af63611440579
-  data.tar.gz: 10e8d151d5bd52f464aa92dcd737f1e29354699b66832f17f977b5608b4716532406ba21ac0d83e439732abad9558f46feb0fc0037e06b7ce79169622a36a283
+  metadata.gz: '054173538e57d465de2cc25786a42ccdb80c2be0532f0526634153de3fd7c46f428cdeaded4dd84e6169a9aa5717439bab0b1b4cc9672b56b93543ae58183ae3'
+  data.tar.gz: 311901851f90644a7d0c46eeed1b2bd821880816090799d1601008e29fa19a4cad2199905f317a9a08225296d579ba054bc87456dadf19fe427f3487c0ac42ce

data/.rubocop.yml

@@ -9,6 +9,7 @@ inherit_mode:
 
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.5
   Exclude:
     - 'spec/cronitor_spec.rb'
 

data/README.md

@@ -4,10 +4,17 @@
 [![Gem Version](https://badge.fury.io/rb/cronitor.svg)](https://badge.fury.io/rb/cronitor)
 
 
-[Cronitor](https://cronitor.io/) provides dead simple monitoring for cron jobs, daemons, data pipelines, queue workers, and anything else that can send or receive an HTTP request. The Cronitor Ruby library provides convenient access to the Cronitor API from applications written in Ruby.
+[Cronitor](https://cronitor.io/) provides dead simple monitoring for cron jobs, daemons, queue workers, websites, APIs, and anything else that can send or receive an HTTP request. The Cronitor Ruby library provides convenient access to the Cronitor API from applications written in Ruby. See our [API docs](https://cronitor.io/docs/api) for detailed references on configuring monitors and sending telemetry pings.
 
-## Documentation
-See our [API docs](https://cronitor.io/docs/api) for a detailed reference information about the APIs this library uses for configuring monitors and sending telemetry pings.
+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
 
@@ -15,49 +22,31 @@ See our [API docs](https://cronitor.io/docs/api) for a detailed reference inform
 gem install cronitor
 ```
 
-## Usage
-
-The package needs to be configured with your account's `API key`, which is available on the [account settings](https://cronitor.io/settings) page. You can also optionally specify an `API Version` (default: account default) and `Environment` (default: account default).
-
-These can be supplied using the environment variables `CRONITOR_API_KEY`, `CRONITOR_API_VERSION`, `CRONITOR_ENVIRONMENT` or set directly on the cronitor object.
-
-```ruby
-require 'cronitor'
-
-Cronitor.api_key = 'apiKey123'
-Cronitor.api_version = '2020-10-01'
-Cronitor.environment = 'staging'
-```
-
-You can also use a YAML config file to manage all of your monitors (_see Create and Update Monitors section below_). The path to this file can be supplied using the enviroment variable `CRONITOR_CONFIG` or call `cronitor.read_config()`.
-
-```ruby
-require 'cronitor'
-
-Cronitor.read_config('./path/to/cronitor.yaml')
-```
-
+## Monitoring Background Jobs
 
-### Monitor Any Block
-
-The quickest way to start using this library is to wrap a block of code with the `#job` helper. It will report the start time, end time, and exit state to Cronitor. If an exception is raised, the stack trace will be included in the failure message.
+The `Cronitor#job` helper will send telemetry events before calling your block and after it exits. If your block raises an exception a `fail` event will be sent (and the exception re-raised).
 
 ```ruby
 require 'cronitor'
+Cronitor.api_key = 'api_key_123'
 
 Cronitor.job 'warehouse-replenishmenth-report' do
   ReplenishmentReport.new(Date.today).run()
 end
 ```
 
-### Sending Telemetry Events
+### Integrating with Sidekiq
+Cronitor provides a [separate library](https://github.com/cronitorio/cronitor-sidekiq) built with this SDK to make Sidekiq integration even easier.
+
+
+## Sending Telemetry Events
 
 If you want finer control over when/how [telemetry pings](https://cronitor.io/docs/telemetry-api) are sent,
 you can instantiate a monitor and call `#ping`.
 
 ```ruby
 require 'cronitor'
-
+Cronitor.api_key = 'api_key_123'
 
 monitor = Cronitor::Monitor.new('heartbeat-monitor')
 
@@ -72,57 +61,14 @@ monitor.ping(state: 'run', env: 'staging') # a job/process has started in a stag
 monitor.ping(state: 'complete', metrics: {count: 1000, error_count: 17})
 ```
 
-### Pause, Reset, Delete
-
-```ruby
-require 'cronitor'
-
-monitor = Cronitor::Monitor.new('heartbeat-monitor')
-
-monitor.pause(24) # pause alerting for 24 hours
-monitor.unpause # alias for .pause(0)
-monitor.ok # manually reset to a passing state alias for monitor.ping({state: ok})
-monitor.delete # destroy the monitor
-```
-
-## Create and Update Monitors
-
-You can create monitors programatically using the `Monitor` object.
-For details on all of the attributes that can be set see the [Monitor API](https://cronitor.io/docs/monitor-api) documentation.
-
-
-```ruby
-require 'cronitor'
-
-monitors = Cronitor::Monitor.put([
-  {
-    type: 'job',
-    key: 'send-customer-invoices',
-    schedule: '0 0 * * *',
-    assertions: [
-        'metric.duration < 5 min'
-    ],
-    notify: ['devops-alerts-slack']
-  },
-  {
-    type: 'synthetic',
-    key: 'Orders Api Uptime',
-    schedule: 'every 45 seconds',
-    assertions: [
-        'response.code = 200',
-        'response.time < 1.5s',
-        'response.json "open_orders" < 2000'
-    ]
-  }
-])
-```
+## Configuring Monitors
 
-You can also manage all of your monitors via a YAML config file.
-This can be version controlled and synced to Cronitor as part of
-a deployment process or system update.
+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.
 
 ```ruby
 require 'cronitor'
+Cronitor.api_key = 'api_key_123'
 
 # read config file and set credentials (if included).
 Cronitor.read_config('./cronitor.yaml')
@@ -135,17 +81,9 @@ Cronitor.apply_config
 Cronitor.validate_config
 ```
 
-
-The `cronitor.yaml` file accepts the following attributes:
+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).
 
 ```yaml
-api_key: 'optionally read Cronitor api_key from here'
-api_version: 'optionally read Cronitor api_version from here'
-environment: 'optionally set an environment for telemetry pings'
-
-# configure all of your monitors with type "job"
-# you may omit the type attribute and the key
-# of each object will be set as the monitor key
 jobs:
     nightly-database-backup:
         schedule: 0 0 * * *
@@ -160,8 +98,7 @@ jobs:
             - metric.count > 0
             - metric.duration < 30 seconds
 
-# configure all of your monitors with type "synthetic"
-synthetics:
+check:
     cronitor-homepage:
         request:
             url: https://cronitor.io
@@ -180,7 +117,7 @@ synthetics:
             - response.body contains ok
             - response.time < .25s
 
-events:
+heartbeats:
     production-deploy:
         notify:
             alerts: ['deploys-slack']
@@ -188,6 +125,61 @@ events:
 
 ```
 
+You can also create and update monitors by calling `Monitor.put`.
+
+```ruby
+require 'cronitor'
+
+monitors = Cronitor::Monitor.put([
+  {
+    type: 'job',
+    key: 'send-customer-invoices',
+    schedule: '0 0 * * *',
+    assertions: [
+        'metric.duration < 5 min'
+    ],
+    notify: ['devops-alerts-slack']
+  },
+  {
+    type: 'check',
+    key: 'Cronitor Homepage',
+    request: {
+        url: 'https://cronitor.io'
+    },
+    schedule: 'every 45 seconds',
+    assertions: [
+        'response.code = 200',
+        'response.time < 600ms',
+    ]
+  }
+])
+```
+
+### Pause, Reset, Delete
+
+```ruby
+require 'cronitor'
+
+monitor = Cronitor::Monitor.new('heartbeat-monitor')
+
+monitor.pause(24) # pause alerting for 24 hours
+monitor.unpause # alias for .pause(0)
+monitor.ok # manually reset to a passing state alias for monitor.ping({state: ok})
+monitor.delete # destroy the monitor
+```
+
+## Package Configuration
+
+The package needs to be configured with your account's `API key`, which is available on the [account settings](https://cronitor.io/settings) page. You can also optionally specify an `api_version` and an `environment`. If not provided, your account default is used. These can also be supplied using the environment variables `CRONITOR_API_KEY`, `CRONITOR_API_VERSION`, `CRONITOR_ENVIRONMENT`.
+
+```ruby
+require 'cronitor'
+
+# your api keys can found here - https://cronitor.io/settings
+Cronitor.api_key = 'apiKey123'
+Cronitor.api_version = '2020-10-01'
+Cronitor.environment = 'cluster_1_prod'
+```
 
 ## Contributing
 
@@ -227,4 +219,4 @@ Push to your fork and [submit a pull request]( https://github.com/cronitorio/cro
 The bump gem makes this easy:
 
 1. `rake bump:(major|minor|patch|pre)`
-2. `rake release`
+2. `rake release`

data/cronitor.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary     = 'An interface for the Cronitor API'
   spec.homepage    = 'https://github.com/cronitorio/cronitor-ruby'
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

data/lib/cronitor/config.rb

@@ -2,9 +2,9 @@
 
 module Cronitor
   TYPE_JOB = 'job'
-  TYPE_EVENT = 'event'
-  TYPE_SYNTHETIC = 'synthetic'
-  MONITOR_TYPES = [TYPE_JOB, TYPE_EVENT, TYPE_SYNTHETIC].freeze
+  TYPE_HEARTBEAT = 'heartbeat'
+  TYPE_CHECK = 'check'
+  MONITOR_TYPES = [TYPE_JOB, TYPE_HEARTBEAT, TYPE_CHECK].freeze
   YAML_KEYS = %w[
     api_key
     api_version

data/lib/cronitor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronitor
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Jeff Byrnes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -202,7 +202,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="