raygun-apm 1.1.15.pre3

data/lib/raygun/apm/blacklist.rb

@@ -0,0 +1,476 @@
+module Raygun
+  module Apm
+    module Blacklist
+      PROFILER = %w{
+        Raygun
+        Raygun::Apm::
+      }
+
+      # From https://ruby-doc.org/core-2.6.3/ , to automate
+      DEFAULT_RUBY = %w{
+        #<refinement:
+        #<Module:
+        #<Class:
+        #<#<Class:
+        ARGF#
+        ArgumentError#
+        Array#
+        Base64#
+        BasicObject#
+        Binding#
+        Class#
+        ClosedQueueError#
+        Comparable#
+        Complex#
+        ConditionVariable#
+        Continuation#
+        Data#
+        Dir#
+        Dir::
+        ENV#
+        EOFError#
+        Encoding#
+        Encoding::
+        EncodingError#
+        Enumerable#
+        Enumerator#
+        Enumerator::
+        Errno#
+        Exception#
+        FalseClass#
+        Fiber#
+        FiberError#
+        File#
+        File::
+        FileTest#
+        Float#
+        FloatDomainError#
+        FrozenError#
+        GC#
+        GC::Profiler#
+        Hash#
+        IO#
+        IO::
+        IOError#
+        IndexError#
+        Integer#
+        Interrupt#
+        JSON#
+        Kernel#
+        KeyError#
+        LoadError#
+        LocalJumpError#
+        Marshal#
+        MatchData#
+        Math#
+        Math::
+        Method#
+        Module#
+        Mutex#
+        +Thread::Mutex#synchronize
+        +Thread::Mutex#lock
+        +Thread::Mutex#unlock
+        +Thread::Mutex#sleep
+        NameError#
+        NilClass#
+        NoMemoryError#
+        NoMethodError#
+        NotImplementedError#
+        Numeric#
+        Object#
+        ObjectSpace#
+        ObjectSpace::
+        Proc#
+        Process#
+        Process::
+        Psych#
+        Queue#
+        Random#
+        Random::
+        Range#
+        RangeError#
+        Rational#
+        Regexp#
+        RegexpError#
+        RubyVM#
+        RubyVM::
+        RuntimeError#
+        ScriptError#
+        SecurityError#
+        Set#
+        SimpleDelegator#
+        Singleton#
+        Singleton::
+        Signal#
+        SignalException#
+        SizedQueue#
+        Socket#
+        StandardError#
+        StopIteration#
+        String#
+        Struct#
+        Symbol#
+        SyntaxError#
+        SystemCallError#
+        SystemExit#
+        SystemStackError#
+        Thread#
+        Thread::
+        ThreadError#
+        ThreadGroup#
+        Timeout
+        Time#
+        TracePoint#
+        TrueClass#
+        TypeError#
+        UnboundMethod#
+        UncaughtThrowError#
+        UnicodeNormalize#
+        Warning#
+        ZeroDivisionError#
+        IPAddr#
+        Net::
+        OpenSSL#
+        OpenSSL::
+        BasicSocket#
+        Forwardable#
+        Gem#
+        FFI#
+        Addrinfo#
+        Open3#
+        Shellwords#
+        WeakRef#
+        RbConfig#
+        Singleton#
+        OpenStruct#
+        Bundler#
+        Delegator#
+        PrettyPrint#
+        PP#
+        PP::
+        PP#sharing_detection
+        PrettyPrint#
+        PrettyPrint::
+        Minitest
+        Psych
+        Mutex_m#
+        ERB#
+        ERB::
+        Gem#
+        Gem::
+        FileUtils#
+        FileUtils::
+        Tempfile#
+        Tempfile::
+        Logger#
+        Logger::
+        Ractor#
+        Ractor::
+      }
+
+      INTERNALS = %w{
+        +Object#sleep
+        +Object#exec
+        +Object#fork
+        +Object#system
+        +Object#spawn
+        +Continuation#callcc
+        +IO#syscall
+        +IO#open
+        +IO#puts
+        +IO#gets
+        +IO#readline
+        +IO#readlines
+        +Random#srand
+        +Random#rand
+        +Signal#trap
+      }
+
+      HTTP_OUT = %w{
+        #Faraday
+        URI
+        MonitorMixin
+        Faraday
+        +Faraday::Connection#get
+        +Faraday::Connection#head
+        +Faraday::Connection#delete
+        +Faraday::Connection#trace
+        +Faraday::Connection#post
+        +Faraday::Connection#put
+        +Faraday::Connection#patch
+        #multipart-post
+        Multipartable
+        SecureRandom
+        Parts
+        CompositeReadIO
+        +Multipartable#initialize
+        #rest-client
+        RestClient
+        Netrc
+        HTTP::CookieJar
+        DomainName
+        HTTP::Accept
+        +RestClient.get
+        +RestClient.head
+        +RestClient.delete
+        +RestClient.trace
+        +RestClient.post
+        +RestClient.put
+        +RestClient.patch
+        #excon
+        Excon
+        +Excon.get
+        +Excon.head
+        +Excon.delete
+        +Excon.trace
+        +Excon.post
+        +Excon.put
+        +Excon.patch
+        #HTTParty
+        HTTParty
+        +HTTParty.get
+        +HTTParty.head
+        +HTTParty.delete
+        +HTTParty.trace
+        +HTTParty.post
+        +HTTParty.put
+        +HTTParty.patch
+        #httpclient
+        HTTPClient
+        HTTP::Message
+        +HTTPClient#get
+        +HTTPClient#head
+        +HTTPClient#delete
+        +HTTPClient#trace
+        +HTTPClient#post
+        +HTTPClient#put
+        +HTTPClient#patch
+        #net-http
+        +Net::HTTP.get_response
+        +Net::HTTP.get
+        +Net::HTTP.head
+        +Net::HTTP.delete
+        +Net::HTTP.trace
+        +Net::HTTP.post
+        +Net::HTTP.put
+        +Net::HTTP.patch
+        +Net::HTTP.post_form
+      }
+
+      QUERIES = %w{
+        #mongodb
+        Mongo
+        BSON
+        +Mongo::Operation::Executable#do_execute
+        #redis
+        Redis
+        +Redis#auth
+        +Redis#select
+        +Redis#ping
+        +Redis#echo
+        +Redis#bgrewriteaof
+        +Redis#bgsave
+        +Redis#config
+        +Redis#dbsize
+        +Redis#debug
+        +Redis#flushall
+        +Redis#flushdb
+        +Redis#info
+        +Redis#lastsave
+        +Redis#monitor
+        +Redis#save
+        +Redis#shutdown
+        +Redis#slave
+        +Redis#slowlog
+        +Redis#sync
+        +Redis#time
+        +Redis#persist
+        +Redis#expire
+        +Redis#expireat
+        +Redis#ttl
+        +Redis#pexpire
+        +Redis#pexpireat
+        +Redis#pttl
+        +Redis#dump
+        +Redis#restore
+        +Redis#migrate
+        +Redis#del
+        +Redis#unlink
+        +Redis#exists
+        +Redis#keys
+        +Redis#move
+        +Redis#object
+        +Redis#randomkey
+        +Redis#rename
+        +Redis#renamenx
+        +Redis#sort
+        +Redis#type
+        +Redis#decr
+        +Redis#decrby
+        +Redis#incr
+        +Redis#incrby
+        +Redis#incrbyfloat
+        +Redis#set
+        +Redis#multi
+        +Redis#client
+        +Redis#set
+        +Redis#setex
+        +Redis#psetex
+        +Redis#setnx
+        +Redis#mset
+        +Redis#mapped_mset
+        +Redis#msetnx
+        +Redis#mapped_msetnx
+        +Redis#get
+        +Redis#mget
+        +Redis#mapped_mget
+        +Redis#setrange
+        +Redis#getrange
+        +Redis#setbit
+        +Redis#getbit
+        +Redis#append
+        +Redis#bitcount
+        +Redis#bitop
+        +Redis#bitpos
+        +Redis#getset
+        +Redis#strlen
+        +Redis#llen
+        +Redis#lpush
+        +Redis#lpushx
+        +Redis#rpush
+        +Redis#rpushx
+        +Redis#lpop
+        +Redis#rpop
+        +Redis#rpoplpush
+        +Redis#blpop
+        +Redis#brpop
+        +Redis#brpoplpush
+        +Redis#lindex
+        +Redis#linsert
+        +Redis#lrange
+        +Redis#lrem
+        +Redis#lset
+        +Redis#ltrim
+        +Redis#scard
+        +Redis#sadd
+        +Redis#srem
+        +Redis#spop
+        +Redis#srandmember
+        +Redis#smove
+        +Redis#sismember
+        +Redis#smembers
+        +Redis#sdiff
+        +Redis#sdiffstore
+        +Redis#sinter
+        +Redis#sinterstore
+        +Redis#sunion
+        +Redis#sunionstore
+        +Redis#zcard
+        +Redis#zadd
+        +Redis#zincrby
+        +Redis#zrem
+        +Redis#zpopmax
+        +Redis#zpopmin
+        +Redis#bzpopmax
+        +Redis#bzpopmin
+        +Redis#zscore
+        +Redis#zrange
+        +Redis#zrevrange
+        +Redis#zrank
+        +Redis#zrevrank
+        +Redis#zremrangebyrank
+        +Redis#zlexcount
+        +Redis#zrangebylex
+        +Redis#zrevrangebylex
+        +Redis#zrangebyscore
+        +Redis#zrevrangebyscore
+        +Redis#zremrangebyscore
+        +Redis#zcount
+        +Redis#zinterstore
+        +Redis#zunionstore
+        +Redis#hlen
+        +Redis#hset
+        +Redis#hsetnx
+        +Redis#hmset
+        +Redis#mapped_hmset
+        +Redis#hget
+        +Redis#hmget
+        +Redis#mapped_hmget
+        +Redis#hdel
+        +Redis#hexists
+        +Redis#hincrby
+        +Redis#hincrbyfloat
+        +Redis#hkeys
+        +Redis#hvals
+        +Redis#hgetall
+        +Redis#publish
+        +Redis#subscribe
+        +Redis#subscribe_with_timeout
+        +Redis#unsubscribe
+        +Redis#psubscribe
+        +Redis#psubscribe_with_timeout
+        +Redis#punsubscribe
+        +Redis#pubsub
+        +Redis#watch
+        +Redis#unwatch
+        +Redis#pipelined
+        +Redis#multi
+        +Redis#exec
+        +Redis#discard
+        +Redis#script
+        +Redis#eval
+        +Redis#evalsha
+        +Redis#scan
+        +Redis#hscan
+        +Redis#zscan
+        +Redis#sscan
+        +Redis#pfadd
+        +Redis#pfcount
+        +Redis#pfmerge
+        +Redis#geoadd
+        +Redis#geohash
+        +Redis#georadiusbymember
+        +Redis#geopos
+        +Redis#geodist
+        +Redis#xinfo
+        +Redis#xadd
+        +Redis#xtrim
+        +Redis#xdel
+        +Redis#xrange
+        +Redis#xrevrange
+        +Redis#xlen
+        +Redis#xread
+        +Redis#xgroup
+        +Redis#xreadgroup
+        +Redis#xack
+        +Redis#xclaim
+        +Redis#xpending
+        +Redis#sentinel
+        +Redis#cluster
+        +Redis#asking
+      }
+
+      RAYGUN4RUBY = %w{
+        Raygun::Breadcrumbs
+        Raygun::Configuration
+        Raygun.config
+        Raygun.log
+        Raygun.should_report?
+        Raygun::Client
+        +Raygun.track_exception
+      }
+
+      def self.extend_with(list)
+        self.extended_blacklist << list
+      end
+
+      def self.extended_blacklist
+        @@extended_blacklist ||= []
+      end
+
+      def self.resolve_entries
+        DEFAULT_RUBY + PROFILER + INTERNALS + HTTP_OUT + QUERIES + RAYGUN4RUBY + self.extended_blacklist.flatten
+      end
+    end
+  end
+end

