puny-monitor 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef7da3ad71ee116621cfd11bc930e6ab5624aad481afaa024e6e09790916cde4
-  data.tar.gz: d590745c16a3ca947e1a1af8b91931cbf9daec21e9f1703a308b8be7e92e5bf5
+  metadata.gz: b39f83645fed8b173fe448a4c9f93dfc886e15a0c368b0137e315caa001bf414
+  data.tar.gz: 19f2757bb81d07c6d132dc9570e4f4724ad5f69ad8ca06f930a302db6f47ec43
 SHA512:
-  metadata.gz: 345ed87c689aa7c153009f8a3f21fa33778ed97cf1db0a3e60948717ee0906886c4d9eb037a6b4602567354a34c89378f9fa57fb7b1f4a3596024f1580f2b687
-  data.tar.gz: af40c578d0c669f4216e0eaaa456154835819934c79f6befb40ea9200e888eba3854bef9594278644718ab242bc0c9804c862f8bdbca02d1df323ebeae6892e3
+  metadata.gz: 5d76d92559a392db462a141e0350535cbb3dbf3052a17983ca54cb85c7c54d2e980c4d555194616aa0cf6d6031b7091e43d999db171d67f5e2157f1ae1b5886c
+  data.tar.gz: 8017307c65f35ca42c653bfb9a3231af8df5334134b558c1935b9ac8ff34faeee8b2ad7f7c1d116934e2fa5f3ab3b02923d5883c29bad20892095c02cac6a844

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+## [0.2.0] - 2025-08-18
+
+- Add HTTP authentication
+- Upgrade to Ruby 3.4
+
+## [0.1.0] - 2024-09-15
+
+- Initial release

data/README.md

