rails_performance 1.4.0.alpha3 → 1.4.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d2e2b2c1b69d3c41d7208b746af12d1ae6e8ae2c305c35e066636f9fc6946f
-  data.tar.gz: 3b6611e09e42154d80151466badef9b98060e6215d959ffccc6f271023193c45
+  metadata.gz: f9541b647e5e0ae0e49c8ffe55befda74884e9a8c53c9557cffd4b8c42ca23fc
+  data.tar.gz: 8b1ada0884c84dbbab0306cffab9bbb4f4b04b0fc4107a55747eae5416ed26ea
 SHA512:
-  metadata.gz: 054226e9584b58d19ab43773da49cbf7d1d4ee7c2358808ed7f749d786efb8f95a10aa6cfa4976b2b6fadfa143828dcd98f5408b209d89dd3855fa4bd5e4352e
-  data.tar.gz: fc7e826a68e0ed7d17ab48bd391a97daa2e06a8b12aac47000dfc29c4217acd59118e0b5fe0ce65111dff5ce6b6b31838f98736855994b2a3b69cae9e6f2cef7
+  metadata.gz: e2db12562f40ce01aa3bffa6a545e4567469972ec5ab79a0e7318dbe526b09c62e6c2f6f2fecadecb44485e5ea6f3bb4a7a4d632d7938e9a347af86144ea19b9
+  data.tar.gz: 7e7bed31f33b4f0af24362ec621f7d066b33d3225103e08b2819bc33b9b69a1fbc1d5c4ba65221d1c47186b6ab9d954d403eddf6317c7b9a94dfd445ca8f9004

data/README.md

@@ -117,9 +117,21 @@ RailsPerformance.setup do |config|
 
   # To monitor custom events with `RailsPerformance.measure` block
   # config.include_custom_events = true
+
+  # To monitor system resources (CPU, memory, disk)
+  # to enabled add required gems (see README)
+  # config.system_monitor_duration = 24.hours
 end if defined?(RailsPerformance)
 ```
 
+Additionally you might need to configure app time zone. You can do it in `config/application.rb`:
+
+```ruby
+config.time_zone = 'Eastern Time (US & Canada)'
+```
+
+Gem will present charts/tables in the app timezone. If it's not set, it will use UTC.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -175,7 +187,9 @@ You need to configure `config.custom_data_proc`. And you can capture current_use
 ![Custom Data](docs/custom_data.png)
 
 
-### System Monitoring
+### Server Monitoring
+
+![Server Monitoring](docs/rails_performance_cpu_memory_storage.png)
 
 You can monitor system resources (CPU, memory, disk) by adding a gem to your Gemfile:
 
@@ -197,6 +211,14 @@ Basically using this code:
       end
 ```
 
