stackify-ruby-apm 0.9.0

data/lib/stackify/util/inspector.rb

@@ -0,0 +1,59 @@
+module StackifyRubyAPM
+  module Util
+    # @api private
+    class Inspector
+      def initialize(width = 80)
+        @width = width
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def transaction(transaction)
+        unless transaction.done?
+          raise ArgumentError, 'Transaction still running'
+        end
+
+        width_factor = @width.to_f / ms(transaction.duration)
+
+        lines = ['=' * @width]
+        lines << "[T] #{transaction.name} " \
+          "- #{transaction.type} (#{ms transaction.duration} ms)"
+        lines << "+#{'-' * (@width - 2)}+"
+
+        transaction.spans.each do |span|
+          indent = (ms(span.relative_start) * width_factor).to_i
+
+          if span.duration
+            span_width = ms(span.duration) * width_factor
+            duration_desc = ms(span.duration)
+          else
+            span_width = @width - indent
+            duration_desc = 'RUNNING'
+          end
+
+          description = "[#{span.id}] " \
+            "#{span.name} - #{span.type} (#{duration_desc} ms)"
+          description_indent = [
+            0,
+            [indent, @width - description.length].min
+          ].max
+
+          lines << "#{' ' * description_indent}#{description}"
+          lines << "#{' ' * indent}+#{'-' * [(span_width - 2), 0].max}+"
+        end
+
+        lines.map { |s| s[0..@width] }.join("\n")
+      rescue StandardError => e
+        puts e
+        puts e.backtrace.join("\n")
+        nil
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      private
+
+      def ms(micros)
+        micros.to_f / 1_000
+      end
+    end
+  end
+end

data/lib/stackify/util/lru_cache.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module StackifyRubyAPM
+    module Util
+      # @api private
+      class LruCache
+        def initialize(max_size = 512, &block)
+          @max_size = max_size
+          @data = Hash.new(&block)
+          @mutex = Mutex.new
+        end
+  
+        def [](key)
+          @mutex.synchronize do
+            val = @data[key]
+            return unless val
+            add(key, val)
+            val
+          end
+        end
+  
+        def []=(key, val)
+          @mutex.synchronize do
+            add(key, val)
+          end
+        end
+  
+        def length
+          @data.length
+        end
+  
+        def to_a
+          @data.to_a
+        end
+  
+        private
+  
+        def add(key, val)
+          @data.delete(key)
+          @data[key] = val
+  
+          return unless @data.length > @max_size
+  
+          @data.delete(@data.first[0])
+        end
+      end
+    end
+  end
+  

data/lib/stackify/version.rb

@@ -0,0 +1,4 @@
+# Sets the version of the APM
+module StackifyRubyAPM
+  VERSION = '0.9.0'.freeze
+end

data/lib/stackify/worker.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+#
+# This class will receive the transactions and send it to HTTP/TraceLogger.
+# Responsible for sending transactions to APM for every 10 secs (config.flush_interval default)
+# Worker will constantly execute transaction sending to APM until the Agent is stopped.
+#
+
+require 'concurrent/timer_task'
+
+module StackifyRubyAPM
+  # @api private
+  class Worker
+    include Log
+
+    # @api private
+    class StopMsg; end
+
+    # @api private
+    class FlushMsg; end
+
+    # @api private
+    class ErrorMsg
+      def initialize(error)
+        @error = error
+      end
+
+      attr_reader :error
+    end
+
+    def initialize(config, messages, pending_transactions, trace_logger)
+      @config = config
+      @messages = messages
+      @pending_transactions = pending_transactions
+      @trace_logger = trace_logger
+
+      @serializers = Struct.new(:transactions, :errors).new(
+        Serializers::Transactions.new(config),
+        Serializers::Errors.new(config)
+      )
+    end
+
+    attr_reader :config, :messages, :pending_transactions
+
+    # rubocop:disable Metrics/MethodLength
+    # Collects and sends the transactions
+    #
+    def run_forever
+      @timer_task = build_timer_task.execute
+
+      while (msg = messages.pop)
+        case msg
+        when ErrorMsg
+          post_error msg
+        when FlushMsg
+          collect_and_send_transactions
+        when StopMsg
+          # empty collected transactions before exiting
+          collect_and_send_transactions
+          stop!
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    def stop!
+      @timer_task && @timer_task.shutdown
+      Thread.exit
+    end
+
+    # flush_interval - interval with which transactions should be sent to the APM. Default value: 10 seconds
+    # The running task responsible for initiating the transactions sending
+    #
+    def build_timer_task
+      Concurrent::TimerTask.new(execution_interval: config.flush_interval) do
+        messages.push(FlushMsg.new)
+      end
+    end
+
+    # Collects, builds, and sends transactions via HTTP/TraceLogger
+    #
+    def collect_and_send_transactions
+      return if pending_transactions.empty?
+      transactions = collect_batched_transactions
+      debug '@stackify_ruby [lib/worker.rb] Successfully collect and send transaction to the to trace logger.'
+      begin
+        @trace_logger.post(transactions)
+      rescue ::Exception => e
+        debug 'Failed posting: '
+        debug e.inspect
+        debug e.backtrace.join("\n")
+        nil
+      end
+    end
+
+    def post_error(msg)
+      return if pending_transactions.empty?
+      transactions = collect_batched_transactions
+      payload = @serializers.errors.build_all([msg.error])
+      debug '@stackify_ruby [lib/worker.rb] error'
+      # @trace_logger.post(payload, transactions[0])
+    end
+
+    def collect_batched_transactions
+      batch = []
+
+      begin
+        while (transaction = pending_transactions.pop(true)) &&
+              batch.length <= config.max_queue_size
+          batch << transaction
+        end
+      rescue ThreadError # queue empty
+      end
+
+      batch
+    end
+  end
+end