@@ -33,6 +33,20 @@ docker run --rm \
 
 Visit [localhost:4567](http://localhost:4567) to check your system data. To see how to deploy Puny Monitor in a production environment see [Deployment].
 
+## Authentication
+
+Puny monitor supports Basic HTTP Authentication. To enable authentication set both the `PUNY_USERNAME` and `PUNY_PASSWORD` environment variables. For example, using with `docker run`:
+
+```
+docker run --rm \
+  -v=/:/host:ro,rslave -v=puny-data:/puny-monitor/db \
+  -e HOST_PATH=/host \
+  -e PUNY_USERNAME=admin \
+  -e PUNY_PASSWORD=secret \
+  -p 4567:4567 \
+  hschne/puny-monitor:latest
+```
+
 ## Deployment
 
 Puny Monitor was made with [Kamal](https://kamal-deploy.org/) and [Ruby on Rails](https://rubyonrails.org/) in mind. It is recommended that you deploy it as an accessory to your application. Add the following lines to `config/deploy.yml`:
@@ -81,7 +95,14 @@ To put it simply, Puny Monitor replicates [Digital Ocean's Monitoring](https://w
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+To install this gem onto your local machine, run `bundle exec rake install`.  To run Puny Monitor locally use 
+```
+bundle exec rackup
+```
+
+Alternatively, you may use the various docker helpers defined in the [Rakefile].
+
+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
 

data/app/authorization.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PunyMonitor
+  module Authorization
+    def self.included(base)
+      return unless authorize?
+
+      base.use Rack::Auth::Basic, "Puny Monitor" do |username, password|
+        username == self.username && password == self.password
+      end
+    end
+
+    def self.username
+      @username ||= ENV.fetch("PUNY_USERNAME", nil)
+    end
+
+    def self.password
+      @password ||= ENV.fetch("PUNY_PASSWORD", nil)
+    end
+
+    def self.authorize?
+      puts username
+      puts password
+      username && password
+    end
+  end
+end

data/app/models/application_model.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class ApplicationModel < ActiveRecord::Base
+  self.abstract_class = true
+
+  scope :group_by_time, ->(minutes) {
+    interval_seconds = minutes * 60
+    group("strftime('%s', created_at) / #{interval_seconds} * #{interval_seconds}")
+  }
+
+  def self.group_format(minutes)
+    interval_seconds = minutes * 60
+    "strftime('%s', created_at) / #{interval_seconds} * #{interval_seconds}"
+  end
+end

data/app/models/bandwidth.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-class Bandwidth < ActiveRecord::Base
-  class << self
-    def average_usage(start_time, group_by)
-      [
-        { name: "Incoming Mbps", data: average_for_period(:incoming_mbps, start_time, group_by) },
-        { name: "Outgoing Mbps", data: average_for_period(:outgoing_mbps, start_time, group_by) }
-      ]
-    end
+class Bandwidth < ApplicationModel
+  def self.average_usage(start_time, minutes)
+    data = where(created_at: start_time..)
+      .group_by_time(minutes)
+      .pluck(
+        Arel.sql("datetime(#{group_format(minutes)}, 'unixepoch') as period"),
+        Arel.sql("ROUND(AVG(incoming_mbps), 2) as avg_incoming"),
+        Arel.sql("ROUND(AVG(outgoing_mbps), 2) as avg_outgoing")
+      )
 
-    private
-
-    def average_for_period(column, start_time, group_by)
-      where(created_at: start_time..)
-        .group_by_period(group_by, :created_at)
-        .average(column)
-        .transform_values { |value| value&.round(2) }
-    end
+    incoming = data.to_h { |period, incoming, _| [period, incoming] }
+    outgoing = data.to_h { |period, _, outgoing| [period, outgoing] }
+    [
+      {name: "Incoming Mbps", data: incoming},
+      {name: "Outgoing Mbps", data: outgoing}
+    ]
   end
 end

data/app/models/cpu_load.rb

@@ -1,18 +1,23 @@
 # frozen_string_literal: true
 
-class CpuLoad < ActiveRecord::Base
-  def self.average_load(start_time, end_time, group_by)
+class CpuLoad < ApplicationModel
+  def self.average_load(start_time, minutes)
+    data = where(created_at: start_time..)
+      .group_by_time(minutes)
+      .pluck(
+        Arel.sql("datetime(#{group_format(minutes)}, 'unixepoch') as period"),
+        Arel.sql("ROUND(AVG(one_minute), 2) as avg_one"),
+        Arel.sql("ROUND(AVG(five_minutes), 2) as avg_five"),
+        Arel.sql("ROUND(AVG(fifteen_minutes), 2) as avg_fifteen")
+      )
+
+    one = data.to_h { |period, one, _, _| [period, one] }
+    five = data.to_h { |period, _, five, _| [period, five] }
+    fifteen = data.to_h { |period, _, _, fifteen| [period, fifteen] }
     [
-      { name: "1 minute", data: average_for_period(:one_minute, start_time, end_time, group_by) },
-      { name: "5 minutes", data: average_for_period(:five_minutes, start_time, end_time, group_by) },
-      { name: "15 minutes", data: average_for_period(:fifteen_minutes, start_time, end_time, group_by) }
+      {name: "1 minute", data: one},
+      {name: "5 minutes", data: five},
+      {name: "15 minutes", data: fifteen}
     ]
   end
-
-  def self.average_for_period(column, start_time, end_time, group_by)
-    where(created_at: start_time..end_time)
-      .group_by_period(group_by, :created_at)
-      .average(column)
-      .transform_values { |value| value&.round(2) }
-  end
 end

data/app/models/cpu_usage.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-class CpuUsage < ActiveRecord::Base
-  def self.average_usage(start_time, group_by)
+class CpuUsage < ApplicationModel
+  def self.average_usage(start_time, minutes)
     where(created_at: start_time..)
-      .group_by_period(group_by, :created_at, expand_range: true)
-      .average(:used_percent)
-      .transform_values { |value| value&.round(2) }
+      .group_by_time(minutes)
+      .pluck(
+        Arel.sql("datetime(#{group_format(minutes)}, 'unixepoch') as period"),
+        Arel.sql("ROUND(AVG(used_percent), 2) as avg_usage")
+      )
   end
 end

data/app/models/disk_io.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-class DiskIO < ActiveRecord::Base
-  class << self
-    def average_io(start_time, group_by)
-      [
-        { name: "Read MB/s", data: average_for_period(:read_mb_per_sec, start_time, group_by) },
-        { name: "Write MB/s", data: average_for_period(:write_mb_per_sec, start_time, group_by) }
-      ]
-    end
+class DiskIO < ApplicationModel
+  def self.average_io(start_time, minutes)
+    data = where(created_at: start_time..)
+      .group_by_time(minutes)
+      .pluck(
+        Arel.sql("datetime(#{group_format(minutes)}, 'unixepoch') as period"),
+        Arel.sql("ROUND(AVG(read_mb_per_sec), 2) as avg_read"),
+        Arel.sql("ROUND(AVG(write_mb_per_sec), 2) as avg_write")
+      )
 
-    private
-
-    def average_for_period(column, start_time, group_by)
-      where(created_at: start_time..)
-        .group_by_period(group_by, :created_at)
-        .average(column)
-        .transform_values { |value| value&.round(2) }
-    end
+    read = data.to_h { |period, read, _| [period, read] }
+    write = data.to_h { |period, _, write| [period, write] }
+    [
+      {name: "Read MB/s", data: read},
+      {name: "Write MB/s", data: write}
+    ]
   end
 end

data/app/models/filesystem_usage.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-class FilesystemUsage < ActiveRecord::Base
-  def self.average_usage(start_time, group_by)
+class FilesystemUsage < ApplicationModel
+  def self.average_usage(start_time, minutes)
     where(created_at: start_time..)
-      .group_by_period(group_by, :created_at)
-      .average(:used_percent)
-      .transform_values { |value| value&.round(2) }
+      .group_by_time(minutes)
+      .pluck(
+        Arel.sql("datetime(#{group_format(minutes)}, 'unixepoch') as period"),
+        Arel.sql("ROUND(AVG(used_percent), 2) as avg_usage")
+      )
   end
 end

data/app/models/memory_usage.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-class MemoryUsage < ActiveRecord::Base
-  def self.average_usage(start_time, group_by)
+class MemoryUsage < ApplicationModel
+  def self.average_usage(start_time, minutes)
     where(created_at: start_time..)
-      .group_by_period(group_by, :created_at)
-      .average(:used_percent)
-      .transform_values { |value| value&.round(2) }
+      .group_by_time(minutes)
+      .pluck(
+        Arel.sql("datetime(#{group_format(minutes)}, 'unixepoch') as period"),
+        Arel.sql("ROUND(AVG(used_percent), 2) as avg_usage")
+      )
   end
 end

data/app/puny_monitor.rb

@@ -2,14 +2,17 @@
 
 require "rufus-scheduler"
 require_relative "scheduler"
+require_relative "authorization"
 require_relative "../lib/system_utils"
 
 module PunyMonitor
   class App < Sinatra::Base
+    # include Authorization
+
     configure do
       register Sinatra::ActiveRecordExtension
       @scheduler = Rufus::Scheduler.new
-      @scheduler.every("5s") { Scheduler.collect_data }
+      @scheduler.every("10s") { Scheduler.collect_data }
       @scheduler.every("1h") { Scheduler.cleanup_old_data }
     end
 
@@ -22,7 +25,7 @@ module PunyMonitor
     set :database_file, "../config/database.yml"
 
     get "/" do
-      erb :index, locals: { params:, logo: }
+      erb :index, locals: {params:, logo:}
     end
 
     get "/up" do
@@ -31,32 +34,32 @@ module PunyMonitor
 
     get "/data/cpu_usage" do
       content_type :json
-      CpuUsage.average_usage(start_time, group_by).to_json
+      CpuUsage.average_usage(start_time, interval).to_json
     end
 
     get "/data/cpu_load" do
       content_type :json
-      CpuLoad.average_load(start_time, Time.now, group_by).to_json
+      CpuLoad.average_load(start_time, interval).to_json
     end
 
     get "/data/memory_usage" do
       content_type :json
-      MemoryUsage.average_usage(start_time, group_by).to_json
+      MemoryUsage.average_usage(start_time, interval).to_json
     end
 
     get "/data/filesystem_usage" do
       content_type :json
-      FilesystemUsage.average_usage(start_time, group_by).to_json
+      FilesystemUsage.average_usage(start_time, interval).to_json
     end
 
     get "/data/disk_io" do
       content_type :json
-      DiskIO.average_io(start_time, group_by).to_json
+      DiskIO.average_io(start_time, interval).to_json
     end
 
     get "/data/bandwidth" do
       content_type :json
-      Bandwidth.average_usage(start_time, group_by).to_json
+      Bandwidth.average_usage(start_time, interval).to_json
     end
 
     private
@@ -68,11 +71,8 @@ module PunyMonitor
       end
     end
 
-    def duration
-      params[:duration] || "1d"
-    end
-
     def start_time
+      duration = params[:duration] || "1d"
       case duration
       when "1h" then 1.hour.ago
       when "3d" then 3.days.ago
@@ -82,11 +82,16 @@ module PunyMonitor
       end
     end
 
-    def group_by
-      case duration
-      when "1h", "1d" then :minute
-      else :hour
-      end
+    def interval
+      (params[:interval] || "15").to_i
+    end
+
+    def chart_url(endpoint)
+      query_params = []
+      query_params << "duration=#{params[:duration]}" if params[:duration]
+      query_params << "interval=#{params[:interval]}" if params[:interval]
+      query_string = query_params.empty? ? "" : "?#{query_params.join("&")}"
+      "#{endpoint}#{query_string}"
     end
   end
 end

data/app/scheduler.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "../lib/system_utils"
-require "debug"
 
 module PunyMonitor
   class Scheduler
@@ -10,8 +9,8 @@ module PunyMonitor
         CpuUsage.create(used_percent: SystemUtils.cpu_usage_percent)
         cpu_load_averages = SystemUtils.cpu_load_average
         CpuLoad.create(one_minute: cpu_load_averages[0],
-                       five_minutes: cpu_load_averages[1],
-                       fifteen_minutes: cpu_load_averages[2])
+          five_minutes: cpu_load_averages[1],
+          fifteen_minutes: cpu_load_averages[2])
         MemoryUsage.create(used_percent: SystemUtils.memory_usage_percent)
         FilesystemUsage.create(used_percent: SystemUtils.filesystem_usage_percent)
 

data/app/views/index.erb

@@ -1,15 +1,31 @@
 <section class="controls">
-  <form action="/" method="get">
-    <select name="duration" onchange="this.form.submit()">
-      <option value="1h" <%= params[:duration] == '1h' ? 'selected' : '' %>>1 Hour</option>
-      <option
-        value="1d"
-        <%= params[:duration] == '1d' || params[:duration].nil? ? 'selected' : '' %>
-      >1 Day</option>
-      <option value="3d" <%= params[:duration] == '3d' ? 'selected' : '' %>>3 Days</option>
-      <option value="1w" <%= params[:duration] == '1w' ? 'selected' : '' %>>1 Week</option>
-      <option value="1m" <%= params[:duration] == '1m' ? 'selected' : '' %>>1 Month</option>
-    </select>
+  <form class="controls__form" action="/" method="get">
+
+    <label for="duration">Duration
+      <select id="duration" name="duration" onchange="this.form.submit()">
+        <option value="1h" <%= params[:duration] == '1h' ? 'selected' : '' %>>1 Hour</option>
+        <option
+          value="1d"
+          <%= params[:duration] == '1d' || params[:duration].nil? ? 'selected' : '' %>
+        >1 Day</option>
+        <option value="3d" <%= params[:duration] == '3d' ? 'selected' : '' %>>3 Days</option>
+        <option value="1w" <%= params[:duration] == '1w' ? 'selected' : '' %>>1 Week</option>
+        <option value="1m" <%= params[:duration] == '1m' ? 'selected' : '' %>>1 Month</option>
+      </select>
+    </label>
+
+    <label for="interval">Aggregation Interval
+      <select id="interval" name="interval" onchange="this.form.submit()">
+        <option value="5" <%= params[:interval] == '5' ? 'selected' : '' %>>5 minutes</option>
+        <option
+          value="15"
+          <%= params[:interval] == '15' || params[:interval].nil? ? 'selected' : '' %>
+        >15 minutes</option>
+        <option value="60" <%= params[:interval] == '60' ? 'selected' : '' %>>1 hour</option>
+        <option value="120" <%= params[:interval] == '120' ? 'selected' : '' %>>2 hours</option>
+        <option value="1440" <%= params[:interval] == '1440' ? 'selected' : '' %>>1 day</option>
+      </select>
+    </label>
   </form>
 </section>
 
@@ -17,7 +33,7 @@
 
   <div class="tile">
     <h2>CPU Usage</h2>
-    <%= area_chart "/data/cpu_usage?duration=#{params[:duration] || "1d"}",
+    <%= area_chart chart_url("/data/cpu_usage"),
     ytitle: "CPU Usage (%)",
     min: 0,
     max: 100,
@@ -31,7 +47,7 @@
 
   <div class="tile">
     <h2>CPU Load</h2>
-    <%= line_chart "/data/cpu_load?duration=#{params[:duration] || "1d"}",
+    <%= line_chart chart_url("/data/cpu_load"),
     ytitle: "Load Average",
     library: {
       title: {
@@ -43,7 +59,7 @@
 
   <div class="tile">
     <h2>Memory Usage</h2>
-    <%= area_chart "/data/memory_usage?duration=#{params[:duration] || "1d"}",
+    <%= area_chart chart_url("/data/memory_usage"),
     ytitle: "Memory Usage (%)",
     min: 0,
     max: 100,
@@ -57,7 +73,7 @@
 
   <div class="tile">
     <h2>Filesystem Usage</h2>
-    <%= area_chart "/data/filesystem_usage?duration=#{params[:duration] || "1d"}",
+    <%= area_chart chart_url("/data/filesystem_usage"),
     ytitle: "Used Space (%)",
     min: 0,
     max: 100,
@@ -71,7 +87,7 @@
 
   <div class="tile">
     <h2>Disk I/O</h2>
-    <%= area_chart "/data/disk_io?duration=#{params[:duration] || "1d"}",
+    <%= area_chart chart_url("/data/disk_io"),
     ytitle: "MB/s",
     library: {
       title: {
@@ -83,7 +99,7 @@
 
   <div class="tile">
     <h2>Bandwidth</h2>
-    <%= area_chart "/data/bandwidth?duration=#{params[:duration] || "1d"}",
+    <%= area_chart chart_url("/data/bandwidth"),
     ytitle: "Bandwidth (Mbps)",
     library: {
       title: {

data/app/views/layout.erb

@@ -13,13 +13,16 @@
     <link rel="icon" href="favicon.ico" sizes="32x32">
     <link rel="icon" href="icon.svg" type="image/svg+xml">
 
-    <script
-      src="https://cdn.jsdelivr.net/npm/chartkick@4.2.0/dist/chartkick.min.js"
-    ></script>
-    <script src="https://cdn.jsdelivr.net/npm/chart.js@3.7.1/dist/chart.min.js"></script>
-    <script
-      src="https://cdn.jsdelivr.net/npm/chartjs-adapter-date-fns@2.0.0/dist/chartjs-adapter-date-fns.bundle.min.js"
-    ></script>
+    <script type="importmap">
+    {
+      "imports": {
+        "chartkick": "./javascript/chartkick.js",
+        "Chart.bundle": "./javascript/Chart.bundle.js"
+      }
+    }
+    </script>
+    <script type="module" src="javascript/index.js"></script>
+
     <link
       rel="preload"
       href="fonts/Rubik.woff2"

data/config/environment.rb

@@ -8,7 +8,6 @@ Bundler.require(:default, ENV.fetch("RACK_ENV", nil))
 require "sinatra/contrib"
 require "sinatra/activerecord"
 require "rufus-scheduler"
-require "groupdate"
 require "chartkick"
 require "sqlite3"
 require "sys-filesystem"

data/lib/puny_monitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PunyMonitor
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/system_utils.rb

@@ -13,9 +13,9 @@ class SystemUtils
       idle = current_cpu[:idle] + current_cpu[:iowait]
 
       prev_non_idle = prev_cpu[:user] + prev_cpu[:nice] + prev_cpu[:system] +
-                      prev_cpu[:irq] + prev_cpu[:softirq] + prev_cpu[:steal]
+        prev_cpu[:irq] + prev_cpu[:softirq] + prev_cpu[:steal]
       non_idle = current_cpu[:user] + current_cpu[:nice] + current_cpu[:system] +
-                 current_cpu[:irq] + current_cpu[:softirq] + current_cpu[:steal]
+        current_cpu[:irq] + current_cpu[:softirq] + current_cpu[:steal]
 
       prev_total = prev_idle + prev_non_idle
       total = idle + non_idle
@@ -29,8 +29,8 @@ class SystemUtils
 
     def cpu_load_average
       File.read("#{proc_path}/loadavg").split.take(3)
-          .map(&:to_f)
-          .map { |value| value.round(2) }
+        .map(&:to_f)
+        .map { |value| value.round(2) }
     end
 
     def memory_usage_percent
@@ -111,16 +111,16 @@ class SystemUtils
 
     def read_disk_stats
       primary_disk = File.read("#{proc_path}/partitions")
-                         .lines
-                         .drop(2)
-                         .first
-                         .split
-                         .last
+        .lines
+        .drop(2)
+        .first
+        .split
+        .last
 
       stats = File.read("#{proc_path}/diskstats")
-                  .lines
-                  .map(&:split)
-                  .find { |line| line[2] == primary_disk }
+        .lines
+        .map(&:split)
+        .find { |line| line[2] == primary_disk }
 
       {
         read_sectors: stats[5].to_i,
@@ -130,14 +130,14 @@ class SystemUtils
 
     def read_network_stats
       primary_interface = File.read("#{proc_path}/net/route")
-                              .lines
-                              .drop(1)
-                              .find { |line| line.split[1] == "00000000" }
-                              &.split&.first
+        .lines
+        .drop(1)
+        .find { |line| line.split[1] == "00000000" }
+        &.split&.first
       stats = File.read("#{proc_path}/net/dev")
-                  .lines
-                  .map(&:split)
-                  .find { |line| line[0].chomp(":") == primary_interface }
+        .lines
+        .map(&:split)
+        .find { |line| line[0].chomp(":") == primary_interface }
 
       {
         rx_bytes: stats[1].to_i,