rails-server-monitor 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c02a410440fe656a5775b8fcbf634cde598ccfbdc931ea6df0c100fd52b566
-  data.tar.gz: d9f857b9f0cfa8da45543c2f9b5a7fdb8aa39388bb31a6020dfe66c9c90984e6
+  metadata.gz: 033a9d13d063db61dac341da383d08f124f71b1a4a7dcb6c3b971d33c8fb5b7b
+  data.tar.gz: 9a3cba2a858b60e041783670aedcc2350646aeaee0a8edb5b83980d0ae9303ce
 SHA512:
-  metadata.gz: 68a29e610bb3bb98ba4381c930301fd39c74e9195eeaf173d8803f58dec0152f9076a2897f88f917119602ef6ee0567f53ae53aace1edf0b2cc905c15e14e62f
-  data.tar.gz: b17b84868d09d28008763b049601124eac946b34d42d3b3f20aa73e2e38bf0a3bb3f7f983c01db6a8ca19645ef12494c898250f8f7cec5c5c9d06c561b9db46e
+  metadata.gz: da14da9f1a6edbea7dfbadeebba08f0166e4febbe2b8762efa1915d7b703f6c68a9294d2250f9b7e30eb26174182eb15bd530a0b8c6019bf6992515b8e411304
+  data.tar.gz: a7c82165c201bf319a4a3f31f626f7093c93d42f0a81774dd3513bb3659c3479d0e6e04ea1052e870102b4814a054b2ce3c89253be8d40a2813e76b80375fe60

data/README.md

@@ -1,28 +1,130 @@
-# Rails::Server::Monitor
-Short description and motivation.
+# Rails Server Monitor
+A performance dashboard for rails applications which work with one or multiple servers at once.
+Stats can be collected from a Rack application or Sidekiq.
 