data/lib/stackify_ruby_apm.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+#
+# The entry point once the server starts after the Stackify APM has been integrated.
+#
+# Checks if Web App's framework is Rails or Sinatra:
+#   if Rails
+#     -> call lib/stackify/railtie.rb to start Agent
+#   elsif Sinatra
+#     -> access the Web App's /config.ru file to start Agent
+#   end
+#
+# Incoming requests are then handled by the Middleware (middleware.rb)
+#
+
+require 'stackify/log'
+require 'stackify/version'
+require 'stackify/util/dig'
+
+require 'stackify/agent'
+require 'stackify/config'
+require 'stackify/logger'
+require 'stackify/context'
+require 'stackify/instrumenter'
+require 'stackify/internal_error'
+require 'stackify/util'
+
+require 'stackify/middleware'
+
+# Checks if the framework using is Rails
+require 'stackify/railtie' if defined?(::Rails::Railtie) 
+
+module StackifyRubyAPM
+  # Starts the StackifyRubyAPM Agent
+  #
+  # @param config [Config] An instance of Config
+  # @return [Agent] The resulting [Agent]
+  def self.start(config = {})
+    # debug "Starts the StackifyRubyAPM Agent self.start()"
+
+    Agent.start config
+  end
+
+  # Stops the StackifyRubyAPM Agent
+  def self.stop
+    Agent.stop
+  end
+
+  # @return [Boolean] Whether there's an [Agent] running
+  def self.running?
+    Agent.running?
+  end
+
+  # @return [Agent] Currently running [Agent] if any
+  def self.agent
+    Agent.instance
+  end
+  ### Metrics
+
+  # Returns the currently active transaction (if any)
+  #
+  # @return [Transaction] if any
+  def self.current_transaction
+    agent && agent.current_transaction
+  end
+
+  # Start a new transaction or return the currently running
+  #
+  # @param name [String] A description of the transaction, eg
+  # `ExamplesController#index`
+  # @param type [String] The kind of the transaction, eg `app.request.get` or
+  # `db.mysql2.query`
+  # @param context [Context] An optional [Context]
+  # @yield [Transaction] Optional block encapsulating transaction
+  # @return [Transaction] Unless block given
+  def self.transaction(name = nil, type = nil, context: nil, &block)
+    # debug "@stackify_ruby [lib/stackify_ruby_apm.rb] loads self.transaction(name = nil, type = nil, context: nil, &block)"
+    return (block_given? ? yield : nil) unless agent
+
+    agent.transaction(name, type, context: context, &block)
+  end
+  
+  # Starts a new span under the current transaction
+  #
+  # @param name [String] A description of the span, eq `SELECT FROM "users"`
+  # @param type [String] The kind of span, eq `db.mysql2.query`
+  # @param context [Span::Context] Context information about the span
+  # @yield [Span] Optional block encapsulating span
+  # @return [Span] Unless block given
+  def self.span(name, type = nil, context: nil, include_stacktrace: true,
+    &block)
+    return (block_given? ? yield : nil) unless agent
+
+    agent.span(
+      name,
+      type,
+      context: context,
+      backtrace: include_stacktrace ? caller : nil,
+      &block
+    )
+  end
+
+  # Build a [Context] from a Rack `env`. The context may include information
+  # about the request, response, current user and more
+  #
+  # @param rack_env [Rack::Env] A Rack env
+  # @return [Context] The built context
+  def self.build_context(rack_env)
+    # debug "@stackify_ruby [lib/stackify_ruby_apm.rb] self.build_context(rack_env)"
+    agent && agent.build_context(rack_env)
+  end
+
+  ### Errors
+
+  # Report and exception to APM
+  #
+  # @param exception [Exception] The exception
+  # @param handled [Boolean] Whether the exception was rescued
+  # @return [Error] The generated [Error]
+  def self.report(exception, handled: true)
+    agent && agent.report(exception, handled: handled)
+  end
+
+  # Report a custom string error message to APM
+  #
+  # @param message [String] The message
+  # @return [Error] The generated [Error]
+  def self.report_message(message, **attrs)
+    agent && agent.report_message(message, backtrace: caller, **attrs)
+  end
+end