+For Kamal for example:
+
+```yaml
+env:
+  clear:
+    RAILS_PERFORMANCE_SERVER_ID: "server"
+```
+
 You can also specifify custom "context" and "role" for monitoring, by changing the env variables:
 
 ```ruby
@@ -260,6 +282,8 @@ After this:
 - rails s
 - rake test
 
+If you need quickly clear Redis data, you can use `rails runner 'RailsPerformance.redis.flushdb'`.
+
 Like a regular web development.
 
 Please note that to simplify integration with other apps all CSS/JS are bundled inside, and delivered in body of the request. This is to avoid integration with assets pipeline or webpacker.

data/app/controllers/rails_performance/rails_performance_controller.rb

@@ -15,7 +15,7 @@ module RailsPerformance
       end
 
       def resources
-        @datasource = RailsPerformance::DataSource.new(**prepare_query(params), type: :resources)
+        @datasource = RailsPerformance::DataSource.new(**prepare_query(params), type: :resources, days: RailsPerformance::Utils.days(RailsPerformance.system_monitor_duration))
         db = @datasource.db
 
         @resources_report = RailsPerformance::Reports::ResourcesReport.new(db)

data/app/helpers/rails_performance/rails_performance_helper.rb

@@ -30,10 +30,6 @@ module RailsPerformance
       end
     end
 
-    def mss(value, limit = 1)
-      ms(value.to_f * 1000, limit)
-    end
-
     def ms(value, limit = 1)
       result = round_it(value, limit)
       return "-" if result.nil?

data/app/views/rails_performance/javascripts/app.js

@@ -1,3 +1,9 @@
+Highcharts.setOptions({
+  time: {
+    timezone: window.APP_TIME_ZONE
+  }
+});
+
 function showTIRChart(div, data, addon, name) {
   Highcharts.chart(div, {
       chart: {

data/app/views/rails_performance/layouts/rails_performance.html.erb

@@ -6,6 +6,9 @@
     <title>Rails Performance</title>
     <%= csrf_meta_tags %>
     <%= csp_meta_tag if ::Rails::VERSION::STRING.to_f >= 5.2 %>
+    <script>
+      window.APP_TIME_ZONE = '<%= Rails.application.config.time_zone.presence || 'UTC' %>';
+    </script>
     <%= render '/rails_performance/stylesheets/stylesheets' %>
     <link rel="shortcut icon" href="/favicon.ico">
   </head>

data/lib/generators/rails_performance/install/templates/initializer.rb

@@ -52,5 +52,9 @@ if defined?(RailsPerformance)
     config.skipable_rake_tasks = ["webpacker:compile"]
     config.include_rake_tasks = false
     config.include_custom_events = true
+
+    # If enabled, the system monitor will be displayed on the dashboard
+    # to enabled add required gems (see README)
+    # config.system_monitor_duration = 24.hours
   end
 end

data/lib/rails_performance/data_source.rb

@@ -10,19 +10,20 @@ module RailsPerformance
       resources: RailsPerformance::Models::ResourceRecord
     }
 
-    attr_reader :q, :klass, :type
+    attr_reader :q, :klass, :type, :days
 
-    def initialize(type:, q: {})
+    def initialize(type:, q: {}, days: RailsPerformance::Utils.days(RailsPerformance.duration))
       @type = type
       @klass = KLASSES[type]
       q[:on] ||= Date.today
       @q = q
+      @days = days
     end
 
     def db
       result = RailsPerformance::Models::Collection.new
-      now = Time.current
-      (0..(RailsPerformance::Utils.days)).to_a.reverse_each do |e|
+      now = RailsPerformance::Utils.time
+      (0..days).to_a.reverse_each do |e|
         RailsPerformance::DataSource.new(q: q.merge({on: (now - e.days).to_date}), type: type).add_to(result)
       end
       result

data/lib/rails_performance/extensions/resources_monitor.rb

@@ -18,7 +18,6 @@ module RailsPerformance
         @mutex.synchronize do
           return if @thread
 
-          # puts "Starting monitoring for #{context} - #{role}"
           @thread = Thread.new do
             loop do
               run
@@ -35,7 +34,6 @@ module RailsPerformance
         @mutex.synchronize do
           return unless @thread
 
-          # puts "Stopping monitoring"
           @thread.kill
           @thread = nil
         end
@@ -83,7 +81,7 @@ module RailsPerformance
       def store_data(data)
         ::Rails.logger.info("Server: #{server_id}, Context: #{context}, Role: #{role}, data: #{data}")
 
-        now = Time.current
+        now = RailsPerformance::Utils.time
         now = now.change(sec: 0, usec: 0)
         RailsPerformance::Models::ResourceRecord.new(
           server: server_id,

data/lib/rails_performance/gems/custom_ext.rb

@@ -8,7 +8,7 @@ module RailsPerformance
         return yield unless RailsPerformance.include_custom_events
 
         begin
-          now = Time.current
+          now = RailsPerformance::Utils.time
           status = "success"
           result = yield
           result
@@ -20,7 +20,7 @@ module RailsPerformance
             tag_name: tag_name,
             namespace_name: namespace_name,
             status: status,
-            duration: (Time.current - now) * 1000,
+            duration: (RailsPerformance::Utils.time - now) * 1000,
             datetime: now.strftime(RailsPerformance::FORMAT),
             datetimei: now.to_i
           ).save

data/lib/rails_performance/gems/delayed_job_ext.rb

@@ -4,7 +4,7 @@ module RailsPerformance
       class Plugin < ::Delayed::Plugin
         callbacks do |lifecycle|
           lifecycle.around(:invoke_job) do |job, *args, &block|
-            now = Time.current
+            now = RailsPerformance::Utils.time
             block.call(job, *args)
             status = "success"
           rescue Exception => error # rubocop:disable Lint/RescueException
@@ -14,7 +14,7 @@ module RailsPerformance
             meta_data = RailsPerformance::Gems::DelayedJobExt::Plugin.meta(job.payload_object)
             record = RailsPerformance::Models::DelayedJobRecord.new(
               jid: job.id,
-              duration: (Time.current - now) * 1000,
+              duration: (RailsPerformance::Utils.time - now) * 1000,
               datetime: now.strftime(RailsPerformance::FORMAT),
               datetimei: now.to_i,
               source_type: meta_data[0],

data/lib/rails_performance/gems/grape_ext.rb

@@ -6,7 +6,7 @@ module RailsPerformance
           # TODO change to set
           CurrentRequest.current.ignore.add(:performance)
 
-          now = Time.current
+          now = RailsPerformance::Utils.time
           CurrentRequest.current.data ||= {}
           CurrentRequest.current.record ||= RailsPerformance::Models::GrapeRecord.new(request_id: CurrentRequest.current.request_id)
           CurrentRequest.current.record.datetimei ||= now.to_i

data/lib/rails_performance/gems/rake_ext.rb

@@ -4,7 +4,7 @@ module RailsPerformance
       def self.init
         ::Rake::Task.class_eval do
           def invoke_with_rails_performance(*args)
-            now = Time.current
+            now = RailsPerformance::Utils.time
             status = "success"
             invoke_without_new_rails_performance(*args)
           rescue Exception => ex # rubocop:disable Lint/RescueException
@@ -18,7 +18,7 @@ module RailsPerformance
                 task: task_info,
                 datetime: now.strftime(RailsPerformance::FORMAT),
                 datetimei: now.to_i,
-                duration: (Time.current - now) * 1000,
+                duration: (RailsPerformance::Utils.time - now) * 1000,
                 status: status
               ).save
             end

data/lib/rails_performance/gems/sidekiq_ext.rb

@@ -5,7 +5,7 @@ module RailsPerformance
       end
 
       def call(worker, msg, queue)
-        now = Time.current
+        now = RailsPerformance::Utils.time
         record = RailsPerformance::Models::SidekiqRecord.new(
           enqueued_ati: msg["enqueued_at"].to_i,
           datetimei: msg["created_at"].to_i,
@@ -25,7 +25,7 @@ module RailsPerformance
           raise ex
         ensure
           # store in ms instead of seconds
-          record.duration = (Time.current - now) * 1000
+          record.duration = (RailsPerformance::Utils.time - now) * 1000
           record.save
         end
       end

data/lib/rails_performance/instrument/metrics_collector.rb

@@ -25,6 +25,8 @@ module RailsPerformance
         return if RailsPerformance.ignored_endpoints.include? "#{event.payload[:controller]}##{event.payload[:action]}"
         return if RailsPerformance.ignored_paths.any? { |p| event.payload[:path].start_with?(p) }
 
+        finished = finished.utc
+
         record = {
           controller: event.payload[:controller],
           action: event.payload[:action],

data/lib/rails_performance/models/base_record.rb

@@ -1,18 +1,6 @@
 module RailsPerformance
   module Models
     class BaseRecord
-      def self.from_db(key, value)
-        raise "implement me"
-      end
-
-      def save
-        raise "implement me"
-      end
-
-      def record_hash
-        raise "implement me"
-      end
-
       def value
         @value ||= JSON.parse(@json || "{}")
       end
@@ -24,9 +12,7 @@ module RailsPerformance
       private
 
       def ms(e)
-        if e
-          e.to_f.round(1).to_s + " ms"
-        end
+        e.to_f.round(1).to_s + " ms" if e
       end
     end
   end

data/lib/rails_performance/models/custom_record.rb

@@ -32,7 +32,7 @@ module RailsPerformance
           namespace_name: namespace_name,
           status: status,
           datetimei: datetimei,
-          datetime: Time.at(datetimei.to_i),
+          datetime: RailsPerformance::Utils.from_datetimei(datetimei.to_i),
           duration: value["duration"]
         }
       end

data/lib/rails_performance/models/delayed_job_record.rb

@@ -41,7 +41,7 @@ module RailsPerformance
       def record_hash
         {
           jid: jid,
-          datetime: Time.at(datetimei),
+          datetime: RailsPerformance::Utils.from_datetimei(datetimei),
           datetimei: datetimei,
           duration: value["duration"],
           status: status,

data/lib/rails_performance/models/grape_record.rb

@@ -43,7 +43,7 @@ module RailsPerformance
           status: status,
           method: method,
           path: path,
-          datetime: Time.at(datetimei.to_i),
+          datetime: RailsPerformance::Utils.from_datetimei(datetimei.to_i),
           datetimei: datetimei.to_i,
           request_id: request_id
         }.merge(value)

data/lib/rails_performance/models/rake_record.rb

@@ -31,7 +31,7 @@ module RailsPerformance
       def record_hash
         {
           task: task,
-          datetime: Time.at(datetimei),
+          datetime: RailsPerformance::Utils.from_datetimei(datetimei),
           datetimei: datetimei,
           duration: duration,
           status: status

data/lib/rails_performance/models/request_record.rb

@@ -94,7 +94,7 @@ module RailsPerformance
           method: method,
           path: path,
           request_id: request_id,
-          datetime: Time.at(datetimei.to_i),
+          datetime: RailsPerformance::Utils.from_datetimei(datetimei.to_i),
           datetimei: datetimei,
           duration: value["duration"],
           db_runtime: value["db_runtime"],

data/lib/rails_performance/models/resource_record.rb

@@ -31,7 +31,7 @@ module RailsPerformance
           role: role,
           context: context,
           datetime: datetime,
-          datetimei: Time.at(datetimei.to_i),
+          datetimei: RailsPerformance::Utils.from_datetimei(datetimei.to_i),
           cpu: value["cpu"],
           memory: value["memory"],
           disk: value["disk"]
@@ -40,7 +40,8 @@ module RailsPerformance
 
       def save
         key = "resource|server|#{server}|context|#{context}|role|#{role}|datetime|#{datetime}|datetimei|#{datetimei}|END|#{RailsPerformance::SCHEMA}"
-        Utils.save_to_redis(key, json)
+        # with longer expiration time
+        Utils.save_to_redis(key, json, RailsPerformance.system_monitor_duration.to_i)
       end
     end
   end

data/lib/rails_performance/models/sidekiq_record.rb

@@ -49,7 +49,7 @@ module RailsPerformance
           jid: jid,
           status: status,
           datetimei: datetimei,
-          datetime: Time.at(start_timei.to_i),
+          datetime: RailsPerformance::Utils.from_datetimei(start_timei.to_i),
           duration: value["duration"],
           message: value["message"]
         }

data/lib/rails_performance/rails/middleware.rb

@@ -41,7 +41,7 @@ module RailsPerformance
       def call!(env)
         @status, @headers, @response = @app.call(env)
 
-        # t = Time.current
+        # t = RailsPerformance::Utils.time
         if !RailsPerformance.skip
           if !CurrentRequest.current.ignore.include?(:performance) # grape is executed first, and than ignore regular future storage of "controller"-like request
             if (data = CurrentRequest.current.data)
@@ -66,7 +66,7 @@ module RailsPerformance
             end
           end
         end
-        # puts "==> store performance data: #{(Time.current - t).round(3)}ms"
+        # puts "==> store performance data: #{(RailsPerformance::Utils.time - t).round(3)}ms"
 
         [@status, @headers, @response]
       end

data/lib/rails_performance/reports/base_report.rb

@@ -30,11 +30,12 @@ module RailsPerformance
         end
       end
 
+      # TODO: simplify this method, and combine with nullify_data
       def calculate_data
-        now = Time.current
+        now = RailsPerformance::Utils.time
         now = now.change(sec: 0, usec: 0)
-        stop = Time.at(60 * (now.to_i / 60))
-        offset = RailsPerformance::Reports::BaseReport.time_in_app_time_zone(now).utc_offset
+        stop = now # Time.at(60 * (now.to_i / 60), in:)
+        offset = 0 # RailsPerformance::Reports::BaseReport.time_in_app_time_zone(now).utc_offset
         current = stop - RailsPerformance.duration
 
         @data = []
@@ -48,7 +49,7 @@ module RailsPerformance
         while current <= stop
           key = current.strftime(RailsPerformance::FORMAT)
           views = all[key].presence || 0
-          @data << [(current.to_i + offset) * 1000, views.is_a?(Numeric) ? views.round(2) : views]
+          @data << [(current.to_i + offset) * 1000, views.round(2)]
           current += 1.minute
         end
 
@@ -62,14 +63,14 @@ module RailsPerformance
       #   1732125550000 => 0,
       #   ....
       # }
-      def nil_data
+      def nil_data(duration = RailsPerformance.duration)
         @nil_data ||= begin
           result = {}
-          now = Time.current
+          now = RailsPerformance::Utils.time
           now = now.change(sec: 0, usec: 0)
-          stop = Time.at(60 * (now.to_i / 60))
-          offset = RailsPerformance::Reports::BaseReport.time_in_app_time_zone(now).utc_offset
-          current = stop - RailsPerformance.duration
+          stop = now # Time.at(60 * (now.to_i / 60))
+          offset = 0 # RailsPerformance::Reports::BaseReport.time_in_app_time_zone(now).utc_offset
+          current = stop - duration
 
           while current <= stop
             current.strftime(RailsPerformance::FORMAT)
@@ -85,8 +86,8 @@ module RailsPerformance
       #   1732125540000 => 1,
       #   1732125550000 => 0,
       # }
-      def nullify_data(input)
-        nil_data.merge(input).sort
+      def nullify_data(input, duration = RailsPerformance.duration)
+        nil_data(duration).merge(input).sort
       end
     end
   end

data/lib/rails_performance/reports/resources_report.rb

@@ -1,24 +1,17 @@
 module RailsPerformance
   module Reports
     class ResourcesReport < BaseReport
-      def self.x
-        @datasource = RailsPerformance::DataSource.new(type: :resources)
-        db = @datasource.db
-        @data = RailsPerformance::Reports::ResourcesReport.new(db)
-        # RailsPerformance::Reports::ResourcesReport.x
-      end
-
       def data
         @data ||= db.data
           .collect { |e| e.record_hash }
           .group_by { |e| e[:server] + "///" + e[:context] + "///" + e[:role] }
-          .transform_values { |v| v.sort { |a, b| b[sort] <=> a[sort] } }
+          # .transform_values { |v| v.sort { |a, b| b[sort] <=> a[sort] } }
           .transform_values { |v| v.map { |e| e.merge({datetimei: e[:datetimei].to_i}) } }
       end
 
       def cpu
         @cpu ||= data.transform_values do |v|
-          nullify_data(v.each_with_object({}) do |e, res|
+          prepare_report(v.each_with_object({}) do |e, res|
             res[e[:datetimei] * 1000] = e[:cpu]["one_min"].to_f.round(2)
           end)
         end
@@ -26,7 +19,7 @@ module RailsPerformance
 
       def memory
         @memory ||= data.transform_values do |v|
-          nullify_data(v.each_with_object({}) do |e, res|
+          prepare_report(v.each_with_object({}) do |e, res|
             res[e[:datetimei] * 1000] = e[:memory].to_f.round(2)
           end)
         end
@@ -34,11 +27,17 @@ module RailsPerformance
 
       def disk
         @disk ||= data.transform_values do |v|
-          nullify_data(v.each_with_object({}) do |e, res|
+          prepare_report(v.each_with_object({}) do |e, res|
             res[e[:datetimei] * 1000] = e[:disk]["available"].to_f.round(2)
           end)
         end
       end
+
+      private
+
+      def prepare_report(input)
+        nullify_data(input, RailsPerformance.system_monitor_duration)
+      end
     end
   end
 end

data/lib/rails_performance/thread/current_request.rb

@@ -27,7 +27,7 @@ module RailsPerformance
     end
 
     def trace(options = {})
-      @tracings << options.merge(time: Time.current.to_i)
+      @tracings << options.merge(time: RailsPerformance::Utils.time.to_i)
     end
   end
 end

data/lib/rails_performance/utils.rb

@@ -1,5 +1,13 @@
 module RailsPerformance
   class Utils
+    def self.time
+      Time.now.utc
+    end
+
+    def self.from_datetimei(datetimei)
+      Time.at(datetimei, in: "+00:00")
+    end
+
     # date key in redis store
     def self.cache_key(now = Date.today)
       "date-#{now}"
@@ -7,7 +15,7 @@ module RailsPerformance
 
     # write to current slot
     # time - date -minute
-    def self.field_key(now = Time.current)
+    def self.field_key(now = RailsPerformance::Utils.time)
       now.strftime("%H:%M")
     end
 
@@ -32,8 +40,8 @@ module RailsPerformance
       RailsPerformance.redis.set(key, value.to_json, ex: expire.to_i)
     end
 
-    def self.days
-      (RailsPerformance.duration / 1.day) + 1
+    def self.days(duration = RailsPerformance.duration)
+      (duration / 1.day) + 1
     end
 
     def self.median(array)

data/lib/rails_performance/version.rb

@@ -1,4 +1,4 @@
 module RailsPerformance
-  VERSION = "1.4.0.alpha3"
-  SCHEMA = "1.0.1"
+  VERSION = "1.4.0.alpha5"
+  SCHEMA = "1.0.2"
 end

data/lib/rails_performance.rb

@@ -119,6 +119,14 @@ module RailsPerformance
   mattr_accessor :ignore_trace_headers
   @@ignore_trace_headers = ["datetimei"]
 
+  # System monitor duration (expiration time)
+  mattr_accessor :system_monitor_duration
+  @@system_monitor_duration = 24.hours
+
+  # -- internal usage --
+  #
+  #
+  # to store the resource monitor instance
   mattr_accessor :_resource_monitor
   @@_resource_monitor = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_performance
 version: !ruby/object:Gem::Version
-  version: 1.4.0.alpha3
+  version: 1.4.0.alpha5
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties