oneapm_rpm 1.1.0

data/lib/one_apm/support/parameter_filtering.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module OneApm
+  module Support
+    module ParameterFiltering
+      extend self
+
+      def apply_filters(env, params)
+        params = filter_using_rails(env, params)
+        params = filter_rack_file_data(env, params)
+        params
+      end
+
+      def filter_using_rails(env, params)
+        return params unless defined?(ActionDispatch::Http::ParameterFilter) && env.key?("action_dispatch.parameter_filter")
+        filters = env["action_dispatch.parameter_filter"]
+        ActionDispatch::Http::ParameterFilter.new(filters).filter(params)
+      end
+
+      def filter_rack_file_data(env, params)
+        content_type = env["CONTENT_TYPE"]
+        multipart = content_type && content_type.start_with?("multipart")
+
+        params.inject({}) do |memo, (k,v)|
+          if multipart && v.is_a?(Hash) && v[:tempfile]
+            memo[k] = "[FILE]"
+          else
+            memo[k] = v
+          end
+          memo
+        end
+      end
+    end
+  end
+end

data/lib/one_apm/support/rules_engine.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'one_apm/support/rules_engine/replacement_rule'
+require 'one_apm/support/rules_engine/segment_terms_rule'
+
+module OneApm
+  module Support
+    class RulesEngine
+      SEGMENT_SEPARATOR = '/'.freeze
+      LEADING_SLASH_REGEX = %r{^/}.freeze
+
+      include Enumerable
+      extend Forwardable
+
+      def_delegators :@rules, :size, :inspect, :each, :clear
+
+      def self.create_metric_rules(connect_response)
+        specs = connect_response['metric_name_rules'] || []
+        rules = specs.map { |spec| ReplacementRule.new(spec) }
+        self.new(rules)
+      end
+
+      def self.create_transaction_rules(connect_response)
+        txn_name_specs     = connect_response['transaction_name_rules']    || []
+        segment_rule_specs = connect_response['transaction_segment_terms'] || []
+
+        txn_name_rules = txn_name_specs.map     { |s| ReplacementRule.new(s) }
+        segment_rules  = segment_rule_specs.map { |s| SegmentTermsRule.new(s) }
+
+        self.new(txn_name_rules, segment_rules)
+      end
+
+      def initialize(rules=[], segment_term_rules=[])
+        @rules = rules.sort
+        @segment_term_rules = segment_term_rules
+      end
+
+      def apply_rules(rules, string)
+        rules.each do |rule|
+          if rule.matches?(string)
+            string = rule.apply(string)
+            break if rule.terminal?
+          end
+        end
+        string
+      end
+
+      def rename(original_string)
+        renamed = apply_rules(@rules, original_string)
+        return nil unless renamed
+        renamed = apply_rules(@segment_term_rules, renamed)
+        renamed
+      end
+    end
+  end
+end

data/lib/one_apm/support/rules_engine/replacement_rule.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+module OneApm
+  module Support
+    class RulesEngine
+      class ReplacementRule
+
+        attr_reader :terminate_chain,
+                    :each_segment,
+                    :ignore,
+                    :replace_all,
+                    :eval_order,
+                    :match_expression,
+                    :replacement
+
+        def initialize(options)
+          if !options['match_expression']
+            raise ArgumentError.new('missing required match_expression')
+          end
+          if !options['replacement'] && !options['ignore']
+            raise ArgumentError.new('must specify replacement when ignore is false')
+          end
+
+          @match_expression = Regexp.new(options['match_expression'], Regexp::IGNORECASE)
+          @replacement      = options['replacement']
+          @ignore           = options['ignore'] || false
+          @eval_order       = options['eval_order'] || 0
+          @replace_all      = options['replace_all'] || false
+          @each_segment     = options['each_segment'] || false
+          @terminate_chain  = options['terminate_chain'] || false
+        end
+
+        def terminal?
+          @terminate_chain || @ignore
+        end
+
+        def matches?(string)
+          if @each_segment
+            string.split(SEGMENT_SEPARATOR).any? do |segment|
+              segment.match(@match_expression)
+            end
+          else
+            string.match @match_expression
+          end
+        end
+
+        def apply(string)
+          if @ignore
+            nil
+          elsif @each_segment
+            apply_to_each_segment(string)
+          else
+            apply_replacement(string)
+          end
+        end
+
+        def apply_replacement(string)
+          method = @replace_all ? :gsub : :sub
+          string.send(method, @match_expression, @replacement)
+        end
+
+        def apply_to_each_segment(string)
+          string        = string.dup
+          leading_slash = string.slice!(LEADING_SLASH_REGEX)
+          segments      = string.split(SEGMENT_SEPARATOR)
+
+          segments.map! do |segment|
+            apply_replacement(segment)
+          end
+
+          "#{leading_slash}#{segments.join(SEGMENT_SEPARATOR)}"
+        end
+
+        def <=>(other)
+          eval_order <=> other.eval_order
+        end
+      end
+    end
+  end
+end

