raygun-apm 0.0.3-universal-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8a352ce53209c88436c6d4e7c35b0a16f41d3ed7993a23edb77ceb72fa5d89b
+  data.tar.gz: ebfc8980395ac3c514197bf13761928234e5cd6811db7f928b69dbf45fb324d1
+SHA512:
+  metadata.gz: 36b283e1e5cf0196df19d2e0a7d39673e37a7c240113657dadb5c82a3fda17ffb47e949e3cc831e8f672031e7585e50e1ec7dcc03037ae77c9e4708c59520a18
+  data.tar.gz: 0b0b8841464a45965a1fef66bc28f9b03a52aa32d1eba42d62c3b2405d0d75146e6faa4b7a62d0801bea9ff4867ec56c1b2c0ec4f4731e2af58faf7828c64f32

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in raygun-apm.gemspec
+gemspec
+
+gem 'irb'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    raygun-apm (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark_driver (0.14.17)
+    debase-ruby_core_source (0.10.6)
+    irb (1.0.0)
+    minitest (5.11.3)
+    rake (12.3.3)
+    rake-compiler (1.0.8)
+      rake
+    rake-compiler-dock (0.7.2)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  benchmark_driver (~> 0.14.17)
+  bundler (~> 1.16)
+  debase-ruby_core_source (~> 0.10.6)
+  irb
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rake-compiler (~> 1.0.8)
+  rake-compiler-dock (~> 0.7.2)
+  raygun-apm!
+
+BUNDLED WITH
+   1.17.2

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "raygun/apm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/raygun/extconf.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'mkmf'
+require 'debase/ruby_core_source'
+
+headers = proc do
+  have_header('ruby.h') &&
+  have_header('ruby/debug.h') &&
+  have_header("vm_core.h")
+end
+
+dir_config('raygun')
+append_cflags '-pedantic'
+append_cflags '-Wall'
+append_cflags '-Werror=switch'
+append_cflags '-std=c99'
+if ENV['DEBUG']
+  have_library 'ssp'
+  have_func '__stack_chk_guard'
+  have_func '__stack_chk_fail'
+  append_cflags '-ggdb3'
+  # Needed reduced -On levels for SSP to do its job.
+  # Used to be -O0 but switched to -Og since -O0 disables
+  # some optimizations that debug tools need.
+  # https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html
+  append_cflags '-Og'
+  append_cflags '-fstack-protector-all'
+else
+  append_cflags '-O3'
+end
+
+unless create_header
+  STDERR.print("extconf.h creation failed\n")
+  exit(1)
+end
+
+unless Debase::RubyCoreSource.create_makefile_with_core(headers, 'raygun_ext')
+  STDERR.print("Makefile creation failed\n")
+  STDERR.print("One or more ruby headers not found\n")
+  exit(1)
+end

data/lib/raygun/apm/blacklist.rb

@@ -0,0 +1,195 @@
+module Raygun
+  module Apm
+    class Blacklist
+      # From https://ruby-doc.org/core-2.6.3/ , to automate
+      DEFAULT_RUBY = %w{
+        ARGF
+        ArgumentError
+        Array
+        BasicObject
+        Binding
+        Class
+        ClosedQueueError
+        Comparable
+        Complex
+        ConditionVariable
+        Continuation
+        Data
+        Dir
+        ENV
+        EOFError
+        Encoding
+        Encoding::CompatibilityError
+        Encoding::Converter
+        Encoding::ConverterNotFoundError
+        Encoding::InvalidByteSequenceError
+        Encoding::UndefinedConversionError
+        EncodingError
+        Enumerable
+        Enumerator
+        Enumerator::ArithmeticSequence
+        Enumerator::Chain
+        Enumerator::Generator
+        Enumerator::Lazy
+        Enumerator::Yielder
+        Errno
+        Exception
+        FalseClass
+        Fiber
+        FiberError
+        File
+        File::Constants
+        File::Stat
+        FileTest
+        Float
+        FloatDomainError
+        FrozenError
+        GC
+        GC::Profiler
+        Hash
+        IO
+        IO::EAGAINWaitReadable
+        IO::EAGAINWaitWritable
+        IO::EINPROGRESSWaitReadable
+        IO::EINPROGRESSWaitWritable
+        IO::EWOULDBLOCKWaitReadable
+        IO::EWOULDBLOCKWaitWritable
+        IO::WaitReadable
+        IO::WaitWritable
+        IOError
+        IndexError
+        Integer
+        Interrupt
+        Kernel
+        KeyError
+        LoadError
+        LocalJumpError
+        Marshal
+        MatchData
+        Math
+        Math::DomainError
+        Method
+        Module
+        Mutex
+        NameError
+        NilClass
+        NoMemoryError
+        NoMethodError
+        NotImplementedError
+        Numeric
+        Object
+        ObjectSpace
+        ObjectSpace::WeakMap
+        Proc
+        Process
+        Process::GID
+        Process::Status
+        Process::Sys
+        Process::UID
+        Queue
+        Random
+        Random::Formatter
+        Range
+        RangeError
+        Rational
+        Regexp
+        RegexpError
+        RubyVM
+        RubyVM::AbstractSyntaxTree
+        RubyVM::AbstractSyntaxTree::Node
+        RubyVM::InstructionSequence
+        RubyVM::MJIT
+        RuntimeError
+        ScriptError
+        SecurityError
+        Set
+        Signal
+        SignalException
+        SizedQueue
+        StandardError
+        StopIteration
+        String
+        Struct
+        Symbol
+        SyntaxError
+        SystemCallError
+        SystemExit
+        SystemStackError
+        Thread
+        Thread::Backtrace
+        Thread::Backtrace::Location
+        ThreadError
+        ThreadGroup
+        Time
+        TracePoint
+        TrueClass
+        TypeError
+        UnboundMethod
+        UncaughtThrowError
+        UnicodeNormalize
+        Warning
+        ZeroDivisionError
+      }
+
+      # from https://api.rubyonrails.org/ , to automate
+      DEFAULT_RAILS = %w{
+        #<Class:
+        #<Module:
+        #<ActiveRecord:
+        #<ActiveModel:
+        Benchmark
+        BigDecimal
+        Concurrent
+        Date
+        DateAndTime
+        DateTime
+        Delegator
+        Digest
+        ERB
+        SecureRandom
+        URI
+        AbstractController
+        ActionCable
+        ActionController
+        ActionDispatch
+        ActionMailbox
+        ActionMailer
+        ActionText
+        ActionView
+        ActiveJob
+        ActiveModel
+        ActiveRecord
+        ActiveStorage
+        ActiveSupport
+        Arel
+        Mail
+        Mime
+        Rails
+        Rack
+        I18n
+        Bootsnap
+        Sprockets
+        Turbolinks
+        Pathname
+        MonitorMixin
+        Logger
+        Sprockets
+        ActionDispatch
+        ActiveSupport
+        ActionView
+        ApplicationHelper
+        SQLite3
+        Mysql2
+        Erubi
+        ApplicationController
+      }
+      def self.resolve_entries
+        if Gem.loaded_specs.has_key?('rails')
+          DEFAULT_RUBY + DEFAULT_RAILS
+        else
+          DEFAULT_RUBY
+        end
+      end
+    end
+  end
+end

data/lib/raygun/apm/config.rb

@@ -0,0 +1,77 @@
+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
+      }
+      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={})
+        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
+        end
+      end
+
+      # Initial constants for ProtonAgentTail.exe
+      UDP_SINK_HOST = '127.0.0.1'
+      UDP_SINK_MULTICAST_HOST = '239.100.15.215'
+      UDP_SINK_PORT = 2799
+
+      ## Enumerate all PROTON_ constants
+      config_var 'PROTON_DEBUG_LOGLEVEL', as: String, default: 'None'
+      config_var 'PROTON_USER_OVERRIDES_FILE', as: String
+      config_var 'PROTON_STARTUP_PERIOD', as: Integer, default: 0
+      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
+
+      ## ruby specific extras
+      config_var 'PROTON_RB_TRACE_BLOCKS', as: :boolean, default: false
+      config_var 'PROTON_EMIT_ARGUMENTS', as: :boolean, default: false
+
+      def udp_host
+        if proton_use_multicast == 'True'
+          UDP_SINK_MULTICAST_HOST
+        else
+          UDP_SINK_HOST
+        end
+      end
+
+      def udp_port
+        UDP_SINK_PORT
+      end
+
+      def loglevel
+        LOGLEVELS[proton_debug_loglevel] || raise(ArgumentError, "invalid log level")
+      end
+    end
+  end
+end

