perus 0.1.0

data/lib/perus/server/app.rb

@@ -0,0 +1,304 @@
+require 'sinatra/base'
+require 'sinatra/synchrony'
+require 'sinatra/reloader'
+require 'sequel'
+require 'json'
+require 'uri'
+
+module Perus::Server
+    class App < Sinatra::Application
+        #----------------------
+        # config
+        #----------------------
+        register Sinatra::Synchrony
+        helpers Helpers
+
+        configure do
+            set :root, File.join(__dir__)
+        end
+
+        configure :development do
+            register Sinatra::Reloader
+        end
+
+        before do
+            load_site_information
+        end
+
+
+        #----------------------
+        # admin pages
+        #----------------------
+        extend Admin
+
+        admin :system
+        admin :group
+        admin :alert
+        admin :config, true
+        admin :script, true
+
+        # static admin index page
+        get '/admin' do
+            redirect '/admin/systems'
+        end
+
+        post '/admin/scripts/:id/commands' do
+            script = Script.with_pk!(params['id'])
+            script_command = ScriptCommand.new
+            script_command.script_id = params['id']
+            script_command.order = script.largest_order + 1
+
+            command_config = CommandConfig.create_with_params(params)
+            script_command.command_config_id = command_config.id
+
+            begin
+                script_command.save
+            rescue
+                if script_command.command_config_id
+                    CommandConfig.with_pk!(script_command.command_config_id).destroy
+                end
+            end
+
+            redirect "#{url_prefix}admin/scripts/#{params['id']}"
+        end
+
+        post '/admin/scripts/:script_id/commands/:id' do
+            script_command = ScriptCommand.with_pk!(params['id'])
+            if params['action'] == 'Delete'
+                script_command.destroy
+            elsif params['action'] == 'Update'
+                script_command.command_config.update_options!(params)
+            end
+
+            redirect "#{url_prefix}admin/scripts/#{params['script_id']}"
+        end
+
+        post '/admin/configs/:id/metrics' do
+            config = Config.with_pk!(params['id'])
+            config_metric = ConfigMetric.new
+            config_metric.config_id = params['id']
+            config_metric.order = config.largest_order + 1
+
+            command_config = CommandConfig.create_with_params(params)
+            config_metric.command_config_id = command_config.id
+
+            begin
+                config_metric.save
+            rescue
+                if config_metric.command_config_id
+                    CommandConfig.with_pk!(config_metric.command_config_id).destroy
+                end
+            end
+
+            redirect "#{url_prefix}admin/configs/#{params['id']}"
+        end
+
+        post '/admin/configs/:config_id/metrics/:id' do
+            config_metric = ConfigMetric.with_pk!(params['id'])
+            if params['action'] == 'Delete'
+                config_metric.destroy
+            elsif params['action'] == 'Update'
+                config_metric.command_config.update_options!(params)
+            end
+
+            redirect "#{url_prefix}admin/configs/#{params['config_id']}"
+        end
+
+
+        #----------------------
+        # API
+        #----------------------
+        # csv for graphs shown on system page
+        get '/systems/:id/values' do
+            system  = System.with_pk!(params['id'])
+            metrics = params[:metrics].to_s.split(',')
+
+            # find all values for the requested metrics
+            dataset = system.values_dataset.where(metric: metrics)
+
+            # the graphing library requires multiple series to be provided in
+            # row format (date, series 1, series 2 etc) so each value is
+            # grouped into a timestamp update window
+            updates = dataset.all.group_by(&:timestamp)
+
+            # loop from start to end generating the response csv
+            timestamps = updates.keys.sort
+            csv = "Date,#{params['metrics']}\n"
+
+            timestamps.each do |timestamp|
+                date = Time.at(timestamp).strftime('%Y-%m-%d %H:%M:%S')
+                csv << date << ','
+                
+                values = Array.new(metrics.length)
+                records = updates[timestamp]
+
+                records.each do |record|
+                    values[metrics.index(record.metric)] = record.num_value
+                end
+
+                csv << values.join(',') << "\n"
+            end
+
+            csv
+        end
+
+        # receive data from a client
+        post '/systems/:id/ping' do
+            timestamp = Time.now.to_i
+
+            # update the system with its last known ip and update time
+            system = System.with_pk!(params['id'])
+            system.last_updated = timestamp
+            system.ip = request.ip
+
+            # errors is either nil or a hash of the format - module: [err, ...]
+            system.save_metric_errors(params, timestamp)
+
+            # add each new value, a later process cleans up old values
+            system.save_values(params, timestamp)
+
+            # save action return values and prevent them from running again
+            system.save_actions(params, timestamp)
+
+            # ip, last updated, uploads and metrics are now updated. these are
+            # stored on the system.
+            system.save
+            content_type :json
+            {success: true}.to_json
+        end
+
+        # system config
+        get '/systems/:id/config' do
+            system = System.with_pk!(params['id'])
+            config = {
+                metrics: system.config.metric_hashes,
+                actions: system.pending_actions.map(&:config_hash).flatten
+            }
+            content_type :json
+            config.to_json
+        end
+
+        # render all errors in html to replace the shortened subset on the system page
+        get '/systems/:id/errors' do
+            system = System.with_pk!(params['id'])
+            errors = system.collection_errors
+            erb :errors, layout: false, locals: {errors: errors}
+        end
+
+        # clear collection errors
+        delete '/systems/:id/errors' do
+            system = System.with_pk!(params['id'])
+            system.collection_errors.each(&:delete)
+            redirect "#{url_prefix}systems/#{system.id}"
+        end
+
+        # create a new action
+        post '/systems/:id/actions' do
+            action = Action.new
+            action.system_id = params['id']
+
+            if params['script_id']
+                action.script_id = params['script_id']
+            else
+                command_config = CommandConfig.create_with_params(params)
+                action.command_config_id = command_config.id
+            end
+
+            begin
+                action.save
+            rescue
+                if action.command_config_id
+                    CommandConfig.with_pk!(action.command_config_id).destroy
+                end
+            end
+
+            redirect "#{url_prefix}systems/#{params['id']}#actions"
+        end
+
+        # delete an action. deletion also clears any uploaded files.
+        delete '/systems/:system_id/actions/:id' do
+            action = Action.with_pk!(params['id'])
+            action.destroy
+            redirect "#{url_prefix}systems/#{params['system_id']}#actions"
+        end
+
+
+        #----------------------
+        # frontend
+        #----------------------
+        # overview
+        get '/' do
+            systems = System.all
+            alerts = Alert.all
+            results = alerts.collect do |alert|
+                begin
+                    alert.execute(systems)
+                rescue => e
+                    "An error occurred running this alert: #{e.inspect}"
+                end
+            end
+
+            @alerts = Hash[alerts.zip(results)]
+            erb :index
+        end
+
+        # list of systems
+        get '/systems' do
+            @systems = System.all.group_by(&:orientation)
+            @title = 'All Systems'
+            erb :systems
+        end
+
+        # list of systems by group
+        get '/groups/:id/systems' do
+            group = Group.with_pk!(params['id'])
+            @systems = group.systems.group_by(&:orientation)
+            @title = group.name
+            erb :systems
+        end
+
+        # info page for a system
+        get '/systems/:id' do
+            @system  = System.with_pk!(params['id'])
+            @uploads = @system.upload_urls
+            metrics = @system.metrics
+
+            # we're only interested in the latest value for string metrics
+            @str_metrics = {}
+            metrics.select(&:string?).each do |metric|
+                value = @system.latest(metric.name)
+                name = "#{metric.name.titlecase}:"
+                @str_metrics[name] = value ? value.str_value : ''
+            end
+
+            # numeric values are grouped together by their first name component
+            # and drawn on a graph. e.g cpu_all and cpu_chrome are shown together
+            num_metrics = metrics.select(&:numeric?).map(&:name)
+            @num_metrics = num_metrics.group_by {|n| n.split('_')[0]}
+
+            # make links clickable
+            @links = @system.links.to_s.gsub("\n", "<br>")
+            URI::extract(@links).each {|uri| @links.gsub!(uri, %Q{<a href="#{uri}">#{uri}</a>})}
+
+            # last updated is a timestamp, conver
+            if @system.last_updated
+                @last_updated = Time.at(@system.last_updated).ctime
+            else
+                @last_updated = 'never updated'
+            end
+
+            @errors = @system.collection_errors_dataset.limit(5).all
+            @total_error_count = @system.collection_errors_dataset.count
+            @scripts = Script.all
+            erb :system
+        end
+
+        # helper to make uploads publicly accessible
+        get '/uploads/*' do
+            path = params['splat'][0]
+            raise 'Invalid path' if path.include?('..')
+            full_path = File.join(Server.options.uploads_dir, path)
+            send_file full_path
+        end
+    end
+end

data/lib/perus/server/db.rb

@@ -0,0 +1,29 @@
+require 'sequel'
+require 'sequel/plugins/serialization'
+
+module Perus::Server
+    module DB
+        def self.start
+            Sequel.extension :migration
+            Sequel.extension :inflector
+
+            # connect/create the database and run any new migrations
+            @db = Sequel.sqlite(Server.options.db_path, integer_booleans: true)
+            Sequel::Migrator.run(@db, File.join(__dir__, 'migrations'))
+
+            # load models - these rely on an existing db connection
+            require File.join(__dir__, 'models', 'system')
+            require File.join(__dir__, 'models', 'config')
+            require File.join(__dir__, 'models', 'value')
+            require File.join(__dir__, 'models', 'group')
+            require File.join(__dir__, 'models', 'error')
+            require File.join(__dir__, 'models', 'alert')
+            require File.join(__dir__, 'models', 'action')
+            require File.join(__dir__, 'models', 'metric')
+            require File.join(__dir__, 'models', 'script')
+            require File.join(__dir__, 'models', 'command_config')
+            require File.join(__dir__, 'models', 'script_command')
+            require File.join(__dir__, 'models', 'config_metric')
+        end
+    end
+end

data/lib/perus/server/form.rb

@@ -0,0 +1,73 @@
+module Perus::Server
+    class Form
+        def initialize(record)
+            @record = record
+        end
+
+        def field(field, type = nil, options = nil)
+            field = field.to_s
+
+            if type.nil?
+                if @record.class.association_reflections.include?(field.to_sym)
+                    type = 'association'
+                else
+                    type = @record.db_schema[field.to_sym][:db_type]
+                end
+            end
+
+            html = "<p><label for=\"#{field}\">#{field.titlecase}:</label><span>"
+
+            case type
+            when 'varchar(255)'
+                html << input(field, options)
+            when 'text'
+                html << textarea(field, options)
+            when 'association'
+                html << association(field, options)
+            when 'select'
+                html << select(field, options)
+            end
+
+            # return the field plus any errors
+            html << "</span></p>" << errors_for(field)
+        end
+
+        def input(field, options)
+            "<input type=\"text\" name=\"record[#{field}]\" value=\"#{@record.send(field)}\">"
+        end
+
+        def textarea(field, options)
+            "<textarea name=\"record[#{field}]\">#{@record.send(field)}</textarea>"
+        end
+
+        def association(field, options)
+            reflection  = @record.class.association_reflections[field.to_sym]
+            other_model = reflection[:class_name].constantize
+            id_field    = reflection[:key]
+
+            values = other_model.all.collect do |record|
+                [record.id, record.name]
+            end
+
+            select(id_field, values)
+        end
+
+        def select(field, options)
+            existing = @record.send(field)
+            option_rows = options.collect do |(value, name)|
+                selected = existing == value ? 'selected' : ''
+                "<option value=\"#{value}\" #{selected}>#{name || value}</option>"
+            end
+
+            "<select name=\"record[#{field}]\">#{option_rows.join("\n")}</select>"
+        end
+
+        def errors_for(field)
+            errors = @record.errors.on(field.to_sym)
+            return '' unless errors
+            field_name = field.titlecase
+            descriptions = errors.map {|error| "#{field_name} #{error}"}
+            "<p class=\"errors\">#{descriptions.join(', ')}</p>"
+        end
+    end
+end

data/lib/perus/server/helpers.rb

@@ -0,0 +1,36 @@
+module Perus::Server
+    module Helpers
+        def load_site_information
+            @site_name = Server.options.site_name
+            @groups = Group.all
+        end
+
+        def nav_item(path, name, li = true)
+            if path.start_with?('/admin/')
+                klass = request.path_info.start_with?(path) ? 'selected' : ''
+            else
+                klass = request.path_info == path ? 'selected' : ''
+            end
+            anchor = "<a class=\"#{klass}\" href=\"#{path}\">#{name}</a>"
+            li ? "<li>#{anchor}</li>" : anchor
+        end
+
+        def command_actions
+            commands = Perus::Pinger::Command.subclasses.reject(&:metric?)
+            commands.reject(&:abstract?)
+        end
+
+        def command_metrics
+            metrics = Perus::Pinger::Command.subclasses.select(&:metric?)
+            metrics.reject(&:abstract?)
+        end
+
+        def clean_arrows(text)
+            text.gsub('<', '&lt;').gsub('>', '&gt;')
+        end
+
+        def url_prefix
+            Server.options.url_prefix
+        end
+    end
+end

data/lib/perus/server/migrations/001_create_systems.rb

@@ -0,0 +1,20 @@
+Sequel.migration do
+    up do
+        create_table(:systems) do
+            primary_key :id
+            String  :name, null: false, unique: true
+            String  :logical_name
+            String  :orientation
+            Integer :group_id
+            Integer :config_id
+            String  :links, text: true
+            String  :ip
+            String  :metrics, text: true
+            Integer :last_updated
+        end
+    end
+
+    down do
+        drop_table(:systems)
+    end
+end

data/lib/perus/server/migrations/002_create_configs.rb

@@ -0,0 +1,12 @@
+Sequel.migration do
+    up do
+        create_table(:configs) do
+            primary_key :id
+            String :name, null: false, unique: true
+        end
+    end
+
+    down do
+        drop_table(:configs)
+    end
+end

data/lib/perus/server/migrations/003_create_values.rb

@@ -0,0 +1,23 @@
+Sequel.migration do
+    up do
+        create_table(:values) do
+            primary_key :id
+            Integer :system_id, null: false
+            Integer :timestamp, null: false
+            String  :metric, null: false
+            Float   :num_value
+            String  :str_value
+
+            # a covering index is used so no secondary lookups are required
+            # when querying for all metric values for a system. queries are
+            # constrained on system_id only. using timestamp as the second
+            # component of the index implicitly sorts the rows by timestamp
+            # satisfying `order by timestamp'.
+            index [:system_id, :timestamp, :metric, :num_value, :str_value]
+        end
+    end
+
+    down do
+        drop_table(:values)
+    end
+end

data/lib/perus/server/migrations/004_create_groups.rb

@@ -0,0 +1,12 @@
+Sequel.migration do
+    up do
+        create_table(:groups) do
+            primary_key :id
+            String  :name, null: false, unique: true
+        end
+    end
+
+    down do
+        drop_table(:groups)
+    end
+end

data/lib/perus/server/migrations/005_create_errors.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+    up do
+        create_table(:errors) do
+            primary_key :id
+            Integer :system_id, null: false
+            Integer :timestamp, null: false
+            String  :module, null: false
+            String  :description, null: false
+        end
+    end
+
+    down do
+        drop_table(:errors)
+    end
+end

data/lib/perus/server/migrations/006_create_alerts.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+    up do
+        create_table(:alerts) do
+            primary_key :id
+            String  :name, null: false, unique: true
+            String  :code, text: true, null: false
+            String  :severity, null: false
+        end
+    end
+
+    down do
+        drop_table(:alerts)
+    end
+end

data/lib/perus/server/migrations/007_create_actions.rb

@@ -0,0 +1,18 @@
+Sequel.migration do
+    up do
+        create_table(:actions) do
+            primary_key :id
+            Integer :system_id, null: false
+            Integer :command_config_id
+            Integer :script_id
+            Integer :timestamp
+            Boolean :success
+            String  :response
+            String  :file, text: true
+        end
+    end
+
+    down do
+        drop_table(:actions)
+    end
+end

data/lib/perus/server/migrations/008_create_metrics.rb

@@ -0,0 +1,16 @@
+Sequel.migration do
+    up do
+        create_table(:metrics) do
+            primary_key :id
+            String  :name, null: false
+            String  :system_id, null: false
+            String  :type, null: false
+            String  :file, text: true
+            index   [:system_id, :name]
+        end
+    end
+
+    down do
+        drop_table(:metrics)
+    end
+end

data/lib/perus/server/migrations/009_create_command_config.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+    up do
+        create_table(:command_configs) do
+            primary_key :id
+            String  :command, null: false
+            String  :options, text: true
+        end
+    end
+
+    down do
+        drop_table(:command_configs)
+    end
+end

data/lib/perus/server/migrations/010_create_scripts.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+    up do
+        create_table(:scripts) do
+            primary_key :id
+            String :name, null: false, unique: true
+            String :description
+        end
+    end
+
+    down do
+        drop_table(:scripts)
+    end
+end

data/lib/perus/server/migrations/011_create_script_commands.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+    up do
+        create_table(:script_commands) do
+            primary_key :id
+            Integer :script_id, null: false
+            Integer :command_config_id, null:false
+            Integer :order, null: false
+        end
+    end
+
+    down do
+        drop_table(:script_commands)
+    end
+end

data/lib/perus/server/migrations/012_create_config_metrics.rb

@@ -0,0 +1,14 @@
+Sequel.migration do
+    up do
+        create_table(:config_metrics) do
+            primary_key :id
+            Integer :config_id, null: false
+            Integer :command_config_id, null:false
+            Integer :order, null: false
+        end
+    end
+
+    down do
+        drop_table(:config_metrics)
+    end
+end