rails_server_analytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ceecf3d520444f52ee03e83e013c11c051060c8f7aa68a6f51daade9f4ac7d32
+  data.tar.gz: aba1fbf7819d6b292a9900ee29cd1d162b96057aa4d88ccf3bbfe4c9aed13252
+SHA512:
+  metadata.gz: 0663736f3c8feb23bdae41ec480b2342a521e183deae4da9e4de7d6d8bcea711485cafb5c55e8f48e3d81e04c21f8ebe310fc46625b9341149832dfa05365958
+  data.tar.gz: '092920b9405f6d39516a267c6001d33aed1c93b598e3c7908a7d9a41baaa34db0ebc2e2356fbcd1a5365285e0be546c190b4f20f6cdca128f2c679cd83903749'

data/lib/generators/analytics_generator.rb

@@ -0,0 +1,31 @@
+require "rails/generators/base"
+
+module Analytics
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "analyctics controller installation generator"
+
+      def create_analytics_controller
+        template "analytics_controller.rb", "app/controllers/analytics_controller.rb"
+      end
+
+      def create_analytics_view
+        template "index.html.erb.tt", "app/views/analytics/index.html.erb"
+      end
+
+      def add_analytics_route
+        route "get 'analytics', to: 'analytics#index'"
+      end
+
+      def create_model_file
+        template "analytic.rb", "app/models/analytic.rb"
+      end
+
+      def create_migration_file
+        timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        template "migration.rb", "db/migrate/#{timestamp}_create_analytics.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/analytic.rb

@@ -0,0 +1,37 @@
+# analytics_data = {
+#   status: ok
+#   headers: {
+#
+#   },
+#   request_uri: "/posts",
+#   request_method: "get",
+#   path_info "/posts",
+#   ip,
+#   host: "127.0.0.1",
+#   time: Time.now,
+#   time_spent: Time.now
+# }
+
+class Analytic < ApplicationRecord
+  def content
+    self.analytics_data = JSON.parse(analytics_data)
+  end
+
+  def self.user
+    Rails.root.to_path.split("/")[2]
+  end
+
+  def self.root
+    Rails.root.to_path
+  end
+
+  def self.version
+    ruby_version = `ruby -v`.split(" ")[1]
+    rails_version = `rails -v`.split(" ")[1]
+
+    {
+      ruby_v: ruby_version,
+      rails_v: rails_version
+    }
+  end
+end

data/lib/generators/templates/analytics_controller.rb

@@ -0,0 +1,59 @@
+class AnalyticsController < ApplicationController
+  before_action :get_analytics, :process_raw_analytics
+
+  def index
+    respond_to do |format|
+      format.html { render :index }
+      format.json { render json: @analytics_json }
+    end
+  end
+
+  private
+
+  def get_analytics
+    @analytics = Analytic.all
+    @analytics.each(&:content)
+  end
+
+  def process_raw_analytics
+    request_count = @analytics.count
+    total_request_per_day = @analytics.where(updated_at: (Time.now - 1.day)..Time.now).pluck(:updated_at).count
+
+    average_response_time = get_average("time_spent")
+    average_cpu_usage = get_average("cpu_usage")
+
+    most_frequent_request = get_most_frequent("request_uri")
+    most_frequent_request_method = get_most_frequent("request_method")
+
+    version = Analytic.version
+    user = Analytic.user
+    root = Analytic.root
+
+    @analytics_json = {
+      analytics: @analytics,
+      request_count: request_count,
+      total_request_per_day: total_request_per_day,
+      average_response_time: average_response_time,
+      most_frequent_request: most_frequent_request,
+      most_frequent_request_method: most_frequent_request_method,
+      average_cpu_usage: average_cpu_usage,
+      ruby_v: version[:ruby_v],
+      rails_v: version[:rails_v],
+      user: user,
+      root: root
+    }
+  end
+
+  def get_most_frequent(data)
+    all_request = @analytics.map(&:analytics_data).pluck(data)
+    all_request.detect { |r| all_request.count(r) > 1 }
+
+    counts = all_request.group_by { |e| e }.transform_values(&:size)
+    counts.max_by { |_, count| count }[0]
+  end
+
+  def get_average(data)
+    all_data = @analytics.map(&:analytics_data).pluck(data)
+    (all_data.sum / @analytics.count).truncate(3)
+  end
+end

data/lib/generators/templates/index.html.erb.tt