data/lib/one_apm/support/rules_engine/segment_terms_rule.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module OneApm
+  module Support
+    class RulesEngine
+      class SegmentTermsRule
+        SEGMENT_PLACEHOLDER               = '*'.freeze
+        ADJACENT_PLACEHOLDERS_REGEX       = %r{((?:^|/)\*)(?:/\*)*}.freeze
+        ADJACENT_PLACEHOLDERS_REPLACEMENT = '\1'.freeze
+
+        attr_reader :prefix, :terms
+
+        def initialize(options)
+          @prefix          = options['prefix']
+          @terms           = options['terms']
+          @trim_range      = (@prefix.size..-1)
+        end
+
+        def terminal?
+          true
+        end
+
+        def matches?(string)
+          string.start_with?(@prefix)
+        end
+
+        def apply(string)
+          rest          = string[@trim_range]
+          leading_slash = rest.slice!(LEADING_SLASH_REGEX)
+
+          segments = rest.split(SEGMENT_SEPARATOR)
+          segments.map! { |s| @terms.include?(s) ? s : SEGMENT_PLACEHOLDER }
+          transformed_suffix = collapse_adjacent_placeholder_segments(segments)
+
+          "#{@prefix}#{leading_slash}#{transformed_suffix}"
+        end
+
+        def collapse_adjacent_placeholder_segments(segments)
+          joined = segments.join(SEGMENT_SEPARATOR)
+          joined.gsub!(ADJACENT_PLACEHOLDERS_REGEX, ADJACENT_PLACEHOLDERS_REPLACEMENT)
+          joined
+        end
+      end
+    end
+  end
+end

data/lib/one_apm/support/server.rb

@@ -0,0 +1,11 @@
+module OneApm
+  module Support
+
+    class Server < Struct.new :name, :port, :ip
+      def to_s; "#{name}:#{port}"; end
+    end
+
+    ProxyServer = Struct.new :name, :port, :user, :password
+
+  end
+end

data/lib/one_apm/support/supported_versions.rb

@@ -0,0 +1,257 @@
+# encoding: utf-8
+
+module OneApm
+  module Agent
+    SUPPORTED_VERSIONS =
+    {
+      # Rubies
+      :mri =>
+      {
+        :type        => :ruby,
+        :name        => "MRI",
+        :supported   => ["1.8.7", "1.9.2", "1.9.3", "2.0.0", "~> 2.1.0", "~> 2.2.0" ],
+        :deprecated  => ["1.8.6"],
+        :url         => "https://www.ruby-lang.org",
+        :feed        => "https://www.ruby-lang.org/en/feeds/news.rss",
+        :notes       => [
+          "1.8.7 includes support for Ruby Enterprise Edition (REE)",
+          "Last supported agent on 1.8.6 was 3.6.8.168"]
+      },
+      :jruby =>
+      {
+        :type        => :ruby,
+        :name        => "JRuby",
+        :supported   => ["~> 1.6.0", "~> 1.7.0"],
+        :url         => "http://jruby.org",
+        :feed        => "http://jruby.org/atom.xml"
+      },
+      :rbx =>
+      {
+        :type        => :ruby,
+        :name        => "Rubinius",
+        :supported   => ["~> 2.2.1"],
+        :url         => "http://rubini.us",
+        :feed        => "http://rubini.us/feed/atom.xml"
+      },
+
+      # App servers
+      :passenger =>
+      {
+        :type        => :app_server,
+        :supported   => ["~>2.2", "~>3.0", "~>4.0"],
+        :url         => "http://www.phusionpassenger.com/",
+        :feed        => "http://rubygems.org/gems/passenger/versions.atom"
+      },
+      :thin =>
+      {
+        :type        => :app_server,
+        :supported   => ["~>1.0"],
+        :url         => "http://code.macournoyer.com/thin/",
+        :feed        => "http://rubygems.org/gems/thin/versions.atom"
+      },
+      :unicorn =>
+      {
+        :type        => :app_server,
+        :supported   => ["~>4.0"],
+        :deprecated  => ["~>1.0", "~>2.0", "~>3.0"],
+        :url         => "http://unicorn.bogomips.org/",
+        :feed        => "http://rubygems.org/gems/unicorn/versions.atom"
+      },
+      :puma =>
+      {
+        :type        => :app_server,
+        :supported   => ["~>2.0"],
+        :deprecated  => ["~>1.0"],
+        :url         => "http://puma.io/",
+        :feed        => "http://rubygems.org/gems/puma/versions.atom"
+      },
+      :rainbows =>
+      {
+        :type        => :app_server,
+        :name        => "rainbows!",
+        :experimental=> ["4.5.0"],
+        :url         => "http://rainbows.rubyforge.org/",
+        :feed        => "http://rubygems.org/gems/rainbows/versions.atom"
+      },
+      :webrick =>
+      {
+        :type        => :app_server,
+        :notes       => [ "Supported for all agent-supported versions of Ruby" ]
+      },
+
+      # Web frameworks
+      :rails =>
+      {
+        :type        => :web,
+        :supported   => ["~>2.1.0", "~>2.2.0", "~>2.3.0", "~3.0.0", "~>3.1.0", "~>3.2.0", "~>4.0.0", "~>4.1.0", "~>4.2.0"],
+        :deprecated  => ["~>2.0.0"],
+        :url         => "https://rubygems.org/gems/rails",
+        :feed        => "https://rubygems.org/gems/rails/versions.atom",
+        :notes       => ["Last supported agent for 2.0.x was 3.6.8.168"]
+      },
+      :sinatra =>
+      {
+        :type        => :web,
+        :supported   => ["~>1.2.0", "~>1.3.0", "~>1.4.0"],
+        :url         => "https://rubygems.org/gems/sinatra",
+        :feed        => "https://rubygems.org/gems/sinatra/versions.atom"
+      },
+      :padrino =>
+      {
+        :type        => :web,
+        :supported   => ["~>0.10"],
+        :url         => "https://rubygems.org/gems/padrino",
+        :feed        => "https://rubygems.org/gems/padrino/versions.atom"
+      },
+      :rack =>
+      {
+        :type        => :web,
+        :supported   => [">= 1.1.0"],
+        :deprecated  => ["~>1.0.0"],
+        :url         => "https://rubygems.org/gems/rack",
+        :feed        => "https://rubygems.org/gems/rack/versions.atom"
+      },
+      :grape =>
+      {
+        :type        => :web,
+        :supported   => [">= 0.2.0"],
+        :url         => "https://rubygems.org/gems/grape",
+        :feed        => "https://rubygems.org/gems/grape/versions.atom"
+      },
+
+      # Database
+      :activerecord =>
+      {
+        :type        => :database,
+        :supported   => ["~>2.1.0", "~>2.2.0", "~>2.3.0", "~3.0.0", "~>3.1.0", "~>3.2.0", "~>4.0.0"],
+        :deprecated  => ["~>2.0.0"],
+        :url         => "https://rubygems.org/gems/activerecord",
+        :feed        => "https://rubygems.org/gems/activerecord/versions.atom",
+        :notes       => ["Last supported agent for 2.0.x was 3.6.8.168"]
+      },
+      :datamapper =>
+      {
+        :type        => :database,
+        :supported   => ["~>1.0"],
+        :url         => "https://rubygems.org/gems/datamapper",
+        :feed        => "https://rubygems.org/gems/datamapper/versions.atom"
+      },
+      :sequel =>
+      {
+        :type        => :database,
+        :supported   => ["~>3.37", "~>4.0"],
+        :url         => "https://rubygems.org/gems/sequel",
+        :feed        => "https://rubygems.org/gems/sequel/versions.atom"
+      },
+      :mongo =>
+      {
+        :type        => :database,
+        :supported   => ["~>1.8.0", "~>1.9.0", "~>1.10.0"],
+        :url         => "https://rubygems.org/gems/mongo",
+        :feed        => "https://rubygems.org/gems/mongo/versions.atom"
+      },
+
+      # Background Jobs
+      :resque =>
+      {
+        :type        => :background,
+        :supported   => ["~>1.23.0"],
+        :deprecated  => ["~>1.22.0"],
+        :experimental=> [">= 2.0"],
+        :url         => "https://rubygems.org/gems/resque",
+        :feed        => "https://rubygems.org/gems/resque/versions.atom"
+      },
+      :sidekiq =>
+      {
+        :type        => :background,
+        :supported   => ["~>2.8"],
+        :url         => "https://rubygems.org/gems/sidekiq",
+        :feed        => "https://rubygems.org/gems/sidekiq/versions.atom"
+      },
+      :delayed_job =>
+      {
+        :type        => :background,
+        :supported   => ["~>2.0", "~>3.0", "~>4.0"],
+        :url         => "https://rubygems.org/gems/delayed_job",
+        :feed        => "https://rubygems.org/gems/delayed_job/versions.atom"
+      },
+
+      # HTTP Clients
+      :curb =>
+      {
+        :type        => :http,
+        :supported   => [ ">= 0.8.1" ],
+        :url         => "https://rubygems.org/gems/curb",
+        :feed        => "https://rubygems.org/gems/curb/versions.atom"
+      },
+      :excon =>
+      {
+        :type        => :http,
+        :supported   => [ ">= 0.10.1" ],
+        :url         => "https://rubygems.org/gems/excon",
+        :feed        => "https://rubygems.org/gems/excon/versions.atom"
+      },
+      :httpclient =>
+      {
+        :type        => :http,
+        :supported   => [ ">= 2.2.0"],
+        :url         => "https://rubygems.org/gems/httpclient",
+        :feed        => "https://rubygems.org/gems/httpclient/versions.atom"
+      },
+      :typhoeus =>
+      {
+        :type        => :http,
+        :supported   => [ ">= 0.5.3"],
+        :url         => "https://rubygems.org/gems/typhoeus",
+        :feed        => "https://rubygems.org/gems/typhoeus/versions.atom"
+      },
+      :net_http =>
+      {
+        :type        => :http,
+        :name        => "Net::HTTP",
+        :notes       => [
+          "Supported for all agent-supported versions of Ruby.",
+          "For more information on supported HTTP clients see http://docs.oneapm.com/docs/ruby/ruby-http-clients."]
+      },
+
+      # Other
+      :sunspot =>
+      {
+        :type        => :other,
+        :url         => "https://rubygems.org/gems/sunspot",
+        :feed        => "https://rubygems.org/gems/sunspot/versions.atom"
+      },
+      :acts_as_solr =>
+      {
+        :type        => :other,
+        :url         => "https://rubygems.org/gems/acts_as_solr",
+        :feed        => "https://rubygems.org/gems/acts_as_solr/versions.atom"
+      },
+      :dalli =>
+      {
+        :type        => :other,
+        :url         => "https://rubygems.org/gems/dalli",
+        :feed        => "https://rubygems.org/gems/dalli/versions.atom"
+      },
+      :'memcache-client' =>
+      {
+        :type        => :other,
+        :url         => "https://rubygems.org/gems/memcache-client",
+        :feed        => "https://rubygems.org/gems/memcache-client/versions.atom"
+      },
+      :authlogic =>
+      {
+        :type        => :other,
+        :url         => "https://rubygems.org/gems/authlogic",
+        :feed        => "https://rubygems.org/gems/authlogic/versions.atom"
+      },
+      :activemerchant =>
+      {
+        :type        => :other,
+        :supported   => [ ">= 1.25.0"],
+        :url         => "https://rubygems.org/gems/activemerchant",
+        :feed        => "https://rubygems.org/gems/activemerchant/versions.atom"
+      },
+    }
+  end
+end