appsignal 3.0.3-java → 3.0.7-java

data/gemfiles/resque-2.gemfile

@@ -4,7 +4,3 @@ gem 'resque', "~> 2.0"
 gem 'sinatra'
 
 gemspec :path => '../'
-
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1.0")
-  gem 'nokogiri', '~> 1.6.0'
-end

data/gemfiles/sequel-435.gemfile

@@ -6,6 +6,5 @@ if RUBY_PLATFORM == "java"
 else
   gem 'sqlite3'
 end
-gem 'rack', '~> 1.6'
 
 gemspec :path => '../'

data/gemfiles/sequel.gemfile

@@ -6,6 +6,5 @@ if RUBY_PLATFORM == "java"
 else
   gem 'sqlite3'
 end
-gem 'rack', '~> 1.6'
 
 gemspec :path => '../'

data/gemfiles/sinatra.gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
 gem 'sinatra'
-gem 'rack', '~> 1.6'
 
 gemspec :path => '../'

data/lib/appsignal/config.rb

@@ -290,6 +290,7 @@ module Appsignal
       ENV["_APPSIGNAL_FILES_WORLD_ACCESSIBLE"]       = config_hash[:files_world_accessible].to_s
       ENV["_APPSIGNAL_TRANSACTION_DEBUG_MODE"]       = config_hash[:transaction_debug_mode].to_s
       ENV["_APPSIGNAL_SEND_ENVIRONMENT_METADATA"]    = config_hash[:send_environment_metadata].to_s
+      ENV["_APPSIGNAL_ENABLE_STATSD"]                = "true"
       ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
     end
 

data/lib/appsignal/hooks.rb

@@ -32,7 +32,7 @@ module Appsignal
         return unless dependencies_present?
         return if installed?
 
-        Appsignal.logger.info("Installing #{name} hook")
+        Appsignal.logger.debug("Installing #{name} hook")
         begin
           install
           @installed = true
@@ -108,3 +108,4 @@ require "appsignal/hooks/mongo_ruby_driver"
 require "appsignal/hooks/webmachine"
 require "appsignal/hooks/data_mapper"
 require "appsignal/hooks/que"
+require "appsignal/hooks/excon"

data/lib/appsignal/hooks/excon.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class ExconHook < Appsignal::Hooks::Hook
+      register :excon
+
+      def dependencies_present?
+        Appsignal.config && defined?(::Excon)
+      end
+
+      def install
+        require "appsignal/integrations/excon"
+        ::Excon.defaults[:instrumentor] = Appsignal::Integrations::ExconIntegration
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/puma.rb

@@ -11,23 +11,8 @@ module Appsignal
       end
 
       def install
-        if ::Puma.respond_to?(:stats) && !defined?(APPSIGNAL_PUMA_PLUGIN_LOADED)
-          # Only install the minutely probe if a user isn't using our Puma
-          # plugin, which lives in `lib/puma/appsignal.rb`. This plugin defines
-          # the {APPSIGNAL_PUMA_PLUGIN_LOADED} constant.
-          #
-          # We prefer people use the AppSignal Puma plugin. This fallback is
-          # only there when users relied on our *magic* integration.
-          #
-          # Using the Puma plugin, the minutely probe thread will still run in
-          # Puma workers, for other non-Puma probes, but the Puma probe only
-          # runs in the Puma main process.
-          # For more information:
-          # https://docs.appsignal.com/ruby/integrations/puma.html
-          Appsignal::Minutely.probes.register :puma, ::Appsignal::Probes::PumaProbe
-        end
-
         return unless defined?(::Puma::Cluster)
