Merge pull request #150 from igorkasyanchuk/deploy_events

igorkasyanchuk · web-flow · commit 8c824111aa03 · 2025-08-28T23:23:51.000+03:00
Deployment events
diff --git a/Gemfile b/Gemfile
@@ -15,7 +15,7 @@ gemspec
 # gem 'byebug', group: [:development, :test]
 gem "rails", "8.0.0"
 
-gem "pry"
+gem "debug"
 gem "sqlite3"
 
 gem "simplecov", require: false, group: :test
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -87,13 +87,15 @@ GEM
     bigdecimal (3.1.8)
     browser (5.3.1)
     builder (3.3.0)
-    coderay (1.1.3)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
     csv (3.3.0)
     daemons (1.4.1)
     date (3.4.0)
+    debug (1.11.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     delayed_job (4.1.13)
       activesupport (>= 3.0, < 9.0)
     delayed_job_active_record (4.1.11)
@@ -155,7 +157,6 @@ GEM
       net-pop
       net-smtp
     marcel (1.0.4)
-    method_source (1.1.0)
     mimemagic (0.4.3)
       nokogiri (~> 1)
       rake
@@ -185,9 +186,6 @@ GEM
     parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
-    pry (0.15.0)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
     psych (5.2.0)
       stringio
     puma (6.5.0)
@@ -324,13 +322,13 @@ DEPENDENCIES
   activestorage
   csv
   daemons
+  debug
   delayed_job_active_record
   devise
   get_process_mem
   grape
   mimemagic (= 0.4.3)
   ostruct
-  pry
   puma
   rails (= 8.0.0)
   rails_performance!
diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ It allows you to track:
 - total duration of time spent per request, views rendering, DB
 - SQL queries, rendering logs in "Recent Requests" section
 - simple 500-crashes reports
+- deployment events (or custom events)
 - Sidekiq jobs
 - Delayed Job jobs
 - Grape API inside Rails app
@@ -237,6 +238,31 @@ More information here: `lib/rails_performance/engine.rb`.
 
 PS: right now it can only distinguish between web app servers and the sidekiq servers.
 
+#### Deployment Events + Custom Events on the Charts
+
+![Deployments](docs/deploys.png)
+
+#### For Kamal
+
+- edit `.kamal/hooks/post-deploy` (rename .sample if needed)
+- add `kamal app exec -p './bin/rails runner "RailsPerformance.create_event(name: \"Deploy\")"'`
+- kamal deploy
+
+#### Custom Events on the Charts
+
+You can specify colors, orientation for the event label.
+
+```ruby
+RailsPerformance.create_event(name: "Deploy", options: {
+  borderColor: "#00E396",
+  label: {
+    borderColor: "#00E396",
+    orientation: "horizontal",
+    text: "Deploy"
+  }
+})
+```
+
 ### Custom events
 
 ```ruby
diff --git a/app/views/rails_performance/javascripts/app.js b/app/views/rails_performance/javascripts/app.js
@@ -79,7 +79,8 @@ function showTIRChart(element_id, data, addon, name) {
     series: [{
       name: name,
       data: data
-    }]
+    }],
+    annotations: window?.annotationsData || {}
   });
 }
 
@@ -90,6 +91,7 @@ function showRTChart(element_id, data) {
       name: 'Response Time',
       data: data,
     }],
+    annotations: window?.annotationsData || {}
   });
 }
 
diff --git a/app/views/rails_performance/layouts/rails_performance.html.erb b/app/views/rails_performance/layouts/rails_performance.html.erb
@@ -8,6 +8,9 @@
     <%= csp_meta_tag if ::Rails::VERSION::STRING.to_f >= 5.2 %>
     <%= render '/rails_performance/stylesheets/stylesheets' %>
     <link rel="shortcut icon" href="/favicon.ico">
+    <script>
+      window.annotationsData = <%= raw RailsPerformance::Reports::AnnotationsReport.new.data.to_json %>;
+    </script>
   </head>
 
   <body class="has-sticky-footer">
diff --git a/docs/deploys.png b/docs/deploys.png
diff --git a/lib/rails_performance.rb b/lib/rails_performance.rb
@@ -26,10 +26,15 @@
 require_relative "rails_performance/reports/trace_report"
 require_relative "rails_performance/reports/percentile_report"
 require_relative "rails_performance/reports/resources_report"
+require_relative "rails_performance/reports/annotations_report"
+require_relative "rails_performance/events/record"
 require_relative "rails_performance/extensions/trace"
 require_relative "rails_performance/thread/current_request"
+require_relative "rails_performance/interface"
 
 module RailsPerformance
+  extend RailsPerformance::Interface
+
   FORMAT = "%Y%m%dT%H%M"
 
   mattr_accessor :redis
diff --git a/lib/rails_performance/data_source.rb b/lib/rails_performance/data_source.rb
@@ -22,7 +22,7 @@ def initialize(type:, q: {}, days: RailsPerformance::Utils.days(RailsPerformance
 
     def db
       result = RailsPerformance::Models::Collection.new
-      now = RailsPerformance::Utils.time
+      now = RailsPerformance::Utils.kind_of_now
       (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
diff --git a/lib/rails_performance/events/record.rb b/lib/rails_performance/events/record.rb
@@ -0,0 +1,62 @@
+module RailsPerformance
+  module Events
+    class Record
+      attr_reader :name, :datetimei, :options
+
+      DEFAULT_COLOR = "#FF00FF"
+      DEFAULT_LABEL_COLOR = "#FF00FF"
+      DEFAULT_LABEL_ORIENTATION = "horizontal"
+
+      class << self
+        def create(name:, datetimei: Time.now.to_i, options: {})
+          instance = new(name: name, datetimei: datetimei, options: options)
+          instance.save
+          instance
+        end
+
+        def all
+          _, values = RailsPerformance::Utils.fetch_from_redis("rails_performance:records:events:*")
+          Array(values).map do |value|
+            json = JSON.parse(value)
+            new(name: json["name"], datetimei: json["datetimei"], options: Hash(json["options"]))
+          end
+        end
+      end
+
+      def initialize(name:, datetimei:, options: {})
+        @name = name
+        @datetimei = datetimei
+        @options = options
+      end
+
+      def save
+        RailsPerformance::Utils.save_to_redis(rails_performance_key, value)
+      end
+
+      def rails_performance_key
+        "rails_performance:records:events:#{datetimei}|#{RailsPerformance::EVENTS_SCHEMA}"
+      end
+
+      def value
+        {
+          name: name,
+          datetime: RailsPerformance::Utils.from_datetimei(datetimei.to_i),
+          datetimei: datetimei,
+          options: options
+        }
+      end
+
+      def to_annotation
+        {
+          x: datetimei * 1000,
+          borderColor: options.dig("borderColor") || DEFAULT_COLOR,
+          label: {
+            borderColor: options.dig("label", "borderColor") || DEFAULT_LABEL_COLOR,
+            orientation: options.dig("label", "orientation") || DEFAULT_LABEL_ORIENTATION,
+            text: options.dig("label", "text") || name
+          }
+        }
+      end
+    end
+  end
+end
diff --git a/lib/rails_performance/interface.rb b/lib/rails_performance/interface.rb
@@ -0,0 +1,7 @@
+module RailsPerformance
+  module Interface
+    def create_event(name:, datetime: RailsPerformance::Utils.time, options: {})
+      RailsPerformance::Events::Record.create(name: name, datetimei: datetime.to_i, options: options)
+    end
+  end
+end
diff --git a/lib/rails_performance/reports/annotations_report.rb b/lib/rails_performance/reports/annotations_report.rb
@@ -0,0 +1,13 @@
+class RailsPerformance::Reports::AnnotationsReport
+  def data
+    {
+      xaxis: xaxis
+    }
+  end
+
+  private
+
+  def xaxis
+    RailsPerformance::Events::Record.all.map(&:to_annotation)
+  end
+end
diff --git a/lib/rails_performance/reports/base_report.rb b/lib/rails_performance/reports/base_report.rb
@@ -32,7 +32,7 @@ def self.time_in_app_time_zone(time)
 
       # TODO: simplify this method, and combine with nullify_data
       def calculate_data
-        now = RailsPerformance::Utils.time
+        now = RailsPerformance::Utils.kind_of_now
         now = now.change(sec: 0, usec: 0)
         stop = now # Time.at(60 * (now.to_i / 60), in:)
         offset = 0 # RailsPerformance::Reports::BaseReport.time_in_app_time_zone(now).utc_offset
@@ -66,7 +66,7 @@ def calculate_data
       def nil_data(duration = RailsPerformance.duration)
         @nil_data ||= begin
           result = {}
-          now = RailsPerformance::Utils.time
+          now = RailsPerformance::Utils.kind_of_now
           now = now.change(sec: 0, usec: 0)
           stop = now # Time.at(60 * (now.to_i / 60))
           offset = 0 # RailsPerformance::Reports::BaseReport.time_in_app_time_zone(now).utc_offset
diff --git a/lib/rails_performance/system_monitor/resources_monitor.rb b/lib/rails_performance/system_monitor/resources_monitor.rb
@@ -60,7 +60,7 @@ def run
       def store_data(data)
         ::Rails.logger.info("Server: #{server_id}, Context: #{context}, Role: #{role}, data: #{data}")
 
-        now = RailsPerformance::Utils.time
+        now = RailsPerformance::Utils.kind_of_now
         now = now.change(sec: 0, usec: 0)
         RailsPerformance::Models::ResourceRecord.new(
           server: server_id,
diff --git a/lib/rails_performance/utils.rb b/lib/rails_performance/utils.rb
@@ -1,9 +1,15 @@
 module RailsPerformance
   class Utils
+    DEFAULT_TIME_OFFSET = 1.minute
+
     def self.time
       Time.now.utc
     end
 
+    def self.kind_of_now
+      time + DEFAULT_TIME_OFFSET
+    end
+
     def self.from_datetimei(datetimei)
       Time.at(datetimei, in: "+00:00")
     end
diff --git a/lib/rails_performance/version.rb b/lib/rails_performance/version.rb
@@ -1,4 +1,5 @@
 module RailsPerformance
   VERSION = "1.4.3"
   SCHEMA = "1.0.2"
+  EVENTS_SCHEMA = "1.0.0"
 end
diff --git a/test/events_test.rb b/test/events_test.rb
@@ -0,0 +1,28 @@
+require "test_helper"
+
+class RailsPerformance::EventsTest < ActiveSupport::TestCase
+  test "create_event" do
+    assert_nothing_raised do
+      RailsPerformance.create_event(name: "test", options: {
+        borderColor: "#00E396",
+        label: {
+          borderColor: "#00E396",
+          orientation: "horizontal",
+          text: "test"
+        }
+      })
+    end
+
+    events = RailsPerformance::Events::Record.all
+    assert_equal events.size, 1
+    assert_equal events.first.name, "test"
+    assert_equal events.first.options, {
+      borderColor: "#00E396",
+      label: {
+        borderColor: "#00E396",
+        orientation: "horizontal",
+        text: "test"
+      }
+    }.deep_stringify_keys
+  end
+end