data/lib/raygun/apm/config.rb

@@ -0,0 +1,104 @@
+module Raygun
+  module Apm
+    class Config
+      LOGLEVELS = {
+        "None" => Tracer::LOG_NONE,
+        "Info" => Tracer::LOG_INFO,
+        "Warning" => Tracer::LOG_WARNING,
+        "Error" => Tracer::LOG_ERROR,
+        "Verbose" => Tracer::LOG_VERBOSE,
+        "Debug" => Tracer::LOG_DEBUG,
+        "Everything" => Tracer::LOG_EVERYTHING,
+        # ruby profiler specific
+        "Blacklist" => Tracer::LOG_BLACKLIST
+      }
+
+      ENVIRONMENTS = {
+        "development" => Tracer::ENV_DEVELOPMENT,
+        "production" => Tracer::ENV_PRODUCTION
+      }
+
+      DEFAULT_BLACKLIST_PATH_UNIX = "/usr/share/Raygun/Blacklist"
+      DEFAULT_BLACKLIST_PATH_WINDOWS = "C:\\ProgramData\\Raygun\\Blacklist"
+
+      attr_accessor :env
+      def initialize(env=ENV)
+        @env = env
+      end
+
+      def self.cast_to_boolean(x)
+        case x
+        when true, 'true', 'True', 1, '1' then true
+        else
+          false
+        end
+      end
+
+      def self.config_var(attr, opts={}, &blk)
+        define_method attr.downcase do
+          val = if x = env[attr]
+            if opts[:as] == Integer
+              Integer(x)
+            elsif opts[:as] == String
+              x.to_s
+            elsif opts[:as] == :boolean
+              self.class.cast_to_boolean(x)
+            end
+          else
+            opts[:default]
+          end
+          blk ? blk.call(val) : val
+        end
+      end
+
+      # Initial constants for ProtonAgentTail.exe
+      UDP_SINK_HOST = TCP_SINK_HOST = TCP_MANAGEMENT_HOST = '127.0.0.1'
+      UDP_SINK_MULTICAST_HOST = '239.100.15.215'
+      UDP_SINK_PORT = TCP_SINK_PORT = 2799
+      TCP_MANAGEMENT_PORT = 2790
+
+      ## Enumerate all PROTON_ constants
+      config_var 'PROTON_API_KEY', as: String, default: ''
+      config_var 'PROTON_DEBUG_LOGLEVEL', as: String, default: 'None'
+      config_var 'PROTON_USER_OVERRIDES_FILE', as: String
+      config_var 'PROTON_NETWORK_MODE', as: String, default: 'Udp'
+      config_var 'PROTON_FILE_IPC_FOLDER', as: String
+      config_var 'PROTON_USE_MULTICAST', as: String, default: 'False'
+      config_var 'PROTON_BATCH_IDLE_COUNTER', as: Integer, default: 500
+      ## New - Ruby profiler
+      config_var 'PROTON_UDP_PORT', as: Integer, default: UDP_SINK_PORT
+      config_var 'PROTON_TCP_PORT', as: Integer, default: TCP_SINK_PORT
+      ## Conditional hooks
+      config_var 'PROTON_HOOK_REDIS', as: :boolean, default: 'True'
+      config_var 'PROTON_HOOK_INTERNALS', as: :boolean, default: 'True'
+
+      def proton_udp_host
+        if proton_use_multicast == 'True'
+          UDP_SINK_MULTICAST_HOST
+        else
+          env['PROTON_UDP_HOST'] ? env['PROTON_UDP_HOST'].to_s : UDP_SINK_HOST
+        end
+      end
+
+      def proton_tcp_host
+        env['PROTON_TCP_HOST'] ? env['PROTON_TCP_HOST'].to_s : TCP_SINK_HOST
+      end
+
+      def loglevel
+        LOGLEVELS[proton_debug_loglevel] || raise(ArgumentError, "invalid log level")
+      end
+
+      def environment
+        environment = env['RACK_ENV'] || env['RAILS_ENV'] || 'production'
+        ENVIRONMENTS[environment] || Tracer::ENV_PRODUCTION
+      end
+
+      # Prefer what is set by PROTON_USER_OVERRIDES_FILE env
+      def blacklist_file
+        return proton_user_overrides_file if proton_user_overrides_file
+        path = Gem.win_platform? ? DEFAULT_BLACKLIST_PATH_WINDOWS : DEFAULT_BLACKLIST_PATH_UNIX
+        "#{File.join(path, proton_api_key)}.txt"
+      end
+    end
+  end
+end