+
         # For clustered mode with multiple workers
         ::Puma::Cluster.send(:prepend, Module.new do
           def stop_workers

data/lib/appsignal/integrations/excon.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    module ExconIntegration
+      def self.instrument(name, data, &block)
+        namespace, *event = name.split(".")
+        rails_name = [event, namespace].flatten.join(".")
+
+        title =
+          if rails_name == "response.excon"
+            data[:host]
+          else
+            "#{data[:method].to_s.upcase} #{data[:scheme]}://#{data[:host]}"
+          end
+        Appsignal.instrument(rails_name, title, &block)
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/padrino.rb

@@ -7,7 +7,7 @@ module Appsignal
     # @api private
     module PadrinoPlugin
       def self.init
-        Appsignal.logger.info("Loading Padrino (#{Padrino::VERSION}) integration")
+        Appsignal.logger.debug("Loading Padrino (#{Padrino::VERSION}) integration")
 
         root = Padrino.mounted_root
         Appsignal.config = Appsignal::Config.new(root, Padrino.env)

data/lib/appsignal/integrations/railtie.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Appsignal.logger.info("Loading Rails (#{Rails.version}) integration")
+Appsignal.logger.debug("Loading Rails (#{Rails.version}) integration")
 
 require "appsignal/utils/rails_helper"
 require "appsignal/rack/rails_instrumentation"

data/lib/appsignal/integrations/redis.rb

@@ -3,12 +3,15 @@
 module Appsignal
   module Integrations
     module RedisIntegration
-      def process(commands, &block)
-        sanitized_commands = commands.map do |command, *args|
-          "#{command}#{" ?" * args.size}"
-        end.join("\n")
+      def write(command)
+        sanitized_command =
+          if command[0] == :eval
+            "#{command[1]}#{" ?" * (command.size - 3)}"
+          else
+            "#{command[0]}#{" ?" * (command.size - 1)}"
+          end
 
-        Appsignal.instrument "query.redis", id, sanitized_commands do
+        Appsignal.instrument "query.redis", id, sanitized_command do
           super
         end
       end

data/lib/appsignal/integrations/sinatra.rb

@@ -3,7 +3,7 @@
 require "appsignal"
 require "appsignal/rack/sinatra_instrumentation"
 
-Appsignal.logger.info("Loading Sinatra (#{Sinatra::VERSION}) integration")
+Appsignal.logger.debug("Loading Sinatra (#{Sinatra::VERSION}) integration")
 
 app_settings = ::Sinatra::Application.settings
 Appsignal.config = Appsignal::Config.new(

data/lib/appsignal/probes.rb

@@ -3,5 +3,4 @@ module Appsignal
   end
 end
 
-require "appsignal/probes/puma"
 require "appsignal/probes/sidekiq"

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.3".freeze
+  VERSION = "3.0.7".freeze
 end

data/lib/puma/plugin/appsignal.rb

@@ -1,27 +1,156 @@
-APPSIGNAL_PUMA_PLUGIN_LOADED = true
+# frozen_string_literal: true
+
+require "json"
 
 # AppSignal Puma plugin
 #
-# This plugin ensures the minutely probe thread is started with the Puma
-# minutely probe in the Puma master process.
-#
-# The constant {APPSIGNAL_PUMA_PLUGIN_LOADED} is here to mark the Plugin as
-# loaded by the rest of the AppSignal gem. This ensures that the Puma minutely
-# probe is not also started in every Puma workers, which was the old behavior.
-# See {Appsignal::Hooks::PumaHook#install} for more information.
+# This plugin ensures Puma metrics are sent to the AppSignal agent using StatsD.
 #
 # For even more information:
 # https://docs.appsignal.com/ruby/integrations/puma.html
-Puma::Plugin.create do
-  def start(launcher = nil)
-    launcher.events.on_booted do
-      require "appsignal"
-      if ::Puma.respond_to?(:stats)
-        require "appsignal/probes/puma"
-        Appsignal::Minutely.probes.register :puma, Appsignal::Probes::PumaProbe
+Puma::Plugin.create do # rubocop:disable Metrics/BlockLength
+  def start(launcher)
+    @launcher = launcher
+    @launcher.events.debug "AppSignal: Puma plugin start."
+    in_background do
+      @launcher.events.debug "AppSignal: Start Puma stats collection loop."
+      plugin = AppsignalPumaPlugin.new
+
+      loop do
+        begin
+          # Implement similar behavior to minutely probes.
+          # Initial sleep to wait until the app is fully initalized.
+          # Then loop every 60 seconds and collect the Puma stats as AppSignal
+          # metrics.
+          sleep sleep_time
+
+          @launcher.events.debug "AppSignal: Collecting Puma stats."
+          stats = fetch_puma_stats
+          if stats
+            plugin.call(stats)
+          else
+            @launcher.events.log "AppSignal: No Puma stats to report."
+          end
+        rescue StandardError => error
+          log_error "Error while processing metrics.", error
+        end
       end
-      Appsignal.start
-      Appsignal.start_logger
+    end
+  end
+
+  private
+
+  def sleep_time
+    60 # seconds
+  end
+
+  def log_error(message, error)
+    @launcher.events.log "AppSignal: #{message}\n" \
+      "#{error.class}: #{error.message}\n#{error.backtrace.join("\n")}"
+  end
+
+  def fetch_puma_stats
+    if Puma.respond_to? :stats_hash # Puma >= 5.0.0
+      Puma.stats_hash
+    elsif Puma.respond_to? :stats # Puma < 5.0.0
+      # Puma.stats_hash returns symbolized keys as well
+      JSON.parse Puma.stats, :symbolize_names => true
+    end
+  rescue StandardError => error
+    log_error "Error while parsing Puma stats.", error
+    nil
+  end
+end
+
+# AppsignalPumaPlugin
+#
+# Class to handle the logic of translating the Puma stats to AppSignal metrics.
+#
+# @api private
+class AppsignalPumaPlugin
+  def initialize
+    @hostname = fetch_hostname
+    @statsd = Statsd.new
+  end
+
+  def call(stats)
+    counts = {}
+    count_keys = [:backlog, :running, :pool_capacity, :max_threads]
+
+    if stats[:worker_status] # Clustered mode - Multiple workers
+      stats[:worker_status].each do |worker|
+        stat = worker[:last_status]
+        count_keys.each do |key|
+          count_if_present counts, key, stat
+        end
+      end
+
+      gauge(:workers, stats[:workers], :type => :count)
+      gauge(:workers, stats[:booted_workers], :type => :booted)
+      gauge(:workers, stats[:old_workers], :type => :old)
+    else # Single mode - Single worker
+      count_keys.each do |key|
+        count_if_present counts, key, stats
+      end
+    end
+
+    gauge(:connection_backlog, counts[:backlog]) if counts[:backlog]
+    gauge(:pool_capacity, counts[:pool_capacity]) if counts[:pool_capacity]
+    gauge(:threads, counts[:running], :type => :running) if counts[:running]
+    gauge(:threads, counts[:max_threads], :type => :max) if counts[:max_threads]
+  end
+
+  private
+
+  attr_reader :hostname
+
+  def fetch_hostname
+    # Configure hostname as reported for the Puma metrics with the
+    # APPSIGNAL_HOSTNAME environment variable.
+    env_hostname = ENV["APPSIGNAL_HOSTNAME"]
+    return env_hostname if env_hostname
+
+    # Auto detect hostname as fallback. May be inaccurate.
+    Socket.gethostname
+  end
+
+  def gauge(field, count, tags = {})
+    @statsd.gauge("puma_#{field}", count, tags.merge(:hostname => hostname))
+  end
+
+  def count_if_present(counts, key, stats)
+    stat_value = stats[key]
+    return unless stat_value
+
+    counts[key] ||= 0
+    counts[key] += stat_value
+  end
+
+  class Statsd
+    def initialize
+      # StatsD server location as configured in AppSignal agent StatsD server.
+      @host = "127.0.0.1"
+      @port = 8125
+    end
+
+    def gauge(metric_name, value, tags)
+      send_metric "g", metric_name, value, tags
+    end
+
+    private
+
+    attr_reader :host, :port
+
+    def send_metric(type, metric_name, metric_value, tags_hash)
+      tags = tags_hash.map { |key, value| "#{key}:#{value}" }.join(",")
+      data = "#{metric_name}:#{metric_value}|#{type}|##{tags}"
+
+      # Open (and close) a new socket every time because we don't know when the
+      # plugin will exit and when to cleanly close the socket connection.
+      socket = UDPSocket.new
+      socket.send(data, 0, host, port)
+    ensure
+      socket && socket.close
     end
   end
 end

data/mono.yml

@@ -0,0 +1,16 @@
+---
+language: ruby
+repo: "https://github.com/appsignal/appsignal-ruby"
+bootstrap:
+  post:
+    - "rake extension:install"
+clean:
+  post:
+    - "bundle exec rake extension:clean"
+    - "rm -rf pkg"
+build:
+  command: "bundle exec rake build:all"
+publish:
+  gem_files_dir: pkg/
+test:
+  command: "bundle exec rake test"

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -115,6 +115,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
     it "logs to the log file" do
       run
       log_contents = File.read(config.log_file_path)
+      p log_contents
       expect(log_contents).to contains_log :info, "Starting AppSignal diagnose"
     end
 

data/spec/lib/appsignal/hooks/excon_spec.rb

@@ -0,0 +1,74 @@
+describe Appsignal::Hooks::ExconHook do
+  before :context do
+    start_agent
+  end
+
+  context "with Excon" do
+    before(:context) do
+      class Excon
+        def self.defaults
+          @defaults ||= {}
+        end
+      end
+      Appsignal::Hooks::ExconHook.new.install
+    end
+    after(:context) { Object.send(:remove_const, :Excon) }
+
+    describe "#dependencies_present?" do
+      subject { described_class.new.dependencies_present? }
+
+      it { is_expected.to be_truthy }
+    end
+
+    describe "#install" do
+      it "adds the AppSignal instrumentor to Excon" do
+        expect(Excon.defaults[:instrumentor]).to eql(Appsignal::Integrations::ExconIntegration)
+      end
+    end
+
+    describe "instrumentation" do
+      let!(:transaction) do
+        Appsignal::Transaction.create("uuid", Appsignal::Transaction::HTTP_REQUEST, "test")
+      end
+      around { |example| keep_transactions { example.run } }
+
+      it "instruments a http request" do
+        data = {
+          :host => "www.google.com",
+          :method => :get,
+          :scheme => "http"
+        }
+        Excon.defaults[:instrumentor].instrument("excon.request", data) {}
+
+        expect(transaction.to_h["events"]).to include(
+          hash_including(
+            "name" => "request.excon",
+            "title" => "GET http://www.google.com",
+            "body" => ""
+          )
+        )
+      end
+
+      it "instruments a http response" do
+        data = { :host => "www.google.com" }
+        Excon.defaults[:instrumentor].instrument("excon.response", data) {}
+
+        expect(transaction.to_h["events"]).to include(
+          hash_including(
+            "name" => "response.excon",
+            "title" => "www.google.com",
+            "body" => ""
+          )
+        )
+      end
+    end
+  end
+
+  context "without Excon" do
+    describe "#dependencies_present?" do
+      subject { described_class.new.dependencies_present? }
+
+      it { is_expected.to be_falsy }
+    end
+  end
+end