-## Usage
-How to use my plugin.
+[See it in action](https://rails-sever-monitor.herokuapp.com)
 
-## Installation
-Add this line to your application's Gemfile:
+![demo](https://github.com/personal-social-media/rails-server-monitor/raw/master/resources/screenshot-dashboard.jpg)
+![demo](https://github.com/personal-social-media/rails-server-monitor/raw/master/resources/screenshot1.jpg)
 
+## Usage
+#### 1)
 ```ruby
-gem 'rails-server-monitor'
+gem 'rails-server-monitor', require: "rails_server_monitor"
 ```
 
-And then execute:
+#### 2) generate Rails Server Monitor tables
 ```bash
-$ bundle
+rails g rails_server_monitor:install
+rails db:migrate
 ```
 
-Or install it yourself as:
-```bash
-$ gem install rails-server-monitor
+#### 3) hook Rails Server Monitor's rack middleware
+```ruby
+# inside config/application.rb
+config.middleware.use RailsServerMonitor::RackMiddleware
+```
+
+#### 4) compile Rails Server Monitor assets locally
+if you aren't using webpacker already
+```shell
+# you don't need to do this in production, it's prepended to rake assets:precompile
+# but you need to do it again after you after you update the gem locally
+rake webpacker:compile 
+```
+
+or if you are using
+
+```ruby
+# inside bin/webpack-dev-server
+require "rails_server_monitor/compile_locally"
+RailsServerMonitor::CompileLocally.compile 
+
+# insert before this before
+# Dir.chdir(APP_ROOT) do
+#   Webpacker::DevServerRunner.run(ARGV)
+# end
+```
+
+#### 5) (Optional) configure gem
+
+```ruby
+# inside config/initializers/rails_server_monitor
+
+RailsServerMonitor.config do |c|
+  c.update_server_interval = 1.hour 
+  c.snapshot_server_interval = 15.minutes
+  c.cleanup_snapshots_after = 90.days
+  c.ignore_workers = %w(MyIgnoredWorker)
+  c.ignore_urls = ["/", /ignored-url/]
+  
+  c.high_cpu_usage_threshold = 95
+  c.low_memory_threshold = 20
+  c.low_free_disk_disk_threshold = 30
+  c.hostname = -> do
+    `hostname`
+  end # how to retrieve server hostname, heroku generates a hostname each time your app reboots
+end
+```
+
+#### 6) Mount engine to routes
+
+```ruby
+# inside config/routes.rb
+constraints LoggedInAsAdmin do
+  mount RailsServerMonitor::Engine => "/system-information"
+end
 ```
 
+Your should define a constraint to protect against unauthorized access
+
+```ruby
+# example LoggedInAsAdmin, this is a basic implementation
+
+class LoggedInAsAdmin
+  def self.matches?(request)
+    AdminUser.find_by(id: request.session[:admin_id]).present?
+  end
+end
+
+
+```
+
+#### 7) (Optional) Add sidekiq middleware
+
+```ruby
+# append to config/sidekiq.rb
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add RailsServerMonitor::SidekiqMiddleware
+  end
+end
+```
+
+### 8) Result
+
+you should now go to http://localhost:3000/system-information
+
 ## Contributing
-Contribution directions go here.
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/personal-social-media/rails-server-monitor/issues)
+- Fix bugs and [submit pull requests](https://github.com/personal-social-media/rails-server-monitor/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+### Development
+
+```shell
+# fork project, clone
+bundle install
+yarn install
+
+bin/start # to start local server
+bin/rspec # to run specs
+```
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/rails_server_monitor/servers_controller.rb

@@ -6,11 +6,20 @@ module RailsServerMonitor
 
     def show
       @server = current_server
-      @chart = RailsServerMonitor::ChartForServer.new(@server)
+      @chart = RailsServerMonitor::ChartForServer.new(@server, timeline: params[:timeline])
 
       @title = @server.display_name
     end
 
+    def update
+      update_params = params.require(:server).permit(:custom_name, :custom_description)
+      current_server.update!(update_params)
+      redirect_to server_path(current_server)
+
+    rescue ActiveRecord::RecordInvalid => e
+      render json: { error: e.message }, status: 422
+    end
+
     def current_server
       @current_server ||= RailsServerMonitor::Server.find_by(id: params[:id])
     end

data/app/helpers/rails_server_monitor/application_helper.rb

@@ -25,5 +25,9 @@ module RailsServerMonitor
 
       stylesheet_pack_tag(name, **options)
     end
+
+    def server_version
+      RailsServerMonitor::VERSION
+    end
   end
 end

data/app/middlewares/rails_server_monitor/sidekiq_middleware.rb

@@ -2,16 +2,18 @@
 
 module RailsServerMonitor
   class SidekiqMiddleware
-    def call(worker, *opts)
-      return if ignore_worker?(worker)
+    def call(worker, *_)
+      return yield if ignore_worker?(worker)
 
-      server = RailsServerMonitor::ServerSetup.new.call
-      snapshot = RailsServerMonitor::TakeSnapshot.new(server)
+      yield.tap do
+        server = RailsServerMonitor::ServerSetup.new.call
+        snapshot = RailsServerMonitor::TakeSnapshot.new(server)
 
-      if snapshot.can_take_snapshot?
-        snapshot.call
+        if snapshot.can_take_snapshot?
+          snapshot.call
 
-        RailsServerMonitor::Cleanup.new.call
+          RailsServerMonitor::Cleanup.new.call
+        end
       end
     end
 

data/app/models/rails_server_monitor/server.rb

@@ -20,8 +20,14 @@ module RailsServerMonitor
              foreign_key: :rails_server_monitor_server_id,
              dependent: :delete_all
 
+    before_save :squish_text
+
     def display_name
       @display_name ||= custom_name.present? ? custom_name : hostname
     end
+
+    def squish_text
+      self.custom_name = self.custom_name&.squish
+    end
   end
 end

data/app/services/rails_server_monitor/chart_for_server.rb

@@ -2,10 +2,11 @@
 
 module RailsServerMonitor
   class ChartForServer
+    AVAILABLE_TIMELINES = %w(today week month all)
     attr_reader :server, :timeline
-    def initialize(server, timeline: :today)
+    def initialize(server, timeline:)
       @server = server
-      @timeline = timeline
+      @timeline = timeline.blank? ? "today" : timeline
     end
 
     def render_chart
@@ -23,10 +24,9 @@ module RailsServerMonitor
     end
 
     def today?
-      timeline == :today
+      timeline == "today"
     end
 
-
     def last_record
       @last_record = scope.last
     end
@@ -36,6 +36,12 @@ module RailsServerMonitor
       query = server.server_snapshots.order(id: :asc)
       if today?
         query = query.where("created_at > ?", 1.day.ago)
+      elsif timeline == "week"
+        query = query.where("created_at > ?", 7.day.ago)
+      elsif timeline == "month"
+        query = query.where("created_at > ?", 30.day.ago)
+      else
+        query = query.all
       end
       @scope = query.to_a
     end

data/app/services/rails_server_monitor/server_setup.rb

@@ -19,7 +19,7 @@ module RailsServerMonitor
 
     private
       def hostname
-        @hostname ||= `hostname`.squish
+        @hostname ||= config.hostname.call.squish
       end
 
       def update_server

data/app/views/layouts/rails_server_monitor/application.html.erb

@@ -9,17 +9,22 @@
   <%= safe_render_css "rails-server-application", 'data-turbolinks-track': "reload" %>
 </head>
 <body>
+<div class="flex min-h-screen flex-col justify-between">
+  <div class="flex">
+    <div class="overflow-y-auto fixed top-0 left-0 bottom-0 bg-white w-1/5">
+      <%= render RailsServerMonitor::LeftbarComponent.new(ctx: self) %>
+    </div>
+    <div class="w-1/5 mr-4"></div>
 
-<div class="flex">
-  <div class="overflow-y-auto fixed top-0 left-0 bottom-0 bg-white w-1/5">
-    <%= render RailsServerMonitor::LeftbarComponent.new(ctx: self) %>
-  </div>
-  <div class="w-1/5 mr-4"></div>
+    <div class="flex-1">
+      <%= yield %>
+    </div>
 
-  <div class="flex-1">
-    <%= yield %>
+  </div>
+  <div class="p-4 flex">
+    <div class="w-1/5 mr-4"></div>
+    <%= render "rails_server_monitor/page/footer" %>
   </div>
 </div>
-
 </body>
 </html>

data/app/views/rails_server_monitor/page/_footer.html.erb

@@ -0,0 +1,8 @@
+<div class="flex-1">
+  <a href="https://github.com/personal-social-media/rails-server-monitor" target="_blank" class="flex items-center mx-auto w-1/4">
+    <i class="fab fa-github fa-3x"></i>
+    <span class="ml-2">
+      Rails Server Monitor V<%= server_version %>
+    </span>
+  </a>
+</div>

data/app/views/rails_server_monitor/servers/show.html.erb

@@ -3,11 +3,8 @@
    <%= @server.display_name %>
  </div>
 
-
   <div class="flex mt-4">
-    <%= content_tag :div, class: "#{@chart.today? ? "w-1/2" : "w-full"}" do %>
-      <%= line_chart @chart.render_chart %>
-    <% end %>
+    <%= render(partial: "rails_server_monitor/servers/show/chart") %>
 
     <% if @chart.today? && @chart.last_record.present? %>
       <div class="w-1/2 p-2">
@@ -49,7 +46,7 @@
     <% end %>
   </div>
 
-  <div class="mt-20">
+  <%= form_with model: @server, html: { class: "mt-20" } do |f| %>
     <div class="mb-2 text-xl">
       Sever information:
     </div>
@@ -64,13 +61,13 @@
         Custom name:
       </div>
       <div class="p-1">
-        <%= @server.custom_name %>
+        <%= f.text_field :custom_name, class: "border border-solid border-gray-200 p-2 focus:border-gray-300 w-full" %>
       </div>
       <div class="bg-blue-300 text-gray-800 p-1">
         Custom description:
       </div>
       <div class="p-1">
-        <%= @server.custom_description %>
+        <%= f.text_area :custom_description, class: "border border-solid border-gray-200 p-2 focus:border-gray-300 w-full" %>
       </div>
       <div class="mb-2 text-xl">
         OS information
@@ -110,7 +107,7 @@
       )) %>
 
       <%= render(RailsServerMonitor::ServerTableRow.new(
-        title: "CPU Codes",
+        title: "CPU Cores",
         value: @server.system_cpu_cores
       )) %>
 
@@ -129,5 +126,9 @@
         value: "#{@server.system_hdd_available_in_gb} GB"
       )) %>
     </div>
-  </div>
+
+    <div class="mt-20 w-1/2">
+      <%= f.submit "Save custom information", class: "p-2 w-full bg-blue-500 text-white" %>
+    </div>
+  <% end %>
 </div>

data/app/views/rails_server_monitor/servers/show/_chart.html.erb

@@ -0,0 +1,10 @@
+<%= content_tag :div, class: "#{@chart.today? ? "w-1/2" : "w-full"}" do %>
+  <%= line_chart @chart.render_chart %>
+
+  <div class="flex justify-between">
+    <% RailsServerMonitor::ChartForServer::AVAILABLE_TIMELINES.each do |timeline| %>
+      <%= link_to timeline.humanize, server_path(@server, timeline: timeline),
+                  class: "#{@chart.timeline == timeline ? "bg-blue-500 text-white" : "bg-gray-300 text-gray-800" } p-2 rounded hover:bg-blue-400"  %>
+    <% end %>
+  </div>
+<% end %>

data/bin/rails

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/rails/server/monitor/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+# require "active_job/railtie"
+require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+require "rails/engine/commands"

data/bin/rspec

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+cd dummy
+
+bin/rspec

data/bin/start

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+cd dummy
+bundle exec foreman start

data/bin/webpack

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"]  ||= "development"
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/webpack_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Webpacker::WebpackRunner.run(ARGV)
+end