builder_apm 0.4.2 → 0.5.1

data/lib/builder_apm/doctor/ai_doctor.rb

@@ -0,0 +1,170 @@
+require 'builder_apm/doctor/openai_chat_gpt'
+require 'builder_apm/doctor/bravo_chat_ai'
+
+module BuilderApm
+    module Doctor
+        class AiDoctor
+            def initialize
+                api_key = BuilderApm.configuration.api_key
+                case BuilderApm.configuration.api
+                when "OpenAi"
+                  @ai_client = OpenAIChatGPT.new(api_key, "gpt-3.5-turbo-16k")
+                else
+                  @ai_client = BravoChatAi.new(api_key)
+                end
+                @role = "You are an AI trained to analyse and optimise web requests and database queries for a Ruby on Rails api. Your task is to identify any performance issues in the given request data, suggest possible solutions and show examples, Also show which files/methods should be looked into further"
+                @ai_client.role(@role)
+            end
+
+            def diagnose(request_data) 
+                diagnosis = if request_data["status"] == 500
+                    diagnose_error(reduced_backtrace(request_data), backtrace_error(request_data) )
+                else
+                    diagnose_backtrace(reduced_backtrace(request_data))
+                end
+                diagnosis
+            end
+
+            def diagnose_error(backtrace, error)
+                prompt = "Please review this error and stack trace for errors and provide feedback, followed by the path/filename of the rails app file causing the error and then any other files that need further investigation
+eg
+<h2>{the error}</h2>
+<h3>Problem found:</h3>
+<p>{details for the problem found}</p>
+
+<h3>Solutions:</h3>
+<p>{list of solutions}</p>
+
+<dl><dt>Main Error File : </dt><dd class=\"main_file\"><input type=\"checkbox\" value=\"{path/filename4.ext:[line_number]}\" name=\"deeper_dive_filename\" />{path/filename.ext:line_number }</dd></dl>
+<dl><dt>Addtional Files to review:{do not include the duplicate files regardless of different line number}</dt>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename1.ext:[line_number, line_number]}\" name=\"deeper_dive_filename\" />{path/filename1.ext:[line_number, line_number]}</dd>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename2.ext:[line_number, line_number, line_number, line_number]}\" name=\"deeper_dive_filename\" />{path/filename2.ext:[line_number, line_number, line_number, line_number]}</dd>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename3.ext:[line_number, line_number]}\" name=\"deeper_dive_filename\" />{path/filename3.ext:[line_number, line_number]}</dd>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename4.ext:[line_number]}\" name=\"deeper_dive_filename\" />{path/filename4.ext:[line_number]}</dd>
+</dl>
+
+Error:
+#{error}
+
+Stack Trace:
+#{backtrace}"
+                @ai_client.role("You are an AI trained to analyse and diagnose web requests for a Ruby on Rails api. Your task is to identify the error in the given request data, suggest possible solutions, Also show which files/methods should be looked into further")
+                @ai_client.chat(prompt)
+            end
+
+            def diagnose_backtrace(backtrace)
+                
+prompt = "Here is the request data, durations in milliseconds: \n#{backtrace}
+Analyze this Stack trace and provide any potential performance issues and solutions.
+The issues where more investigation into the code is required, include a list of files that are worth reviewing, unless the file path is part of gem or active_admin then skip that file and work out where in the rails app the trigger was and include that instead- path and file only (agregated, don't repeat a file even if its another line within that file).
+eg
+<h2>High Level Issues</h2>
+<h3>{Issue type found}</h3>
+<p>{times and where issue type was found}</p>
+<p>{details of what this issue is and how it can effect the performance}</p>
+{list of possibly solutions to fix said issue}
+
+<h3>{Issue type found}</h3>
+<p>{times and where issue type was found}</p>
+<p>{details of what this issue is and how it can effect the performance}</p>
+{list of possibly solutions to fix said issue}
+[repeat Issue type found until no more issues type are left]
+
+
+<dl><dt>Main Error File : </dt><dd class=\"main_file\"><input type=\"checkbox\" value=\"{path/filename4.ext:[line_number]}\" name=\"deeper_dive_filename\" />{path/filename.ext:line_number }</dd></dl>
+<dl><dt>Addtional Files to review:{do not include the duplicate files regardless of different line number}</dt>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename1.ext:[line_number, line_number]}\" name=\"deeper_dive_filename\" />{path/filename1.ext:[line_number, line_number]}</dd>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename2.ext:[line_number, line_number, line_number, line_number]}\" name=\"deeper_dive_filename\" />{path/filename2.ext:[line_number, line_number, line_number, line_number]}</dd>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename3.ext:[line_number, line_number]}\" name=\"deeper_dive_filename\" />{path/filename3.ext:[line_number, line_number]}</dd>
+<dd class=\"other_file\"><input type=\"checkbox\" value=\"{path/filename4.ext:[line_number]}\" name=\"deeper_dive_filename\" />{path/filename4.ext:[line_number]}</dd>
+</dl>
+
+"
+                
+                @ai_client.chat(prompt)
+            end
+        
+            def deeper_analysis(request_data, diagnosis, files)
+                targeted_code = files.map do |file_n_line|
+                    parts = file_n_line&.split(':')
+                    next if parts&.length < 2
+
+                    file = parts.first
+                    line = parts.last.to_i
+                    extract_lines_from_file(file, line)
+                end
+                messages = [
+                    {
+                        role: "user",
+                        content: "Here is the request data, durations in milliseconds: \n#{reduced_backtrace(request_data)}"
+                    },
+                    {
+                        role: "assistant",
+                        content: diagnosis
+                    },
+                    {
+                        role: "user",
+                        content: "this is the code block mentioned in the list of files:
+#{targeted_code.join("")}
+
+#{deep_anaysis_call_to_action(request_data)}, no solution should include altering files that have a path folder called gems, As I am unable to edit those files
+eg
+<p>{description of what the fix is}</p>
+
+<pre>{code fix 1}</pre>
+<p>{notes / comments}</p>
+[repeat for each code fix presented]"
+                    },
+                ]
+
+                @ai_client.chat(messages)
+            end
+
+            private 
+
+            def deep_anaysis_call_to_action(request_data)
+                return "Provide a code fix for this issue" unless request_data["status"] == 500
+
+                "Exception Error:
+#{request_data["exception_message"]}
+
+Exception Backtrace:
+#{request_data["exception_backtrace"]}
+Provide a code fix for this Exception Error
+"
+            end
+
+            def extract_lines_from_file(file_path, target_line)
+                # debugger
+                return [] unless File.exist?(file_path)
+              
+                start_line = [target_line - 20, 1].max
+                end_line = target_line + 19
+                
+                extracted_lines = ["
+                    This is the file reported as having an issue #{file_path} on line #{target_line}.\n",
+                    "##{file_path}\n"]
+              
+                File.open(file_path, 'r') do |file|
+                    file.each_line.drop(start_line - 1).take(end_line - start_line + 1).each_with_index do |line, index|
+                        extracted_lines << "Line #{start_line + index}: #{line}"
+                    end
+                end
+              
+                extracted_lines.join("")
+            end
+
+            def backtrace_error(request_data)
+                {
+                  exception_message: request_data["exception_message"],
+                  exception_backtrace: request_data["exception_backtrace"]
+                }.to_s
+            end
+        
+            def reduced_backtrace(request_data)
+                reducer = BuilderApm::Doctor::BacktraceReducer.new
+                reducer.reduce_backtrace(data: request_data)
+            end
+        end
+    end
+end