data/lib/raygun/apm/event.rb

@@ -0,0 +1,24 @@
+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 ThreadStarted < Event
+        def inspect
+          super + " "
+        end
+      end
+      class Begin < Event
+        def inspect
+          super + " function_id:#{self[:function_id]} instance_id:#{self[:instance_id]}"
+        end
+      end
+      class Methodinfo < Event
+        def inspect
+          super + " function_id:#{self[:function_id]} class_name:#{self[:class_name]} method_name:#{self[:method_name]}"
+        end
+      end
+    end
+  end
+end

data/lib/raygun/apm/middleware.rb

@@ -0,0 +1,98 @@
+module Raygun
+  module Apm
+    class Middleware
+      def initialize(app)
+        @app = app
+        @tracer = Raygun::Apm::Tracer.new
+        @tracer.udp_sink!
+        @tracer.process_started
+        ObjectSpace.define_finalizer(self, self.class.finalize(@tracer))
+
+        @http_in_subscriber = ActiveSupport::Notifications.subscribe('process_action.action_controller') do |*args|
+          http_in_handler(args)
+        end
+        @sql_subscriber = ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+          sql_handler(args)
+        end
+
+        # If any kamikaze errors on init, shutdown the tracer
+      rescue Raygun::Apm::FatalError => e
+        kamikaze_handler(e)
+      end
+
+      def call(env)
+        @status, @headers, @response = instrument(env)
+        [@status, @headers, @response]
+      end
+
+      def instrument(env)
+        res = nil
+        # Can be nil if we had a kamikaze error
+        @tracer.start_trace if @tracer
+        res = @app.call(env)
+        # Can be nil if we had a kamikaze error
+        @tracer.end_trace if @tracer
+        res
+      rescue Raygun::APM::FatalError => e
+        kamikaze_handler(e)
+      end
+
+      def kamikaze_handler(exception)
+        warn "Raygun APM shutting down due to error - %s", e.message
+        # Kill extended event subcriptions
+        ActiveSupport::Notifications.unsubscribe(@http_in_subscriber)
+        ActiveSupport::Notifications.unsubscribe(@sql_subscriber)
+        # Shutdown the tracepoint if enabled to reduce any overhead and stall emission
+        @tracer.tracepoint.stop if @tracer.tracepoint.enabled?
+        # Let the GC clean up the sink thread through the finalizer below
+        @tracer = nil
+      end
+
+      def http_in_handler(args)
+        notification = ActiveSupport::Notifications::Event.new *args
+        if notification.payload[:exception]
+          # XXX notify?
+          return
+        end
+        req = Rack::Request.new notification.payload[:headers].env
+        event = Raygun::Apm::Event::HttpIn.new
+        event[:url] = req.url
+        event[:verb] = req.request_method
+        event[:status] = notification.payload[:status]
+        # XXX constant milliseconds to microseconds
+        event[:duration] = notification.duration * 1000
+        @tracer.emit(event)
+      rescue => e
+        # XXX report
+      end
+
+      def sql_handler(args)
+        notification = ActiveSupport::Notifications::Event.new *args
+        connection = if notification.payload[:connection]
+          notification.payload[:connection]
+        else
+          ObjectSpace._id2ref(notification.payload[:connection_id])
+        end
+        event = Raygun::Apm::Event::Sql.new
+        event[:query] = notification.payload[:sql]
+
+        # XXX this is hacky
+        if config = connection.instance_variable_get('@config')
+          event[:provider] = config[:adapter]
+          event[:host] = config[:host]
+          event[:database] = config[:database]
+        end
+
+        # XXX constant milliseconds to microseconds
+        event[:duration] = notification.duration * 1000
+        @tracer.emit(event)
+      rescue => e
+        # XXX report
+      end
+
+      def self.finalize(tracer)
+        proc {tracer.process_ended}
+      end
+    end
+  end
+end

