raygun-apm 1.1.15.pre3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 169ec3c65a1da8b111da8d8243528c5872e393e297ff0217f819f2552197803a
+  data.tar.gz: 24c62f1e9eb639b01867815ea1e04c62f91a2e7237fefc3ab7ccf0dd2266d04a
+SHA512:
+  metadata.gz: a598b36d21fdb353ab900e3cfef05e1cb2f54c0b8d8608ab9623061c62fd015f51bff58d38fb39a261095ba705561ca44e3aa71a08355cd7285bc2400d502baa
+  data.tar.gz: ee7b78f9715fa35821c6b5216c059abd7926502b204e48697cd8f67b20c2646f6b295fefd17636c4b44599ba79799c194f1994c3ead7676435a2cc8352cd1be1

data/COPYING.rax

@@ -0,0 +1,9 @@
+Copyright (c) 2017, Salvatore Sanfilippo <antirez@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE

@@ -0,0 +1,27 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Raygun Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+This software bundles Rax, an open source project, released under the BSD two
+clause license here https://github.com/antirez/rax/blob/master/COPYING
+
+This software also bundles bipbuffer, an open source project, released under
+the BSD license here https://github.com/willemt/bipbuffer/blob/master/LICENSE

data/LICENSE.bipbuffer

@@ -0,0 +1,24 @@
+Copyright (c) 2011, Willem-Hendrik Thiart
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * The names of its contributors may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL WILLEM-HENDRIK THIART BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,118 @@
+= Raygun Application Performance Monitoring
+
+Ruby Profiler for {Raygun Application Performance Monitoring}[https://raygun.com/documentation/language-guides/ruby/apm/installation/].
+
+Distributed as a precompiled native gem.
+
+== Supported platforms
+
+* x86-mingw32
+* x64-mingw32
+* x86-linux
+* x86_64-linux
+* universal-darwin
+
+{Contact us}[https://raygun.com/about/contact] to support other platforms.
+
+== Supported Ruby versions
+
+The profiler only supports CRuby, also known as Matz's Ruby Interpreter (MRI).
+
+* 2.5.x
+* 2.6.x
+* 2.7.x
+* 3.0.x
+
+{Contact us}[https://raygun.com/about/contact] to support other Ruby versions.
+
+== Agent Setup
+
+The Profiler needs to be able to access the Raygun Agent over UDP.
+
+=== Dockerized Agent
+
+The {Dockerized Agent}[https://raygun.com/documentation/product-guides/apm/agent/installation] is supported on all Ruby profiler platforms. We recommend
+this deployment model if your production infrastructure already depends on Docker.
+
+Also a great way to explore on your Mac.
+
+The <code>RAYGUN_AGENT_TOKEN</code> needs to be supplied as an argument and is available under "Application Settings" within the {Raygun Application Performance Monitoring}[https://raygun.com/platform/apm] UI
+
+To launch Raygun Agent using docker
+    docker pull raygunowner/raygun-apm
+    docker run -v raygun-agent:/usr/share/Raygun -e "RAYGUN_AGENT_TOKEN=<token>" -p 2790:2790 -p 2788:2788 -p 2799:2799/udp -it raygunowner/raygun-apm:latest
+
+=== Linux Agent
+
+The Linux version can be installed either using {systemd}[https://raygun.com/documentation/product-guides/apm/agent/installation/#installing-on-linux-using-systemd] or via {terminal}[https://raygun.com/documentation/product-guides/apm/agent/installation/#installing-on-linux-using-terminal]
+
+=== Windows Agent
+
+On windows the agent can be installed either via {MSI installer}[https://raygun.com/documentation/product-guides/apm/agent/installation/#installing-on-linux-using-terminal] or on {.NET core}[https://raygun.com/documentation/product-guides/apm/agent/installation/#installing-on-windows-net-core]
+
+== Ruby on Rails 
+
+For Rails support see {documentation}[https://www.rubydoc.info/gems/raygun-apm-rails/0.1.0] of the railgun-apm-rails gem.
+
+== Profiler Setup
+
+Include the gem in your Gemfile
+
+    gem 'raygun-apm'
+
+Run <code>bundle</code> to install the gem.
+
+Alternatively install using rubygems <code>gem install raygun-apm</code>.
+
+=== Profiler configration
+
+==== Multiple applications, one Agent
+
+Set the `PROTON_API_KEY` environment variable to your API key, which is available under "Application Settings" within the {Raygun Application Performance Monitoring}[https://raygun.com/platform/apm] UI.
+
+=== Standalone ruby script / custom framework
+
+For standalone scripts, context start-end needs to be marked specifically and optionally extended events can be called.
+
+  #!/usr/bin/env ruby
+  require 'raygun/apm'
+  
+  class Hello
+    def rdoc
+      sleep 0.5
+    end
+  end
+  
+  tracer = Raygun::Apm::Tracer.new
+  tracer.udp_sink!
+  tracer.start_trace
+  Hello.new.rdoc
+  tracer.end_trace
+  tracer.process_ended
+
+Extended events can be sent where appropiate
+
+<code>HTTP incoming event</code>
+
+  event = Raygun::Apm::Event::HttpIn.new
+  event[:pid] = Process.pid
+  event[:tid] = 0
+  event[:timestamp] = tracer.now
+  event[:url] = 'https://google.com/'
+  event[:verb] = 'GET'
+  event[:status] = 200
+  event[:duration] = 1000  
+  tracer.emit(event)
+
+<code>SQL query</code>
+
+  event = Raygun::Apm::Event::Sql.new
+  event[:pid] = Process.pid
+  event[:tid] = 0
+  event[:timestamp] = tracer.now
+  event[:provider] = 'postgres'
+  event[:host] = 'localhost'
+  event[:database] = 'rails'
+  event[:query] = 'SELECT * from FOO;'
+  event[:duration] = 1000
+  tracer.emit(event)

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/rake

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rake.cmd

@@ -0,0 +1,30 @@
+@ruby -x "%~f0" %*
+@exit /b %ERRORLEVEL%
+
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/raygun-diagnostics

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "raygun/apm"
+
+tracer = Raygun::Apm::Tracer.new

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,114 @@
+# encoding: utf-8
+
+# Makefile generator helper - from standard library
+require 'mkmf'
+
+# References core headers extracted by Ruby minor version in https://github.com/os97673/debase-ruby_core_source
+# Required for some of the lower level profiler features (vm_core.h, rb_thread_t, etc.)
+begin
+  require 'debase/ruby_core_source'
+rescue LoadError => e
+  STDERR.puts "=" * 70
+  STDERR.puts "Raygun APM: Failed to load debase-ruby_core_source"
+  STDERR.puts ""
+  STDERR.puts "This gem is required to compile the native extension against Ruby VM internals."
+  STDERR.puts "Please ensure debase-ruby_core_source >= 3.3.6 is installed:"
+  STDERR.puts ""
+  STDERR.puts "  gem install debase-ruby_core_source"
+  STDERR.puts ""
+  STDERR.puts "Error: #{e.message}"
+  STDERR.puts "=" * 70
+  exit(1)
+end
+
+# Verify we have headers for the current Ruby version
+ruby_version = "#{RUBY_VERSION}"
+STDERR.puts "[Raygun APM] Building native extension for Ruby #{ruby_version}"
+
+headers = proc do
+  have_header('ruby.h') &&
+  have_header('ruby/debug.h') &&
+  have_header("vm_core.h")
+end
+
+dir_config('raygun')
+
+# To allow for swapping out the compiler - clang in favour of gcc for example
+RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+
+# Pedantic about all the things
+append_cflags '-pedantic'
+append_cflags '-Wall'
+append_cflags '-std=c99'
+append_cflags '-std=gnu99'
+append_cflags '-fdeclspec'
+append_cflags '-fms-extensions'
+append_cflags '-ggdb3'
+
+# Check if using clang (supports more warning flags)
+is_clang = RbConfig::CONFIG['CC'] =~ /clang/ || `#{RbConfig::CONFIG['CC']} --version 2>/dev/null`.include?('clang')
+
+if is_clang
+  # Clang-specific warning suppressions
+  append_cflags '-Wno-shorten-64-to-32'
+  append_cflags '-Wno-unknown-warning-option'
+  append_cflags '-Wno-incompatible-pointer-types-discards-qualifiers'
+  append_cflags '-Wno-self-assign'
+  append_cflags '-Wno-parentheses-equality'
+  append_cflags '-Wno-constant-logical-operand'
+else
+  # GCC 12+ use-after-free false positive in third-party rax.c
+  append_cflags '-Wno-use-after-free'
+end
+
+# Only use -Werror in CI/development, not in production builds
+if ENV['WERROR'] || ENV['CI']
+  append_cflags '-Werror'
+end
+
+# Enables additional flags, stack protection and debug symbols
+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'
+  append_cflags '-DRB_RG_DEBUG'
+else
+  append_cflags '-O3'
+end
+
+# Renders an ASCII presentation of the shadow stack at runtime
+if ENV['DEBUG_SHADOW_STACK']
+  append_cflags '-DRB_RG_DEBUG_SHADOW_STACK'
+end
+
+unless create_header
+  STDERR.print("extconf.h creation failed\n")
+  exit(1)
+end
+
+# Check for the presence of headers in ruby_core_headers for the version currently compiled for
+unless Debase::RubyCoreSource.create_makefile_with_core(headers, 'raygun_ext')
+  STDERR.puts "=" * 70
+  STDERR.puts "Raygun APM: Makefile creation failed"
+  STDERR.puts ""
+  STDERR.puts "One or more Ruby VM headers (vm_core.h) were not found for Ruby #{ruby_version}."
+  STDERR.puts ""
+  STDERR.puts "This usually means debase-ruby_core_source does not yet have headers"
+  STDERR.puts "for your Ruby version. Please try updating the gem:"
+  STDERR.puts ""
+  STDERR.puts "  gem update debase-ruby_core_source"
+  STDERR.puts ""
+  STDERR.puts "If the problem persists, please report this issue at:"
+  STDERR.puts "  https://github.com/MindscapeHQ/raygun-apm-ruby/issues"
+  STDERR.puts "=" * 70
+  exit(1)
+end
+
+STDERR.puts "[Raygun APM] Native extension configured successfully"

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

@@ -0,0 +1,49 @@
+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.start_with?('L-')
+            @tracer.add_blacklist(*translate(filter[2..-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,79 @@
+module Raygun
+  module Apm
+    module Blacklist
+      class Translator
+        class RubyTranslator
+          # Foo::Bar#baz
+          # Foo::Bar.baz
+          # Foo::Bar::baz
+          COMMENT = /^#.*/
+          ANONYMOUS = /^#<.*>?/
+          NAMESPACE = /::/
+          NAMESPACE_ONLY = /::$/
+          METHOD = /#|\./
+          LETTER_CASE = /^[A-Z]/
+          LOWER_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
+              if path && (_method = path.split(NAMESPACE).last) =~ LOWER_CASE
+                method = _method
+                path.gsub!(Regexp.compile("::#{method}$"), "")
+              end
+              [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