@@ -0,0 +1,212 @@
+<!-- analytics_dashboard.html.erb -->
+<title>System Analytics Dashboard</title>
+<style>
+/* Reset and base styles */
+* {
+  margin: 0;
+  padding: 0;
+  box-sizing: border-box;
+}
+
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+      line-height: 1.6;
+      color: #333;
+      background-color: #f5f5f5;
+      padding: 20px;
+    }
+
+    /* Container */
+    .container {
+      max-width: 1200px;
+      margin: 0 auto;
+    }
+
+    /* Header styles */
+    .header {
+      display: flex;
+      justify-content: space-between;
+      align-items: center;
+      margin-bottom: 30px;
+      background-color: white;
+      padding: 20px;
+      border-radius: 8px;
+      box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+    }
+
+    .version-info {
+      display: flex;
+      gap: 20px;
+      font-size: 0.9em;
+      color: #666;
+    }
+
+    /* Grid layout */
+    .metrics-grid {
+      display: grid;
+      grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
+      gap: 20px;
+      margin-bottom: 30px;
+    }
+
+    /* Card styles */
+    .card {
+      background: white;
+      padding: 20px;
+      border-radius: 8px;
+      box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+    }
+
+    .metric-card {
+      text-align: center;
+    }
+
+    .metric-title {
+      font-size: 0.9em;
+      color: #666;
+      margin-bottom: 10px;
+    }
+
+    .metric-value {
+      font-size: 1.8em;
+      font-weight: bold;
+      color: #2563eb;
+    }
+
+    /* Chart styles */
+    .chart-container {
+      margin-bottom: 30px;
+    }
+
+    .chart {
+      width: 100%;
+      height: 300px;
+      background: white;
+      padding: 20px;
+      border-radius: 8px;
+      box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+    }
+
+    /* Request details styles */
+    .details-grid {
+      display: grid;
+      grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
+      gap: 20px;
+    }
+
+    .detail-item {
+      margin-bottom: 15px;
+    }
+
+    .detail-label {
+      font-size: 0.9em;
+      color: #666;
+      margin-bottom: 5px;
+    }
+
+    .detail-value {
+      font-weight: 600;
+    }
+
+    /* Responsive adjustments */
+    @media (max-width: 768px) {
+      .header {
+        flex-direction: column;
+        gap: 10px;
+        text-align: center;
+      }
+
+      .version-info {
+        flex-direction: column;
+        gap: 5px;
+      }
+    }
+</style>
+<div class="container">
+  <!-- Header -->
+  <div class="header">
+    <h1>System Analytics Dashboard</h1>
+    <div class="version-info">
+      <span>Ruby <%%= @analytics_json[:ruby_v] %></span>
+      <span>Rails <%%= @analytics_json[:rails_v] %></span>
+    </div>
+  </div>
+
+  <!-- Key Metrics -->
+  <div class="metrics-grid">
+    <div class="card metric-card">
+      <div class="metric-title">Total Requests</div>
+      <div class="metric-value"><%%= number_with_delimiter(@analytics_json[:request_count]) %></div>
+    </div>
+
+    <div class="card metric-card">
+      <div class="metric-title">Avg Response Time</div>
+      <div class="metric-value"><%%= @analytics_json[:average_response_time] %>ms</div>
+    </div>
+
+    <div class="card metric-card">
+      <div class="metric-title">CPU Usage</div>
+      <div class="metric-value"><%%= @analytics_json[:average_cpu_usage] %>%</div>
+    </div>
+
+    <div class="card metric-card">
+      <div class="metric-title">System User</div>
+      <div class="metric-value"><%%= @analytics_json[:user] %></div>
+    </div>
+  </div>
+
+  <!-- Chart Card -->
+  <div class="chart-container card">
+    <h2>Requests per Day</h2>
+    <div class="chart">
+      <%% 
+          # You would need to implement chart rendering here
+        # You could use Chart.js or any other JavaScript charting library
+        # For now, we'll show the data in a table format
+      %>
+    <table style="width: 100%; border-collapse: collapse;">
+      <thead>
+        <tr>
+          <th style="text-align: left; padding: 8px; border-bottom: 1px solid #ddd;">Date</th>
+          <th style="text-align: right; padding: 8px; border-bottom: 1px solid #ddd;">Requests</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td><%% @analytics_json[:total_request_per_day] %></td>
+        </tr>
+      </tbody>
+    </table>
+    </div>
+  </div>
+
+  <!-- Request Details -->
+  <div class="card">
+    <h2 style="margin-bottom: 20px;">Request Details</h2>
+    <div class="details-grid">
+      <div class="detail-item">
+        <div class="detail-label">Most Frequent Request</div>
+        <div class="detail-value"><%%= @analytics_json[:most_frequent_request] %></div>
+      </div>
+
+      <div class="detail-item">
+        <div class="detail-label">Request Method</div>
+        <div class="detail-value"><%%= @analytics_json[:most_frequent_request_method] %></div>
+      </div>
+
+      <div class="detail-item">
+        <div class="detail-label">System Root</div>
+        <div class="detail-value"><%%= @analytics_json[:root] %></div>
+      </div>
+    </div>
+  </div>
+</div>
+
+<%% if @analytics_json[:auto_refresh] %>
+  <script>
+    setTimeout(function() {
+      window.location.reload();
+    }, 5000);
+  </script>
+<%% end %>
+