data/lib/raygun/apm/tracer.rb

@@ -0,0 +1,58 @@
+require 'raygun/apm/blacklist'
+module Raygun
+  module Apm
+    class Tracer
+      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
+        @blacklist.each do |line|
+          line.strip!
+          if line.start_with?('#')
+            # comment
+          elsif line.start_with?('+')
+            add_whitelist line[1..-1]
+          elsif line.start_with?('-')
+            add_blacklist line[1..-1]
+          elsif line.size > 0
+            add_blacklist line
+          end
+        end
+        Raygun::Apm::Blacklist.resolve_entries.each do |line|
+          add_blacklist line
+        end
+        install_tracepoint(
+          startup_period: config.proton_startup_period,
+          trace_blocks: config.proton_rb_trace_blocks,
+          emit_arguments: config.proton_emit_arguments,
+          loglevel: config.loglevel
+        )
+        ObjectSpace.define_finalizer(self, proc{ tracepoint.disable })
+      # 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 udp_sink!
+        require "socket"
+        sock = UDPSocket.new
+        self.udp_sink(
+          socket: sock,
+          host: config.udp_host,
+          port: config.udp_port
+        )
+      # 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}"
+      end
+
+    end
+  end
+end

data/lib/raygun/apm/version.rb

@@ -0,0 +1,5 @@
+module Raygun
+  module Apm
+    VERSION = "0.0.3"
+  end
+end