data/lib/raygun/apm/diagnostics.rb

@@ -0,0 +1,54 @@
+require "socket"
+require "json"
+
+module Raygun
+  module Apm
+    class Diagnostics
+      AGENT_STATE_DOWN = "\nThe Raygun APM Agent appears to not be running on the current host.\nIf not already installed, please consult https://raygun.com/documentation/product-guides/apm/agent/downloads/\nOtherwise refer to https://raygun.com/documentation/product-guides/apm/agent/installation/ for starting the Agent."
+      AGENT_STATE_UNKNOWN = "\nThe Raygun APM Agent is reachable, but Unable to determine the state of the Agent at the moment."
+      AGENT_STATE_UP_MISCONFIGURED = "\nThe Raygun APM Agent is running, but misconfigured.\nThe API Key needs to be set through the Raygun_ApiKey environment variable.\nThe API key can be found under 'Application Settings' in the Raygun UI"
+      AGENT_STATE_UP_CONFIGURED = "\nThe Raygun APM Agent is configured properly!"
+      AGENT_MINIMUM_VERSION_NOT_MET = "\nVersion #{Raygun::Apm::VERSION} of the Raygun APM Profiler requires a minimum Agent version #{Raygun::Apm::MINIMUM_AGENT_VERSION}\nPlease download the latest Agent from https://raygun.com/documentation/product-guides/apm/agent/downloads/"
+      PROFILER_NOOPED = "Profiler loaded in noop mode and will be disabled due to the minimum Agent version not met"
+
+      def initialize(host: Apm::Config::TCP_MANAGEMENT_HOST, port: Apm::Config::TCP_MANAGEMENT_PORT)
+        @host = host
+        @port = port
+      end
+
+      def verify_agent(tracer)
+        socket.write "GetAgentInfo"
+        response = JSON.parse(socket.gets)
+        if minimum_agent_version_not_met?(response['Version'])
+          puts AGENT_MINIMUM_VERSION_NOT_MET
+          tracer.noop!
+          puts PROFILER_NOOPED
+        else
+          if response['Status'] == 1
+            puts AGENT_STATE_UP_CONFIGURED
+          elsif response['Status'] == 0
+            puts AGENT_STATE_UP_MISCONFIGURED
+          end
+        end
+      rescue Errno::ECONNREFUSED
+        puts AGENT_STATE_DOWN
+      rescue
+        puts AGENT_STATE_UNKNOWN
+      end
+
+      private
+      def socket
+        @socket ||= s = TCPSocket.new(@host, @port)
+      end
+
+      def minimum_agent_version_not_met?(version)
+        # Legacy path
+        if String === version
+          version < Raygun::Apm::MINIMUM_AGENT_VERSION
+        else
+          "#{version['Major']}.#{version['Minor']}.#{version['Build']}.#{version['Revision']}" < Raygun::Apm::MINIMUM_AGENT_VERSION
+        end
+      end
+    end
+  end
+end

