evenitron 0.2.2 → 0.3.0

data/README.markdown

@@ -1,12 +1,16 @@
 # Evenitron
 
-Evenitron is a service to help you to properly understand the performance of your delayed_job and resque jobs.
+Evenitron is a service to help you to properly understand the performance of
+your delayed\_job and resque jobs.
 
 ## Getting started
 
-In order to use the Evenitron service you will need a `system key` which is assigned to you when you sign up for an account. This key identifies you system to the Evenitron aggregators.
+In order to use the Evenitron service you will need a `system key` which is
+assigned to you when you sign up for an account. This key identifies your system
+to Evenitron.
 
-If you don't have an account you can request an invite to our private beta program here : http://evenitron.com/invite_requests/new
+If you don't have an account you can
+[sign up for our private beta program](http://app.evenitron.com/registrations/new).
 
 Firstly, add the gem to your Gemfile:
 
@@ -14,7 +18,8 @@ Firstly, add the gem to your Gemfile:
 gem 'evenitron'
 ```
 
-On start you need to configure the gem with your system key. In Rails this would go in `config\initializers\evenitron.rb`.
+On start you need to configure the gem with your system key. In Rails this would
+go in `config\initializers\evenitron.rb`.
 
 ```ruby
 require 'evenitron'
@@ -24,7 +29,7 @@ Evenitron.configure do |config|
 end
 ```
 
-Or you can rely on the environment variables `EVENITRON_SYSTEM_KEY`:
+Or you can rely on the environment variable `EVENITRON_SYSTEM_KEY`:
 
 ```ruby
 require 'evenitron'
@@ -34,4 +39,18 @@ Evenitron.configure
 
 ## Notes
 
-You must specify your system key either through configuration or the `EVENITRON_SYSTEM_KEY` environment variable but you will normally rely on the default collector URL of `http://collector.evenitron.com/`.
+You must specify your system key either through configuration or the
+`EVENITRON_SYSTEM_KEY` environment variable but you will normally rely on the
+default collector URL of `http://collector.evenitron.com/`.
+
+### Rails specific
+
+By default, Evenitron is only enabled in production in Rails applications. If
+you wish to enable it in another environment you must add this line to your
+environment file:
+
+```ruby
+config.evenitron.enabled = true
+```
+
+Evenitron will also hook into the `Rails.logger` for all of its log messages.

data/lib/evenitron.rb

@@ -1,4 +1,3 @@
-require 'bundler/setup'
 require 'base64'
 require 'rest_client'
 require 'securerandom'
@@ -19,16 +18,21 @@ module Evenitron
   #     config.system_key = 'your system key'
   #   end
   #
-  # Raises StandardError if no system_key passed or found in env variable
   def self.configure
     yield self if block_given?
 
-    logger.error("Evenitron system_key required") && return unless system_key
+    unless system_key && !system_key.empty?
+      logger.error "Evenitron system_key required"
+      Evenitron.enabled = false
+      logger.info "Evenitron reporting is DISABLED"
+      return
+    end
 
     initialize_delayed_job if Evenitron.delayed_job_present?
-    initialize_resque if Evenitron.resque_present?
+    initialize_resque      if Evenitron.resque_present?
 
     logger.info "Evenitron configured with #{system_key} #{collector_url}"
+    logger.info("Evenitron reporting is DISABLED") unless Evenitron.enabled
   end
 
   # Public: configured logger
@@ -53,8 +57,14 @@ module Evenitron
     # Public: Writers for the config values
     #
     attr_writer :logger, :collector_url, :system_key
+
+    attr_accessor :enabled
+
   end
 
+  # Default Evenitron to enabled.
+  Evenitron.enabled = true
+
   # Public: util method for encoding values for network transport.
   #
   # values      - Enumerable of Strings
@@ -119,4 +129,7 @@ private
 
 end
 
+# If we are running in a Rails environment include the Evenitron::Railtie class.
+#
+require_relative 'evenitron/railtie' if defined?(Rails)
 

data/lib/evenitron/collector_client.rb

@@ -29,20 +29,28 @@ module Evenitron
     #
     # Returns nothing
     def job_queued(args)
+      return unless Evenitron.enabled
+
       Thread.new do
         send_message :queued, args
       end
     end
 
     def job_started(args)
+      return unless Evenitron.enabled
+
       send_message :started, args
     end
 
     def job_failed(args)
+      return unless Evenitron.enabled
+
       send_message :failed, args
     end
 
     def job_complete(args)
+      return unless Evenitron.enabled
+
       send_message :complete, args
     end
 
@@ -98,4 +106,4 @@ module Evenitron
 
   end
 
-end
+end

data/lib/evenitron/delayed_job.rb

@@ -45,7 +45,7 @@ module Evenitron
       end
 
     end
-    
+
   end
 
-end
+end

data/lib/evenitron/railtie.rb

@@ -0,0 +1,25 @@
+module Evenitron
+
+  # Internal: Railtie to hook Evenitron into Rails.
+  #
+  # Hooks into the Rails.logger and disables publishing in all environments
+  # apart from production by default.
+  #
+  class Railtie < Rails::Railtie
+
+    # Expose Evenitron's configuration object to consumers through the Rails
+    # config object.
+    #
+    self.config.evenitron = Evenitron
+
+    initializer 'evenitron.initialize' do |app|
+      # Get Evenitron to use the Rails logger
+      Evenitron.logger = Rails.logger
+
+      # Only enable Evenitron in production by default
+      Evenitron.enabled = Rails.env.production?
+    end
+
+  end
+
+end

data/lib/evenitron/version.rb

@@ -1,3 +1,3 @@
 module Evenitron
-  VERSION = "0.2.2".freeze
-end
+  VERSION = "0.3.0".freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evenitron
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2012-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70229787376080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,12 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70229787376080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
 description: Ruby client for Evenitron with hooks for delayed_job and resque
 email:
 - support@evenitron.com
@@ -34,6 +39,7 @@ files:
 - lib/evenitron/delayed_job/collector.rb
 - lib/evenitron/delayed_job.rb
 - lib/evenitron/logger.rb
+- lib/evenitron/railtie.rb
 - lib/evenitron/resque/collector.rb
 - lib/evenitron/resque/resque.rb
 - lib/evenitron/resque.rb
@@ -60,8 +66,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: evenitron-ruby
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby client for Evenitron
 test_files: []
+has_rdoc: