raygun-apm 1.0.40-universal-darwin → 1.0.45-universal-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d0f60ae2d5e19cbcc9ade6e743caf0a697725b1863e8ccff35f0510841d2bfe
-  data.tar.gz: a289c699b639180b7b597404144d720a78a13be1f39c28e41f9b265da6db56e7
+  metadata.gz: a69112df114da8dc5aa184958c9f3a2b08ba68861767f9780cfa5d3578bd2111
+  data.tar.gz: e6a11dd13505a1c797e6607c79ed612b632f519833106f250dee3150088efb88
 SHA512:
-  metadata.gz: 292af9c6ca3a1a45f0da7db6af846a280e7bcc2e6a455ab1c7ea578a9369aae2c661c2d9b33dd5cf8d5f09ec61f66e2d6750ff471b94c37ab685fb4b3e731281
-  data.tar.gz: 38480c14171c9022d8f31d077b1216264b0465637aefc2a83d0c24b86ee1134d0c958cf7b1de8623c0ec0be40bde50c2313ad19081e675f7f9e92fa5b4ddfaa7
+  metadata.gz: cf298c37c2d45e2cc65b164fac061c1c3f50938597c1b0ab9213196a2080c3156abc9bb77b8bfdfe931dee6ed176c5420612584495cb6e5e8c51781771fe603e
+  data.tar.gz: dc35642632fba924346b492a9224b5f02022da19a9252ca2f53428ed0ea6fb5e17188d90b32a3cd59b8f7e1d4d075b0282dc3d6c7553dbbf1fb67208276f4972

data/bin/diagnostics

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "raygun/apm"
+
+check = Raygun::Apm::Diagnostics.new
+check.verify_agent

data/ext/raygun/extconf.rb

@@ -27,6 +27,7 @@ if ENV['DEBUG']
   append_cflags '-fstack-protector-all'
   append_cflags '-DRB_RG_DEBUG'
 else
+  #append_cflags '-DRAX_DEBUG_MSG'
   append_cflags '-O3'
 end
 

data/lib/raygun/apm.rb

@@ -6,6 +6,9 @@ rescue LoadError
   require "raygun/raygun_ext"
 end
 require "raygun/apm/config"
+require "raygun/apm/diagnostics"
+require "raygun/apm/blacklist/parser"
+require "raygun/apm/blacklist/translator"
 require "raygun/apm/tracer"
 require "raygun/apm/event"
 require "raygun/apm/hooks/net_http"

data/lib/raygun/apm/blacklist.rb

@@ -1,7 +1,8 @@
 module Raygun
   module Apm
-    class Blacklist
+    module Blacklist
       PROFILER = %w{
+        Raygun
         Raygun::Apm::
       }
 
@@ -78,7 +79,7 @@ module Raygun
         MatchData
         Math
         Math::DomainError
-        Method
+        Method#
         Module
         Mutex
         NameError
@@ -160,75 +161,277 @@ module Raygun
         Delegator
         PrettyPrint
         PP