data/lib/raygun/apm/event.rb

@@ -0,0 +1,49 @@
+module Raygun
+  module Apm
+    class Event
+      def inspect
+        "#<#{self.class.name}:#{self.object_id}> length:#{self.length} pid:#{self[:pid]} tid:#{self[:tid]} timestamp:#{self[:timestamp]}"
+      end
+      class ExceptionThrown < Event
+        def inspect
+          super + " class:#{self[:class_name]}"
+        end
+      end
+      class ThreadStarted < Event
+        def inspect
+          super + " parent_tid:#{self[:parent_tid]}"
+        end
+      end
+      class Begin < Event
+        def inspect
+          super + " function_id:#{self[:function_id]} instance_id:#{self[:instance_id]}"
+        end
+      end
+      class End < Event
+        def inspect
+          super + " function_id:#{self[:function_id]}"
+        end
+      end
+      class Methodinfo < Event
+        def inspect
+          super + " function_id:#{self[:function_id]} class_name:#{self[:class_name]} method_name:#{self[:method_name]} method_source:#{self[:method_source]}"
+        end
+      end
+      class HttpOut < Event
+        def inspect
+          super + " url:#{self[:url]} verb:#{self[:verb]} status:#{self[:status]} duration:#{self[:duration]}"
+        end
+      end
+      class Sql < Event
+        def inspect
+          super + " provider:#{self[:provider]} host:#{self[:host]} query:#{self[:query]} database:#{self[:database]} duration:#{self[:duration]}"
+        end
+      end
+      class BeginTransaction < Event
+        def inspect
+          super + " api_key:#{self[:api_key]} technology_type:#{self[:technology_type]} process_type:#{self[:process_type]}"
+        end
+      end
+    end
+  end
+end

data/lib/raygun/apm/hooks/excon.rb

@@ -0,0 +1,36 @@
+require 'excon'
+
+module Raygun
+  module Apm
+    module Hooks
+      module Excon
+        def request(params={}, &block)
+          if tracer = Raygun::Apm::Tracer.instance
+            started = tracer.now
+            response = super
+            ended = tracer.now
+            event = raygun_apm_http_out_event
+            event[:pid] = Process.pid
+            event[:url] = "#{@data[:scheme]}://#{@data[:host]}/#{params[:path]}"
+            event[:verb] = params[:method].to_s.upcase
+            event[:status] = response.status
+            event[:duration] = ended - started
+            event[:timestamp] = started
+            event[:tid] = tracer.get_thread_id(Thread.current)
+            tracer.emit(event)
+            response
+          else
+            super
+          end
+        end
+
+        private
+        def raygun_apm_http_out_event
+          @_raygun_apm_http_out_event ||= Raygun::Apm::Event::HttpOut.new
+        end
+      end
+    end
+  end
+end
+
+Raygun::Apm::Tracer.patch(Excon::Connection, Raygun::Apm::Hooks::Excon)