data/lib/builder_apm/doctor/backtrace_reducer.rb

@@ -0,0 +1,104 @@
+require 'json'
+require 'digest'
+
+module BuilderApm
+  module Doctor
+    class BacktraceReducer
+      TOKEN_LIMIT = 10500
+
+      def initialize
+        @token_count = 0
+        @ref_count = 0
+      end
+
+      def reduce_method(method)
+        return nil if over_limit?
+
+        reduced_method = build_reduced_method(method)
+        return nil if reduced_method["dur"] < 1 && reduced_method["dur"] > 0
+
+        increment_token_count(reduced_method.to_json)
+
+        process_sql_events(method, reduced_method)
+        process_children(method, reduced_method)
+
+        reduced_method
+      end
+
+      def build_reduced_method(method)
+        {
+          "dur" => method.fetch("duration", 0.0).to_f.round(3),
+          "method" => method.fetch("method", nil),
+          "line" => method.fetch("method_line", nil),
+          "trigger" => method.fetch("triggering_line", nil),
+          "sql" => [],
+          "children" => []
+        }
+      end
+
+      def process_sql_events(method, reduced_method)
+        method.fetch("sql_events", []).each do |event| 
+          sql_event = reduce_event(event) 
+          return if over_limit? || (sql_event["dur"] < 1 && sql_event["dur"] > 0)
+
+          reduced_method["sql"] << sql_event
+          increment_token_count(sql_event.to_s)
+        end
+      end
+
+      def process_children(method, reduced_method)
+        method.fetch("children", []).each do  |child| 
+          reduced_child = reduce_method(child)
+          return if over_limit?
+
+          reduced_method["children"] << reduced_child unless reduced_child.nil?
+        end
+      end
+
+      def reduce_event(event)
+        params = event.fetch("params", [])
+        params = short_hash(params) if params.size > 3
+        # sql = truncate_string(event.fetch("sql", ""), 400)
+        sql = truncate_string(event.fetch("sql", "").gsub("\"", ""), 400)
+
+        {
+          "dur" => event.fetch("duration", 0.0).to_f.round(3),
+          "sql" => sql,
+          "params" => params,
+          "records" => event.fetch("record_count", 0),
+          "trigger" => event.fetch("triggering_line", nil)
+        }
+      end
+
+      def reduce_json(json)
+        json.map { |method| reduce_method(method) }.compact
+      end
+
+      def short_hash(input_string)
+        Digest::MD5.hexdigest(input_string.join(','))[0...8]
+      end
+
+      def truncate_string(str, length)
+        str.length > length ? str[0...length] + "..." : str
+      end
+
+      def count_tokens(string)
+        tokens = string.scan(/[\w']+|[.,!?;:]/)
+        tokens = tokens.flat_map { |token| token.split(/(?<=[.,!?;:])$/) }
+        tokens.length + 17
+      end
+
+      def increment_token_count(string)
+        @token_count += count_tokens(string)
+      end
+
+      def over_limit?
+        @token_count + @ref_count > TOKEN_LIMIT
+      end
+
+      def reduce_backtrace(data: {})
+        reduce_json(data["stack"]).to_s
+      end
+    end
+  end
+end

data/lib/builder_apm/doctor/bravo_chat_ai.rb

@@ -0,0 +1,85 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module BuilderApm
+  module Doctor
+    class BravoChatAi
+        MAX_RETRIES = 3
+        TIMEOUT_IN_SECONDS = 300 # equivalent to 5 minutes
+
+        def initialize(api_key)
+            @api_key = api_key
+            @uri = URI.parse("https://models-gateway.builder.ai/api/v1/openai/deployments/gpt-35-turbo/chat/completions")
+            @role = "You are to be my assistant"
+            @temperature = 0.2
+        end
+
+        def role(ai_role = nil)
+            @role = ai_role unless ai_role.nil?
+            
+            @role
+        end
+
+        def temperature(temp = nil)
+            @temperature = temp unless temp.nil?
+            
+            @temperature
+        end
+
+        def chat(messages)
+            request = Net::HTTP::Post.new(@uri)
+            request.content_type = "application/json"
+            request["api-key"] = @api_key
+            request.body = JSON.dump({
+                "temperature" => temperature,
+                "messages" => construct_messages(messages)
+            })
+
+            req_options = {
+                use_ssl: @uri.scheme == "https",
+            }
+
+            begin
+              retries ||= 0
+              response = Net::HTTP.start(@uri.hostname, @uri.port, req_options) do |http|
+                http.read_timeout = TIMEOUT_IN_SECONDS
+                http.request(request)
+              end
+            rescue Net::ReadTimeout => e
+              if retries < MAX_RETRIES
+                retries += 1
+                retry
+              else
+                raise e
+              end
+            end
+    
+            begin
+                JSON.parse(response.body)["choices"].first["message"]["content"]
+            rescue => e 
+                error = JSON.parse(response.body)["error"]
+                output = error["message"]
+                output += "\n\nThis file is too large and should be looked at breaking it down into smaller files / services" if error["code"] == "context_length_exceeded"
+
+                output
+            end
+        end
+
+        private
+
+        def construct_messages(messages)
+            messages_array = case messages
+                            when String
+                              [{"role" => "user", "content" => messages}]
+                            when Array
+                              messages.map { |hash| hash.transform_keys(&:to_s) }
+                            else
+                              raise ArgumentError, "Unsupported message format"
+                            end
+            
+            [{"role" => "system", "content" => role}] + messages_array
+        end
+    end
+  end
+end

data/lib/builder_apm/doctor/openai_chat_gpt.rb

@@ -0,0 +1,84 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module BuilderApm
+  module Doctor
+    class OpenAIChatGPT
+        
+      MAX_RETRIES = 3
+      TIMEOUT_IN_SECONDS = 300 # equivalent to 5 minutes
+
+      def initialize(api_key, model = "gpt-3.5-turbo")
+        @api_key = api_key
+        @uri = URI.parse("https://api.openai.com/v1/chat/completions")
+        @role = "You are to be my assistant"
+        @model = model
+        @temperature = 0.2
+      end
+
+      def role(ai_role = nil)
+        @role = ai_role unless ai_role.nil?
+        
+        @role
+      end
+
+      def temperature(temp = nil)
+        @temperature = temp unless temp.nil?
+        
+        @temperature
+      end
+
+      def chat(messages)
+        request = Net::HTTP::Post.new(@uri)
+        request.content_type = "application/json"
+        request["Authorization"] = "Bearer #{@api_key}"
+
+        request.body = JSON.dump({
+            "model" => @model,
+            "temperature" => temperature,
+            "messages" => construct_messages(messages)
+        })
+
+        req_options = {
+          use_ssl: @uri.scheme == "https",
+        }
+
+        begin
+          retries ||= 0
+          response = Net::HTTP.start(@uri.hostname, @uri.port, req_options) do |http|
+            http.read_timeout = TIMEOUT_IN_SECONDS
+            http.request(request)
+          end
+        rescue Net::ReadTimeout => e
+          if retries < MAX_RETRIES
+            retries += 1
+            retry
+          else
+            raise e
+          end
+        end
+        
+        data = JSON.parse(response.body)["choices"]
+
+        raise data.dig("error", "message") if data.is_a?(Hash) && data.dig("error", "message") 
+
+        data.dig(0, "message", "content")
+      end
+
+      private
+        def construct_messages(messages)
+          messages_array = case messages
+                          when String
+                            [{"role" => "user", "content" => messages}]
+                          when Array
+                            messages.map { |hash| hash.transform_keys(&:to_s) }
+                          else
+                            raise ArgumentError, "Unsupported message format"
+                          end
+          
+          [{"role" => "system", "content" => role}] + messages_array
+      end
+    end
+  end
+end

data/lib/builder_apm/methods/instrumenter.rb

@@ -2,6 +2,7 @@ module BuilderApm
   module Methods
     class Instrumenter
       def initialize(root_path: Rails.root.to_s)
+        @this_gem_path = File.expand_path("../../..", __dir__)
         @root_path = root_path
         @call_times = {}
       end
@@ -17,28 +18,54 @@ module BuilderApm
 
       def setup_trace
         me = self
-        TracePoint.new(:call, :return) do |tp|
+        TracePoint.new(:call, :return, :end, :raise) do |tp|
+          starttime = Time.now.to_f * 1000
           me.process_trace_point(tp) if me.valid_trace_point?(tp)
+          duration = (Time.now.to_f * 1000) - starttime
+          
+          Thread.current["method_tracing"] = (Thread.current["method_tracing"] ||= 0) + duration
         end
       end
 
       def valid_trace_point?(tp)
-        !Thread.current[:request_id].nil? && tp.path.start_with?(@root_path) && !tp.path.include?('controller.rb')
+        return !Thread.current[:request_id].nil? && tp.path.start_with?(@root_path)
+
+        # !Thread.current[:request_id].nil? && not_controller_endpoint(tp) && valid_gem_path(tp)
+      end
+
+      def not_controller_endpoint(tp)
+        start_controller = Thread.current[:stack]&.first || nil
+
+        return false unless start_controller
+
+        "#{tp.defined_class}##{tp.method_id}" != start_controller[:method]
+      end
+
+      def valid_gem_path(tp)
+        not_this_gem = !tp.path.start_with?(@this_gem_path)
+        is_a_tracked_gem = tp.path.split(File::SEPARATOR).any? { |folder| folder.start_with?(*gems_to_track) }
+        is_a_rails_app_file = tp.path.start_with?(@root_path)
+
+        not_this_gem && (is_a_tracked_gem || is_a_rails_app_file)
       end
 
       def process_trace_point(tp)
-        if tp.event == :call
+        if tp.event == :call || tp.event == :b_call || tp.event == :c_call
           process_call_event(tp)
-        elsif tp.event == :return
+        else
           process_return_event(tp)
         end
       end
 
       private
 
+      def gems_to_track
+        @gems_to_track = BuilderApm.configuration.gems_to_track
+      end
+
       def process_call_event(tp)
         method_id = "#{tp.defined_class}##{tp.method_id}"
-        @call_times[method_id] = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        (@call_times[method_id]||= []) << Process.clock_gettime(Process::CLOCK_MONOTONIC)
         caller_info = caller_locations(4,1).first
         calling_file_path = caller_info.absolute_path
         calling_line_number = caller_info.lineno
@@ -59,7 +86,7 @@ module BuilderApm
         method_id = "#{tp.defined_class}##{tp.method_id}"
         
         if @call_times.key?(method_id)
-          elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @call_times[method_id]
+          elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @call_times[method_id].pop
           elapsed_time_in_ms = (elapsed_time * 1000).round(3)
           @call_times.delete(method_id)
 

data/lib/builder_apm/middleware/timing.rb

@@ -12,6 +12,8 @@ module BuilderApm
         Thread.current[:n_plus_one_duration] = 0
         Thread.current[:has_n_plus_one] = false
         Thread.current[:db_runtime] = 0
+        Thread.current[:method_tracing] = 0
+        Thread.current[:db_tracing] = 0
         start_time = Time.now.to_f * 1000
 
         @status, @headers, @response = @app.call(env)
@@ -36,6 +38,8 @@ module BuilderApm
         Thread.current[:db_runtime] = nil
         Thread.current[:stack] = nil
         Thread.current[:sql_event_id] = nil
+        Thread.current[:method_tracing] = nil
+        Thread.current[:db_tracing] = nil
       end
 
       def handle_timing(start_time, end_time, request_id)
@@ -53,6 +57,8 @@ module BuilderApm
           data[:stack][0][:start_time] = start_time
           data[:stack][0][:end_time] = end_time
           data[:stack][0][:duration] = end_time - start_time
+          data[:method_tracing] = Thread.current[:method_tracing]
+          data[:db_tracing] = Thread.current[:db_tracing]
           
           save_to_redis(data)
         end

data/lib/builder_apm/models/instrumenter.rb

@@ -6,8 +6,20 @@ module BuilderApm
       end
 
       def subscribe_to_notifications
-        ActiveSupport::Notifications.subscribe('sql.active_record') { |*args| handle_sql_active_record(*args) }
-        ActiveSupport::Notifications.subscribe('instantiation.active_record') { |*args| handle_instantiation_active_record(*args) }
+        ActiveSupport::Notifications.subscribe('sql.active_record') do |*args| 
+          starttime = Time.now.to_f * 1000
+          handle_sql_active_record(*args) 
+          duration = (Time.now.to_f * 1000) - starttime
+          
+          Thread.current[:db_tracing] = (Thread.current[:db_tracing] ||= 0) + duration
+        end
+        ActiveSupport::Notifications.subscribe('instantiation.active_record') do |*args| 
+          starttime = Time.now.to_f * 1000
+          handle_instantiation_active_record(*args) 
+          duration = (Time.now.to_f * 1000) - starttime
+          
+          Thread.current[:db_tracing] = (Thread.current[:db_tracing] ||= 0) + duration
+        end
       end
 
       private
@@ -111,7 +123,7 @@ module BuilderApm
 
         # If any N+1 issue is found, set 'has_n_plus_one' to true and return
         queries_count.each do |_, value|
-          if value[:count] > 1
+          if value[:count] > 2
             Thread.current[:has_n_plus_one] = true
             return
           end

data/lib/builder_apm/version.rb

@@ -1,3 +1,3 @@
 module BuilderApm
-  VERSION = "0.4.2"
+  VERSION = "0.5.1"
 end

data/lib/generators/builder_apm/templates/builder_apm_config.rb

@@ -1,6 +1,9 @@
 BuilderApm.configure do |config|
-  # config.redis_url = 'redis://localhost:6379/0'
-  # config.enable_controller_profiler = true
-  # config.enable_active_record_profiler = true
-  # config.enable_methods_profiler = true
+  config.redis_url = 'redis://localhost:6379/0'
+  config.enable_controller_profiler = true
+  config.enable_active_record_profiler = true
+  config.enable_methods_profiler = true
+  # config.api_key = ENV["OPENAI_API_KEY"]
+  # config.api = ENV["API_AI"] # "Bravo" - internal Ai | "OpenAi" - use openai ChatGPT
+  config.gems_to_track = ["bx_block_"] #partial and full gem names can be used.
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: builder_apm
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Paul Ketelle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,10 +55,10 @@ files:
 - ".rspec"
 - Gemfile
 - Gemfile.lock
-- README.md
 - Rakefile
 - app/controllers/builder_apm/application_controller.rb
 - app/controllers/builder_apm/dashboard_controller.rb
+- app/controllers/builder_apm/diagnose_request_controller.rb
 - app/controllers/builder_apm/error_requests_controller.rb
 - app/controllers/builder_apm/n_plus_one_controller.rb
 - app/controllers/builder_apm/recent_requests_controller.rb
@@ -96,6 +96,10 @@ files:
 - lib/builder_apm.rb
 - lib/builder_apm/configuration.rb
 - lib/builder_apm/controllers/instrumenter.rb
+- lib/builder_apm/doctor/ai_doctor.rb
+- lib/builder_apm/doctor/backtrace_reducer.rb
+- lib/builder_apm/doctor/bravo_chat_ai.rb
+- lib/builder_apm/doctor/openai_chat_gpt.rb
 - lib/builder_apm/engine.rb
 - lib/builder_apm/methods/instrumenter.rb
 - lib/builder_apm/middleware/timing.rb
@@ -126,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.0
 signing_key:
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.

data/README.md

@@ -1,29 +0,0 @@
-# BuilderApm
-
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'builder_apm'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install builder_apm
-
-run
-```
-rails generate builder_apm:install
-```
-
-## Usage
-
-TODO: Write usage instructions here
-