rearview 1.1.2-jruby → 1.2.0-jruby

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d1276e19f9f16bde728edf0876f8abe9c222331
-  data.tar.gz: efe1ff6239c6c564c9667445ccfab3a5035a35b0
+  metadata.gz: d9930818c3cb39841ee9774dbdee3ad09c4e72c4
+  data.tar.gz: 0190f0a54cdebf77f29d161adeea0a9ea195a7d4
 SHA512:
-  metadata.gz: f2e2d5d153ebbf5fa578ff9d1920b4fdc29775642b1f65ecb506160cab0079dd92bb0942f55c4179583ba3cad049d82b2a9aa1b3cd8374c93393a583da7d031c
-  data.tar.gz: da47adfeb40007e595983100c8fbb573c17e10159fce0127286f1d63cd974fa3c7bb48df856a901e1da4e58f4d42efe5a755f1528ebedc68599f47c4921e2871
+  metadata.gz: a285f335cf44cb0d9fbfc174e419d9051544ab03a045a60cfa8529edb90752cf493625b957d9f983b50081ea063fcda6646454c7bd13ed40ef579a6b0b4c3503
+  data.tar.gz: 17e8d45a1f71f0bac7028cb1204978f968f4bc63d30a178e409cba18d2471b8cf48ce19d50ebea818d3ac463ca4fa628692e29b9976db9a3e9c280b89dc57730

data/README.md