data/stackify-ruby-apm.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "stackify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "stackify-ruby-apm"
+  spec.version       = StackifyRubyAPM::VERSION
+  spec.authors       = ["Stackify"]
+  spec.email         = ["support@stackify.com"]
+  spec.summary       = 'Stackify APM for Ruby'
+  spec.homepage      = 'http://www.stackify.com'
+  spec.license       = 'Stackify'
+
+  # 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         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency('concurrent-ruby', '~> 1.0')
+  spec.add_dependency('delegate_matcher', '~> 0.4')
+  spec.add_dependency('webmock', '~> 3.4')
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: stackify-ruby-apm
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Stackify
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-16 00:00:00.000000000 Z
+dependencies:
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: delegate_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- support@stackify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/stackify-ruby-apm.rb
+- lib/stackify/agent.rb
+- lib/stackify/config.rb
+- lib/stackify/context.rb
+- lib/stackify/context/request.rb
+- lib/stackify/context/request/socket.rb
+- lib/stackify/context/request/url.rb
+- lib/stackify/context/response.rb
+- lib/stackify/context_builder.rb
+- lib/stackify/error.rb
+- lib/stackify/error/exception.rb
+- lib/stackify/error/log.rb
+- lib/stackify/error_builder.rb
+- lib/stackify/instrumenter.rb
+- lib/stackify/internal_error.rb
+- lib/stackify/log.rb
+- lib/stackify/logger.rb
+- lib/stackify/middleware.rb
+- lib/stackify/naively_hashable.rb
+- lib/stackify/normalizers.rb
+- lib/stackify/normalizers/action_controller.rb
+- lib/stackify/normalizers/action_mailer.rb
+- lib/stackify/normalizers/action_view.rb
+- lib/stackify/normalizers/active_record.rb
+- lib/stackify/railtie.rb
+- lib/stackify/root_info.rb
+- lib/stackify/serializers.rb
+- lib/stackify/serializers/errors.rb
+- lib/stackify/serializers/transactions.rb
+- lib/stackify/span.rb
+- lib/stackify/span/context.rb
+- lib/stackify/spies.rb
+- lib/stackify/spies/action_dispatch.rb
+- lib/stackify/spies/httpclient.rb
+- lib/stackify/spies/mongo.rb
+- lib/stackify/spies/net_http.rb
+- lib/stackify/spies/sinatra.rb
+- lib/stackify/spies/tilt.rb
+- lib/stackify/stacktrace.rb
+- lib/stackify/stacktrace/frame.rb
+- lib/stackify/stacktrace_builder.rb
+- lib/stackify/subscriber.rb
+- lib/stackify/trace_logger.rb
+- lib/stackify/transaction.rb
+- lib/stackify/util.rb
+- lib/stackify/util/dig.rb
+- lib/stackify/util/inflector.rb
+- lib/stackify/util/inspector.rb
+- lib/stackify/util/lru_cache.rb
+- lib/stackify/version.rb
+- lib/stackify/worker.rb
+- lib/stackify_ruby_apm.rb
+- stackify-ruby-apm.gemspec
+homepage: http://www.stackify.com
+licenses:
+- Stackify
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Stackify APM for Ruby
+test_files: []