data/lib/raygun/apm.rb

@@ -0,0 +1,16 @@
+require "raygun/apm/version"
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "raygun#{$1}/raygun_extension"
+rescue LoadError
+  require "raygun/raygun_ext"
+end
+require "raygun/apm/config"
+require "raygun/apm/tracer"
+require "raygun/apm/event"
+
+module Raygun
+  module Apm
+    # Your code goes here...
+  end
+end

data/raygun-apm.gemspec

@@ -0,0 +1,32 @@
+
+require File.expand_path('../lib/raygun/apm/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "raygun-apm"
+  spec.version       = Raygun::Apm::VERSION
+  spec.authors       = ["Erkki Eilonen"]
+  spec.email         = ["erkki@bearmetal.eu"]
+
+  spec.summary       = %q{Raygun application performance monitoring}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|vendor|tools|ext)/}) || f.match(%r{Rakefile|.git}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "ext"]
+
+  spec.platform = Gem::Platform::RUBY
+  spec.extensions = ["ext/raygun/extconf.rb"]
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_development_dependency "debase-ruby_core_source", "~> 0.10.6"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake-compiler", "~> 1.0.8"
+  spec.add_development_dependency "rake-compiler-dock", "~> 0.7.2"
+  spec.add_development_dependency "benchmark_driver", "~> 0.14.17"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: raygun-apm
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: universal-darwin
+authors:
+- Erkki Eilonen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debase-ruby_core_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+- !ruby/object:Gem::Dependency
+  name: rake-compiler-dock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: benchmark_driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.17
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.17
+description: 
+email:
+- erkki@bearmetal.eu
+executables: []
+extensions:
+- ext/raygun/extconf.rb
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/console
+- bin/setup
+- ext/raygun/extconf.rb
+- lib/raygun/apm.rb
+- lib/raygun/apm/blacklist.rb
+- lib/raygun/apm/config.rb
+- lib/raygun/apm/event.rb
+- lib/raygun/apm/middleware.rb
+- lib/raygun/apm/tracer.rb
+- lib/raygun/apm/version.rb
+- lib/raygun/raygun_ext.bundle
+- raygun-apm.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Raygun application performance monitoring
+test_files: []