data/lib/generators/templates/migration.rb

@@ -0,0 +1,9 @@
+class CreateAnalytics < ActiveRecord::Migration[7.2]
+  def change
+    create_table :analytics do |t|
+      t.json :analytics_data
+
+      t.timestamps
+    end
+  end
+end

data/lib/rails_server_analytics/analytics_tracer.rb

@@ -0,0 +1,67 @@
+require "active_support/log_subscriber"
+
+module RailsServerAnalytics
+  class AnalyticsTracer < ActiveSupport::LogSubscriber
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Rails.logger.info(color("Processing request in middleware", YELLOW)) 
+
+      time_start = Time.now
+      before_cpu = `ps -o %cpu= -p #{Process.pid}`.strip.to_f
+
+      status, headers, response = @app.call(env)
+      # request = ActionDispatch::Request.new env
+
+      # data = {status:, headers:, response: response.body, request: request.body, time:}
+      request_uri = env["REQUEST_URI"]
+      request_method = env["REQUEST_METHOD"].downcase
+      path_info = env["PATH_INFO"]
+      ip = env["action_dispatch.remote_ip"].calculate_ip
+      host = env["HTTP_HOST"]
+      time_end = Time.now
+
+      time_spent = time_end - time_start
+
+      after_cpu = `ps -o %cpu= -p #{Process.pid}`.strip.to_f
+      cpu_usage = after_cpu - before_cpu
+
+      return [status, headers, response] if path_info.eql? "/analytics"
+
+      analytics_data = JSON.pretty_generate({
+        status:,
+        headers:,
+        request_uri:,
+        request_method:,
+        path_info:,
+        ip:,
+        host:,
+        time_spent:,
+        cpu_usage:,
+      })
+
+      analytics = Analytic.create(analytics_data:)
+
+      Rails.logger.info(color("response data stored", GREEN)) 
+      # write_data(data)
+
+      [status, headers, response]
+    end
+
+    def write_data(data)
+      json_path =
+        if defined?(Rails)
+          analytics_dir = File.join(Rails.root, "analytics_data/")
+          FileUtils.mkdir_p(analytics_dir)[0] + "trace.json"
+        end
+
+      File.open(json_path, "w") do |f|
+        f.write(JSON.pretty_generate(data))
+      end
+    end
+  end
+end
+

data/lib/rails_server_analytics/engine.rb

@@ -0,0 +1,13 @@
+require "rails/engine"
+
+module RailsServerAnalytics
+  class Engine < Rails::Engine
+    initializer "server_analytics.configure_middleware" do |app|
+      app.middleware.use RailsServerAnalytics::AnalyticsTracer
+    end
+
+    generators do
+      require "generators/analytics_generator"
+    end
+  end
+end

data/lib/rails_server_analytics/version.rb

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

data/lib/rails_server_analytics.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "rails_server_analytics/version"
+require "rails_server_analytics/analytics_tracer"
+require "rails_server_analytics/engine" if defined?(Rails::Engine)
+
+module RailsServerAnalytics
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: rails_server_analytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chong Wei Jie
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-10 00:00:00.000000000 Z
+dependencies: []
+description: a gem that applies a custom middleware in a rails application for tracing
+  requests and generates an analytics page for monitoring.
+email:
+- jackchong398@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/analytics_generator.rb
+- lib/generators/templates/analytic.rb
+- lib/generators/templates/analytics_controller.rb
+- lib/generators/templates/index.html.erb.tt
+- lib/generators/templates/migration.rb
+- lib/rails_server_analytics.rb
+- lib/rails_server_analytics/analytics_tracer.rb
+- lib/rails_server_analytics/engine.rb
+- lib/rails_server_analytics/version.rb
+homepage: https://github.com/Cwjiee/rails-server-analytics
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Cwjiee/rails-server-analytics
+  source_code_uri: https://github.com/Cwjiee/rails-server-analytics
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A middleware to trace and montior requests and responses in rails
+test_files: []