+        Minitest
       }
 
       HTTP_OUT = %w{
-        # Faraday
+        #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
+        +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
+        +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
+        +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
+        +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
+        +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
-        #stdlib net-http
-        +Net::HTTP::get_response
-        +Net::HTTP::post
-        +Net::HTTP::post_form
+        +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{
-        +Raygun::Apm::Hooks::Redis::process
+        #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)
@@ -240,7 +443,7 @@ module Raygun
       end
 
       def self.resolve_entries
-        DEFAULT_RUBY + PROFILER + HTTP_OUT + QUERIES + self.extended_blacklist.flatten
+        DEFAULT_RUBY + PROFILER + HTTP_OUT + QUERIES + RAYGUN4RUBY + self.extended_blacklist.flatten
       end
     end
   end

data/lib/raygun/apm/blacklist/parser.rb

@@ -0,0 +1,47 @@
+module Raygun
+  module Apm
+    module Blacklist
+      class Parser
+        COMMENT = /^#[^<].*/
+        ANONYMOUS = /^#<.*:.*>?/
+
+        def initialize(tracer)
+          @tracer = tracer
+          @translator = Blacklist::Translator.new
+        end
+
+        def add_filters(filters)
+          filters.each do |filter|
+            filter.strip!
+            add_filter(filter)
+          end
+          show_filters
+        end
+
+        private
+        def add_filter(filter)
+          if filter =~ COMMENT && filter !~ ANONYMOUS
+            return 
+          end
+          if filter.start_with?('+')
+            @tracer.add_whitelist *translate(filter[1..-1])
+          elsif filter.start_with?('-')
+            @tracer.add_blacklist *translate(filter[1..-1])
+          elsif filter.size > 0
+            @tracer.add_blacklist *translate(filter)
+          end
+        rescue => e
+          puts "Failed to add line '#{filter}' to the blacklist (#{e}) #{e.backtrace.join("\n")}"
+        end
+
+        def show_filters
+          @tracer.show_filters# if @tracer.config.loglevel == Tracer::LOG_BLACKLIST
+        end
+
+        def translate(filter)
+          @translator.translate(filter)
+        end
+      end
+    end
+  end
+end

data/lib/raygun/apm/blacklist/translator.rb

@@ -0,0 +1,73 @@
+module Raygun
+  module Apm
+    module Blacklist
+      class Translator
+        class RubyTranslator
+          # Foo::Bar#baz
+          # Foo::Bar.baz
+          COMMENT = /^#.*/
+          ANONYMOUS = /^#<.*>?/
+          NAMESPACE = /::/
+          NAMESPACE_ONLY = /::$/
+          METHOD = /#|\./
+          LETTER_CASE = /^[A-Z]/
+
+          def translate(filter)
+            path, method = nil, nil
+            if filter !~ COMMENT && filter !~ ANONYMOUS
+              if filter.end_with?("#")
+                path = filter
+              else
+                path, method = filter.split(METHOD)
+              end
+              # .NET fallback
+              return if method =~ LETTER_CASE && !method.start_with?("Ruby")
+              if path == path.downcase
+                method = path
+                path = nil
+              end
+
+              # .NET fallback
+              return if method =~ NAMESPACE
+              [path, method]
+            elsif filter =~ ANONYMOUS
+              _, klass, method = filter.split(METHOD)
+              ["##{klass}", method]
+            else
+              nil
+            end
+          end
+        end
+
+        # References https://raygun.com/documentation/product-guides/apm/blacklist/
+        class DotnetTranslator
+          # Foo.Bar::Baz
+          COMMENT = /^#/
+          NAMESPACE = /\./
+          METHOD = /::/
+  
+          def translate(filter)
+            if filter !~ COMMENT
+              path, method = nil, nil
+              path, method = filter.split(METHOD)
+              path.gsub!(NAMESPACE, "::")
+              [path, method]
+            else
+              nil
+            end
+          end
+        end
+
+        def initialize
+          @ruby = RubyTranslator.new
+          @dotnet = DotnetTranslator.new
+        end
+
+        def translate(filter)
+          translated = @ruby.translate(filter)
+          translated ? translated : @dotnet.translate(filter)
+        end
+      end
+    end
+  end
+end

data/lib/raygun/apm/config.rb

@@ -49,9 +49,10 @@ module Raygun
       end
 
       # Initial constants for ProtonAgentTail.exe
-      UDP_SINK_HOST = '127.0.0.1'
+      UDP_SINK_HOST = TCP_MANAGEMENT_HOST = '127.0.0.1'
       UDP_SINK_MULTICAST_HOST = '239.100.15.215'
       UDP_SINK_PORT = 2799
+      TCP_MANAGEMENT_PORT = 2790
 
       ## Enumerate all PROTON_ constants
       config_var 'PROTON_API_KEY', as: String, default: ''

data/lib/raygun/apm/diagnostics.rb

@@ -0,0 +1,34 @@
+require "socket"
+require "json"
+
+module Raygun
+  module Apm
+    class Diagnostics
+      AGENT_STATE_DOWN = "The 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_UP_MISCONFIGURED = "The 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 = "The Raygun APM Agent is configured properly!"
+
+      def initialize(host: Apm::Config::TCP_MANAGEMENT_HOST, port: Apm::Config::TCP_MANAGEMENT_PORT)
+        @host = host
+        @port = port
+      end
+
+      def verify_agent
+        socket.write "GetAgentInfo"
+        response = JSON.parse(socket.gets)
+        if response['Status'] == 1
+          puts AGENT_STATE_UP_CONFIGURED
+        elsif response['Status'] == 0
+          puts AGENT_STATE_UP_MISCONFIGURED
+        end
+      rescue Errno::ECONNREFUSED
+        puts AGENT_STATE_DOWN
+      end
+
+      private
+      def socket
+        @socket ||= s = TCPSocket.new(@host, @port)
+      end
+    end
+  end
+end

data/lib/raygun/apm/event.rb

@@ -6,7 +6,7 @@ module Raygun
       end
       class ThreadStarted < Event
         def inspect
-          super + " "
+          super + " parent_tid:#{self[:parent_tid]}"
         end
       end
       class Begin < Event

data/lib/raygun/apm/tracer.rb

@@ -18,42 +18,15 @@ module Raygun
       attr_accessor :config
 
       def initialize(env=ENV)
-        @config = Config.new(env)
-        @blacklist = if @config.proton_user_overrides_file && File.exists?(@config.proton_user_overrides_file)
-          File.readlines(@config.proton_user_overrides_file)
-        else
-          []
-        end
-        add_filters @blacklist
-        # Ignore comments set to false here to account for #<Class: etc. in Rails blacklist
-        add_filters Raygun::Apm::Blacklist.resolve_entries, ignore_comments: false
-        show_filters if config.loglevel == Tracer::LOG_BLACKLIST
-        # Special assignments from config to the Tracer
-        self.log_level = config.loglevel
-        self.environment = config.environment
-        self.api_key = config.proton_api_key
-        self.register_libraries Bundler.load.specs.map(&:full_gem_path).sort << RbConfig::CONFIG['rubylibdir']
+        configure(env)
+        initialize_blacklist
+        register_known_library_paths
+        run_agent_connectivity_diagnostics
         ObjectSpace.define_finalizer(self, proc{ disable_tracepoints })
       # Any fails here is kamikaze for the tracer
       rescue => e
         # XXX works for the middleware wrapped case, not for standalone - revisit
-        raise Raygun::Apm::FatalError, "Raygun APM tracer could not be initialized: #{e.message}"
-      end
-
-      def add_filters(filters, ignore_comments: true)
-        filters.each do |filter|
-          filter.strip!
-          # comment
-          if filter.start_with?('#')
-            add_blacklist filter unless ignore_comments
-          elsif filter.start_with?('+')
-            add_whitelist filter[1..-1]
-          elsif filter.start_with?('-')
-            add_blacklist filter[1..-1]
-          elsif filter.size > 0
-            add_blacklist filter
-          end
-        end
+        raise Raygun::Apm::FatalError, "Raygun APM tracer could not be initialized: #{e.message} #{e.backtrace.join("\n")}"
       end
 
       def udp_sink!
@@ -70,9 +43,39 @@ module Raygun
       # Any fails here is kamikaze for the tracer
       rescue => e
         # XXX works for the middleware wrapped case, not for standalone - revisit
-        raise Raygun::Apm::FatalError, "Raygun APM UDP sink could not be initialized: #{e.message}"
+        raise Raygun::Apm::FatalError, "Raygun APM UDP sink could not be initialized: #{e.message} #{e.backtrace.join("\n")}"
+      end
+
+      private
+      def configure(env)
+        @config = Config.new(env)
+        # Special assignments from config to the Tracer
+        self.log_level = config.loglevel
+        self.environment = config.environment
+        self.api_key = config.proton_api_key
+      end
+
+      def initialize_blacklist
+        @blacklist_parser = Raygun::Apm::Blacklist::Parser.new(self)
+        @blacklist = if @config.proton_user_overrides_file && File.exists?(@config.proton_user_overrides_file)
+          File.readlines(@config.proton_user_overrides_file)
+        else
+          []
+        end
+        # From file
+        @blacklist_parser.add_filters @blacklist
+        # Defaults
+        @blacklist_parser.add_filters Raygun::Apm::Blacklist.resolve_entries
       end
 
+      def register_known_library_paths
+        self.register_libraries Bundler.load.specs.map(&:full_gem_path).sort << RbConfig::CONFIG['rubylibdir']
+      end
+
+      def run_agent_connectivity_diagnostics
+        check = Raygun::Apm::Diagnostics.new
+        check.verify_agent
+      end
     end
   end
 end

data/lib/raygun/apm/version.rb

@@ -1,5 +1,5 @@
 module Raygun
   module Apm
-    VERSION = "1.0.40"
+    VERSION = "1.0.45"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun-apm
 version: !ruby/object:Gem::Version
-  version: 1.0.40
+  version: 1.0.45
 platform: universal-darwin
 authors:
 - Raygun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase-ruby_core_source
@@ -203,6 +203,7 @@ extra_rdoc_files: []
 files:
 - README.rdoc
 - bin/console
+- bin/diagnostics
 - bin/setup
 - ext/raygun/extconf.rb
 - lib/raygun/2.5/raygun_ext.bundle
@@ -210,7 +211,10 @@ files:
 - lib/raygun/2.7/raygun_ext.bundle
 - lib/raygun/apm.rb
 - lib/raygun/apm/blacklist.rb
+- lib/raygun/apm/blacklist/parser.rb
+- lib/raygun/apm/blacklist/translator.rb
 - lib/raygun/apm/config.rb
+- lib/raygun/apm/diagnostics.rb
 - lib/raygun/apm/event.rb
 - lib/raygun/apm/hooks/net_http.rb
 - lib/raygun/apm/hooks/redis.rb