cronitor_activejob 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49e937011714253f7762a40b12cb845b005520d3d6ba173b3b3d8dfb62b3e6c2
+  data.tar.gz: 1e3ab688e21e39e11e347e5194a3e5bae7ac6960f22bd91108635596e53d13ed
+SHA512:
+  metadata.gz: 124158d81dde7d3c92675e41db8c2887944b50beca29ea81bf8388c0a6fde4eabb3d225976103c1f02a8186aa8d381e08ea69dd9c59c5a322c528b88dea9d11d
+  data.tar.gz: 95e6317e961bde10cee6f29f95b0a66296c69554bba6b5460cc8de8f3eff048bc1a93e11524f3ae7429fbda4b8e63baedd3c4dd1a85174f0dea22adbeb24df35

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kevin Tom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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,83 @@
+# Cronitor::ActiveJob
+
+[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 ActiveJob library provides a drop in integration for monitoring any ActiveJob job.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cronitor_activejob'
+```
+
+And then bundle:
+
+    $ bundle
+
+
+## Usage
+
+Configure `cronitor` with an [API Key](https://cronitor.io/docs/api-overview) from [your settings](https://cronitor.io/settings). You can use ENV variables to configure Cronitor:
+
+```sh
+export CRONITOR_API_KEY='api_key_123'
+export CRONITOR_ENVIRONMENT='development' #default: 'production'
+```
+
+Or declare the API key directly on the Cronitor module from within your application (e.g. with an initializer).
+
+```ruby
+require 'cronitor'
+Cronitor.api_key = 'api_key_123'
+Cronitor.environment = 'development' #default: 'production'
+```
+
+
+To monitor jobs include the module in your job class
+
+```ruby
+class MyJob < ApplicationJob
+  include Cronitor::ActiveJob
+end
+```
+
+When this job is invoked, Cronitor will send telemetry pings with a `key` matching the name of your job class (`MyJob` in the example above). If no monitor exists it will create one on the first event. You can configure rules at a later time via the Cronitor dashboard, API, or [YAML config](https://github.com/cronitorio/cronitor-ruby#configuring-monitors) file.
+
+Optional: You can specify the monitor key directly using `cronitor_key`:
+
+```ruby
+class MyJob < ApplicationJob
+  include Cronitor::ActiveJob
+  cronitor_key 'abc123'
+
+  def perform
+  end
+end
+```
+
+
+To disable Cronitor for a specific job you can set the following option:
+
+```ruby
+class MyJob < ApplicationJob
+  include Cronitor::ActiveJob
+  cronitor_disabled: true
+
+  def perform
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cronitorio/cronitor-activejob. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cronitor/active_job/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cronitor
+  module ActiveJob
+    VERSION = "0.1.0"
+  end
+end

data/lib/cronitor/active_job.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "active_job/version"
+require "cronitor"
+
+module Cronitor
+  # Notify Cronitor of ActiveJob progress around perform
+  module ActiveJob
+    extend ActiveSupport::Concern
+
+    included do
+      around_perform :cronitor_instrumentation
+
+      def self.cronitor_disabled(disabled)
+        @cronitor_disabled = !!disabled
+      end
+
+      def self.cronitor_disabled?
+        @cronitor_disabled || false
+      end
+
+      def self.cronitor_key(key)
+        @cronitor_key = key
+      end
+
+      def self.cronitor_job_key
+        @cronitor_key || name
+      end
+    end
+
+    private
+
+    def cronitor_instrumentation(&block)
+      if should_ping?
+        Cronitor.job(self.class.cronitor_job_key, &block)
+      else
+        yield
+      end
+    end
+
+    def should_ping?
+      Cronitor.api_key.present? && !self.class.cronitor_disabled?
+    end
+  end
+end

data/lib/cronitor_activejob.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "cronitor/active_job"

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: cronitor_activejob
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Tom
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cronitor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: Instrument ActiveJob jobs with Cronitor to monitor lifecycle events around
+  the perform method.
+email:
+- kevintom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/cronitor/active_job.rb
+- lib/cronitor/active_job/version.rb
+- lib/cronitor_activejob.rb
+homepage: https://github.com/cronitor/cronitor-activejob
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: ActiveJob integration with Cronitor.
+test_files: []