@@ -1,15 +1,17 @@
 [![Build Status](https://secure.travis-ci.org/livingsocial/rearview-engine.png?branch=master)](http://travis-ci.org/livingsocial/rearview-engine)
+[![Coverage Status](https://coveralls.io/repos/livingsocial/rearview-engine/badge.png?branch=master)](https://coveralls.io/r/livingsocial/rearview-engine?branch=master)
 [![Code Climate](https://codeclimate.com/github/livingsocial/rearview-engine.png)](https://codeclimate.com/github/livingsocial/rearview-engine)
+[![Gem Version](https://badge.fury.io/rb/rearview.png)](http://badge.fury.io/rb/rearview)
 
 Rails engine for [rearview](http://github.com/livingsocial/rearview). This project is for rearview developers only. For users please go to the [rearview](http://github.com/livingsocial/rearview) project for installation, configuration, and other details.
 
 # Development Guide
 
-Before developing please read how to [contribute](https://github.com/livingsocial/rearview-engine/blob/master/CONTRIBUTING.md).
+Be sure to read the contribution guidelines [contribute](https://github.com/livingsocial/rearview-engine/blob/master/CONTRIBUTING.md).
 
 ## Intro
 
-Before contributing you should read [Getting Started with Engines](http://guides.rubyonrails.org/engines.html) guide to familiarize yourself with rails engines.
+Before contributing you should read [Getting Started with Engines](http://guides.rubyonrails.org/engines.html) guide to familiarize yourself with rails engines. This [blog post](http://trentalbright.info/ruby/open-sourcing-with-engines/) also provides some more in-depth details of rails engines.
 
 Rearview consists of two components:
 
@@ -42,6 +44,10 @@ Change the line simliar to this
 To point to the path you cloned the engine too, for example
 
     gem 'rearview', :path => '~/clone/path/rearview-engine'
+    
+Update your gems with bundler
+
+    bundle install
 
 #### sync the engine host database
 
@@ -54,7 +60,9 @@ To point to the path you cloned the engine too, for example
     
 ## User Interface Guide
 
-Rearview does not use the asset pipeline. Instead you'll need to take a look at [public/rearview-src](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview-src). In development mode javascript, css, etc is loaded directly from here. When rearview-engine is bundled as a Gem the various elements are pre-compiled (manually before **gem build**) using require and are loaded from [public/rearview](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview).
+The Rearview UI is built using bootstrap and require.
+
+Rearview does not use the asset pipeline. Instead you'll need to take a look at [public/rearview-src](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview-src). In development mode javascript, css, etc are loaded directly from here. When rearview-engine is bundled as a Gem the various elements are pre-compiled (manually before **gem build**) using require.js and are loaded from [public/rearview](https://github.com/livingsocial/rearview-engine/tree/master/public/rearview).
 
 To compile the ui before distribution, run the following rake task from inside rearview-engine:
 

data/app/controllers/rearview/application_controller.rb

@@ -2,5 +2,16 @@ module Rearview
   class ApplicationController < ActionController::Base
     helper Rearview::Engine.helpers
     before_filter :authenticate_user!
+
+    protected
+
+    def underscore_params
+      self.params = self.params.inject({}.with_indifferent_access) { |a,(k,v)| a[k.to_s.underscore] = v; a }
+    end
+
+    def clean_empty_array_vals(key)
+      params[key].reject! { |m| !m.present? } if params[key].present?
+    end
+
   end
 end

data/app/controllers/rearview/dashboard_children_controller.rb

@@ -1,6 +1,6 @@
 
 module Rearview
-  class DashboardChildrenController < ApplicationController
+  class DashboardChildrenController < Rearview::ApplicationController
     def index
       @dashboards = if params[:dashboard_id]
                       Rearview::Dashboard.find(params[:dashboard_id]).children

data/app/controllers/rearview/dashboards_controller.rb

@@ -1,7 +1,7 @@
 require_dependency "rearview/application_controller"
 
 module Rearview
-  class DashboardsController < ApplicationController
+  class DashboardsController < Rearview::ApplicationController
     respond_to :json
 
     def index

data/app/controllers/rearview/home_controller.rb

@@ -1,6 +1,6 @@
 require_dependency "rearview/application_controller"
 module Rearview
-  class HomeController < ApplicationController
+  class HomeController < Rearview::ApplicationController
     layout false
   end
 end

data/app/controllers/rearview/jobs_controller.rb

@@ -1,6 +1,11 @@
 module Rearview
-  class JobsController < ApplicationController
+  class JobsController < Rearview::ApplicationController
     respond_to :json
+    before_action :underscore_params, only: [:create,:update]
+    before_action only: [:create, :update] do
+      clean_empty_array_vals(:metrics)
+      clean_empty_array_vals(:alert_keys)
+    end
 
     def index
       @jobs = if params[:dashboard_id].present?
@@ -11,13 +16,32 @@ module Rearview
     end
 
     def create
-      upsert(allowed_create_params)
-      render :show
+      dashboard_id = params.delete("dashboard_id")
+      @job = Rearview::Job.new(job_create_params)
+      @job.deep_validation = true
+      @job.user_id = current_user.id
+      @job.dashboard = Rearview::Dashboard.find(dashboard_id.to_i)
+      if @job.save
+        @job.sync_monitor_service
+        render :show
+      else
+        render :show, status: 422
+      end
     end
 
     def update
-      upsert(allowed_update_params)
-      render :show
+      @job = Rearview::Job.find(params[:id])
+      @job.deep_validation = true
+      dashboard_id = params.delete("dashboard_id")
+      if dashboard_id.present? && dashboard_id.to_i!=@job.app_id
+        @job.dashboard = Rearview::Dashboard.find(dashboard_id.to_i)
+      end
+      if @job.update_attributes(job_update_params)
+        @job.sync_monitor_service
+        render :show
+      else
+        render :show, status: 422
+      end
     end
 
     def destroy
@@ -49,32 +73,12 @@ module Rearview
 
     private
 
-    def upsert(filtered_params)
-      @job = Rearview::Job.find_or_initialize_by(id: params[:id])
-      dashboard_id = filtered_params.delete("dashboard_id")
-      if dashboard_id.present? && dashboard_id.to_i!=@job.app_id
-        @job.dashboard = Rearview::Dashboard.find(dashboard_id.to_i)
-      end
-      @job.update_attributes!(filtered_params)
-      @job.sync_monitor_service
-    end
-
-    def allowed_create_params
-      filtered_params = underscore_params
-      filtered_params.delete_if { |k,v|
-        ["controller","job_type","version","action","job","id","format","created_at","modified_at"].include?(k)
-      }
-    end
-
-    def allowed_update_params
-      filtered_params = underscore_params
-      filtered_params.delete_if { |k,v|
-        !["dashboard_id","name","active","alert_keys","cron_expr","error_timeout","minutes","metrics","monitor_expr","to_date","description"].include?(k)
-      }
+    def job_update_params
+      params.permit(:name,:active,{ :alert_keys => []},:cron_expr,:error_timeout,:minutes,{ :metrics => [] },:monitor_expr,:to_date,:description)
     end
 
-    def underscore_params
-      params.inject({}.with_indifferent_access) { |a,(k,v)| a[k.to_s.underscore] = v; a }
+    def job_create_params
+      params.permit(:dashboard_id,:name,:active,{ :alert_keys => []},:cron_expr,:error_timeout,:minutes,{ :metrics => [] },:monitor_expr,:to_date,:description)
     end
 
   end

data/app/controllers/rearview/monitor_controller.rb

@@ -1,9 +1,23 @@
 
 module Rearview
-  class MonitorController < ApplicationController
+  class MonitorController < Rearview::ApplicationController
 
+    before_action only: [:create] do
+      clean_empty_array_vals(:metrics)
+    end
+
+    #
+    # TODO this should be moved to the JobsController#test and the UI changed to push the
+    # monitor job model instead of custom params
+    #
     def create
-      results = Rearview::MonitorRunner.run(params[:metrics],params[:monitorExpr],params[:minutes],{},false,params[:toDate],true)
+      metrics_validator = Rearview::MetricsValidator.new({attributes: [:metrics]})
+      @errors = params[:metrics].inject([]) { |a,v| a << "Metrics contains an invalid metric: #{v}" unless(metrics_validator.metric_valid?(v)); a }
+      results = if @errors.empty?
+                  Rearview::MonitorRunner.run(params[:metrics],params[:monitorExpr],params[:minutes],{},false,params[:toDate],true)
+                else
+                  { }
+                end
       @monitor_output = Rearview::MonitorRunner.normalize_results(results)
     end
 

data/app/controllers/rearview/user_controller.rb

@@ -1,7 +1,7 @@
 require_dependency "rearview/application_controller"
 
 module Rearview
-  class UserController < ApplicationController
+  class UserController < Rearview::ApplicationController
     respond_to :json
     def show
       @user = current_user
@@ -13,8 +13,8 @@ module Rearview
       @user = current_user
       if preferences.present?
         @user.preferences = preferences
-        @user.save!
       end
+      @user.save!
       render :show
     end
   end

data/app/helpers/rearview/application_helper.rb

@@ -1,6 +1,6 @@
 module Rearview
   module ApplicationHelper
-    def rearview_static_path(segment)
+    def rearview_static_path(segment=nil)
       prefix = if Rails.env.development?
                "/rearview-src"
                else
@@ -8,12 +8,12 @@ module Rearview
                end
       ( segment.present? ? prefix + segment : prefix )
     end
-    def rearview_link_tag(href,options)
+    def rearview_link_tag(href,options={})
       options = options.symbolize_keys
       options[:href] = rearview_static_path(href)
       tag("link",options)
     end
-    def rearview_img_tag(source,options)
+    def rearview_img_tag(source,options={})
       options = options.symbolize_keys
       options[:src] = rearview_static_path("/img"+source)
       tag("img", options)

data/app/mailers/rearview/alert_mailer.rb

@@ -1,5 +1,3 @@
-java_import "org.apache.commons.validator.EmailValidator"
-
 module Rearview
   class AlertMailer < ActionMailer::Base
     default from: Rearview.config.default_from

data/app/mailers/rearview/metrics_validation_mailer.rb

@@ -0,0 +1,12 @@
+
+module Rearview
+  class MetricsValidationMailer < ActionMailer::Base
+    default from: Rearview.config.default_from
+    def validation_failed_email(recipient, job)
+      @job = job
+      mail(:to => recipient, :subject => "[Rearview ALERT] invalid metrics for #{@job.name}")
+    end
+  end
+end
+
+

data/app/models/rearview/job.rb

@@ -10,7 +10,12 @@ module Rearview
     make_constants_module :status,
       :constants => [:success,:failed,:error,:graphite_error,:graphite_metric_error,:security_error]
 
-    attr_accessible :created_at, :updated_at, :name, :active, :last_run, :cron_expr, :status, :user_id, :alert_keys, :deleted_at, :error_timeout, :next_run, :description, :app_id, :metrics, :monitor_expr, :minutes, :to_date
+    attr_writer :deep_validation
+
+    attr_accessible :created_at, :updated_at, :name, :active, :last_run,
+      :cron_expr, :status, :user_id, :alert_keys, :deleted_at, :error_timeout,
+      :next_run, :description, :app_id, :metrics, :monitor_expr, :minutes,
+      :to_date
 
     belongs_to :dashboard, :foreign_key => :app_id
     belongs_to :user
@@ -25,8 +30,9 @@ module Rearview
     before_destroy :unschedule
 
     validates :app_id, :cron_expr, :name, :metrics, :presence => true
-    validate :valid_cron_expression
-    validate :valid_alert_keys
+    validates :cron_expr, :'rearview/cron_expression' => true, :if => :deep_validation?
+    validates :metrics, :'rearview/metrics' => true, :if => :deep_validation?
+    validate :valid_alert_keys, :if => :deep_validation?
 
     scope :schedulable, -> { where(:active=>true) }
 
@@ -110,12 +116,6 @@ module Rearview
       end
     end
 
-    def valid_cron_expression
-      if cron_expr.present? && !Rearview::CronHelper.valid_expression?(cron_expr)
-        errors.add(:cron_expr, "not a valid cron expression")
-      end
-    end
-
     def valid_alert_keys
       if alert_keys.present?
         schemes = Rearview::Alerts.registry.keys
@@ -124,15 +124,15 @@ module Rearview
             uri = URI(key)
             scheme = uri.scheme
             unless scheme.present? && schemes.include?(scheme)
-              errors.add(:alert_keys,"unsupported scheme")
+              errors.add(:alert_keys,"#{key} is not a supported alert type")
             else
               scheme_class = Rearview::Alerts.registry[scheme]
               unless scheme_class.key?(key)
-                errors.add(:alert_keys,"#{scheme} URI is invalid")
+                errors.add(:alert_keys,"#{key} is invalid for supported alert type")
               end
             end
-          rescue URI::InvalidURIError
-            errors.add(:alert_keys,"invalid URI")
+          rescue URI::InvalidURIError, URI::InvalidComponentError
+            errors.add(:alert_keys,"#{key} is an invalid URI")
           end
         end
       end
@@ -154,6 +154,10 @@ module Rearview
       end
     end
 
+    def deep_validation?
+      @deep_validation
+    end
+
     protected
 
     def report_transition(transition)

data/app/views/rearview/home/show.html.erb

@@ -41,10 +41,12 @@
         <section class='delete-monitor-wrap'></section>
         <section class='reset-monitor-wrap'></section>
         <section class='add-monitor-wrap'></section>
+        <section class='settings-wrap'></section>
         <section class='secondary-nav-wrap'></section>
         <script type='text/javascript'>
             var rearview     = {};
             rearview.version = '<%= Rearview::VERSION %>';
+            rearview.path = '<%= rearview_static_path %>';
             <% if Rails.env.development? %>
             rearview.cache   = false;
             <% end %>

data/app/views/rearview/jobs/_job.json.jbuilder

@@ -2,3 +2,4 @@ json.(job,:id,:user_id,:name,:cron_expr,:metrics,:monitor_expr,:minutes,:to_date
 json.dashboardId job.app_id
 json.createdAt job.created_at.to_i
 json.modifiedAt job.updated_at.to_i
+json.errors job.errors.full_messages

data/app/views/rearview/metrics_validation_mailer/validation_failed_email.text.erb

@@ -0,0 +1,13 @@
+ALERT: Job has (<%= @job.errors[:metrics].count %>) invalid <%= "metric".pluralize(@job.errors[:metrics].count) %>
+
+Monitor: <%= @job.name %>
+Description: <%= @job.description.nil? ? "None" : @job.description %>
+
+Alerted On: <%= Time.now.utc %>
+Direct Link: <%= Rearview::UrlHelper.job_url(@job) %>
+
+The following metric(s) are no longer valid in graphite:
+
+<% @job.errors[:metrics].each do |metric_error| %>
+<%= metric_error.match(/metric: (.*)$/).try(:[],1) %>
+<% end %>

data/app/views/rearview/monitor/create.json.jbuilder

@@ -3,4 +3,5 @@ json.key_format! :underscore
 json.status @monitor_output[:status]
 json.output @monitor_output[:output]
 json.graph_data @monitor_output[:graph_data]
+json.errors @errors
 

data/db/migrate/20131106162900_base_schema.rb

@@ -17,13 +17,13 @@ class BaseSchema < ActiveRecord::Migration
       t.integer   "job_id",                           :default => 0, :null => false
       t.datetime "created_at"
       t.datetime "updated_at"
-      t.text      "data",       :limit => 2147483647,                :null => false
+      t.text      "data",       :limit => 1073741823,                :null => false
     end
 
     create_table "job_errors", :force => true do |t|
       t.integer   "job_id"
       t.datetime "created_at"
-      t.text      "message",         :limit => 2147483647
+      t.text      "message",         :limit => 1073741823
       t.string    "status"
       t.datetime  "last_alerted_at"
       t.datetime "updated_at"

data/lib/generators/templates/rearview.rb

@@ -29,10 +29,20 @@ Rearview.configure do |config|
   # period the monitor script will be terminated.
   config.sandbox_timeout = 10
 
-  # The url to your graphite web server
+  # The connection information for your graphite web server
   # ex:
-  # config.graphite_url="http://graphite.mycompany.com"
-  config.graphite_url = nil
+  # config.graphite_connection = { url: 'http://graphite.mycom.com' }
+  # config.graphite_connection = {
+  #   url: 'http://graphite.mycompany.com'
+  #   ssl: {
+  #     verify: true,
+  #   }
+  #   basic_auth: {
+  #     user: 'admin',
+  #     password: 'xyzzy'
+  #   }
+  #  }
+  config.graphite_connection = { url: nil }
 
   # This is the email from: address used when sending alerts
   # ex:
@@ -42,7 +52,7 @@ Rearview.configure do |config|
   # The url options for rearview application host. Required to generate
   # monitor alerts with correct URL references.
   # ex:
-  # config.default_url_options = { host: 'rearview.mycomopany.com', protocol: 'https'}
+  # config.default_url_options = { host: 'rearview.mycompany.com', protocol: 'https'}
   config.default_url_options = { host: 'localhost', port: '3000'}
 
   # Enable collection of stats for rearview itself. This will send JVM and monitor related
@@ -51,9 +61,15 @@ Rearview.configure do |config|
   config.enable_stats=false
 
   # The connection information for the stats service. Only necessary if enable_stats is true.
-  # ex:
-  # config.statsd_connection = { host: 'statsd.mycompany.com', port: 8125 , namespace: 'rearview' }
-  #
+  config.statsd_connection = { host: 'statsd.mycompany.com', port: 8125 , namespace: 'rearview' }
+
+  # Enable periodic checking for invalid metrics used in monitors.
+  config.enable_metrics_validator = false
+
+  # Set schedule for checking for invalid metrics (cron expression). Recommended only once per day.
+  # see http://quartz-scheduler.org/api/2.0.0/org/quartz/CronExpression.html. Only necessary if
+  # enable_metrics_validator is true.
+  config.metrics_validator_schedule = '* * 23 * *'
 
   case Rails.env
     when "test"
@@ -67,6 +83,7 @@ Rearview.configure do |config|
   if File.basename($0) == "rake"
     config.enable_monitor = false
     config.enable_stats = false
+    config.enable_metrics_validator = false
   end
 
   # Options passed via environment will override anything else set to this point...