scout_apm 1.0.0 → 1.1.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80cec2f6800c7bd268f6d18d7eb56570dd755ccc
-  data.tar.gz: 102b7a884624afa4488fabbdcdafad92bdb390c8
+  metadata.gz: 6241efa65950ed1d898ba3d688c0d0e442ed4871
+  data.tar.gz: 166976b4a15c5e4481bb171abba5dcf2f155e70f
 SHA512:
-  metadata.gz: ef2d0df4bf7cc94e5f24122599f5cccb6bbfba95c12dcf7d6681c03469901b7c7f0a0b21cd3031103b2ed729a247421dc55b729308e2ac87db3bbb3e7c553319
-  data.tar.gz: e3f6369339505b4f0472fbbb676a4502cf0b4269e6e372bf55726d5357947ea8665ee98f5a68c924221942be80bcb1a5415e95189054b725c21054a377780bfa
+  metadata.gz: d0f7893d4df03ff5216bac6334ffa04e7e0bfa0e50e9eb14be6cb8a3d8e58b40afe140ed0691b3e324b311349119917f686f152e885dfbebbe20376c0d66c571
+  data.tar.gz: 4f6c3c86c84349989dfb406711a35791bd7d9f550b9139d67432fd7e37f512a9d879cfd7f08bbca6f8c30d9eb730fe8c469e7b7790138d87f02d0a25ce697993

data/lib/scout_apm.rb

@@ -74,6 +74,7 @@ require 'scout_apm/layaway'
 require 'scout_apm/layaway_file'
 require 'scout_apm/reporter'
 require 'scout_apm/background_worker'
+require 'scout_apm/bucket_name_splitter'
 require 'scout_apm/metric_meta'
 require 'scout_apm/metric_stats'
 require 'scout_apm/stack_item'
@@ -83,8 +84,10 @@ require 'scout_apm/context'
 require 'scout_apm/stackprof_tree_collapser'
 require 'scout_apm/slow_transaction'
 require 'scout_apm/capacity'
+require 'scout_apm/attribute_arranger'
 
 require 'scout_apm/serializers/payload_serializer'
+require 'scout_apm/serializers/payload_serializer_to_json'
 require 'scout_apm/serializers/directive_serializer'
 require 'scout_apm/serializers/app_server_load_serializer'
 require 'scout_apm/serializers/deploy_serializer'

data/lib/scout_apm/agent/reporting.rb

@@ -49,7 +49,13 @@ module ScoutApm
 
           logger.debug "Total payload [#{payload.size/1024} KB] for #{total_request_count} requests and Slow Transactions [#{slow_transactions_kb} KB] for #{slow_transactions.size} transactions of durations: #{slow_transactions.map(&:total_call_time).join(',')}."
 
-          response = reporter.report(payload)
+          if ScoutApm::Agent.instance.config.value("report_format") == 'json'
+            headers = {'Content-Type' => 'application/json'}
+          else
+            headers = {}
+          end
+
+          response = reporter.report(payload, headers)
 
           if response and response.is_a?(Net::HTTPSuccess)
             directives = ScoutApm::Serializers::DirectiveSerializer.deserialize(response.body)

data/lib/scout_apm/attribute_arranger.rb

@@ -0,0 +1,17 @@
+module ScoutApm
+  module AttributeArranger
+    # pass in an array of symbols to return as hash keys
+    # if the symbol doesn't match the name of the method, pass an array: [:key, :method_name]
+    def self.call(subject, attributes_list)
+      attributes_list.inject({}) do |attribute_hash, attribute|
+        case attribute
+        when Array
+          attribute_hash[attribute[0]] = subject.send(attribute[1])
+        when Symbol
+          attribute_hash[attribute] = subject.send(attribute)
+        end
+        attribute_hash
+      end
+    end
+  end
+end

data/lib/scout_apm/bucket_name_splitter.rb

@@ -0,0 +1,27 @@
+module ScoutApm
+  module BucketNameSplitter
+    def bucket
+      split_metric_name(metric_name).first
+    end
+
+    def name
+      split_metric_name(metric_name).last
+    end
+
+    def key
+      {:bucket => bucket, :name => name}
+    end
+
+    private
+    def split_metric_name(name)
+      name.to_s.split(/\//, 2)
+    end
+
+    def scope_hash
+      if scope
+        scope_bucket, scope_name = split_metric_name(scope)
+        {:bucket => scope_bucket, :name => scope_name}
+      end
+    end
+  end
+end

data/lib/scout_apm/context.rb

@@ -81,7 +81,7 @@ module ScoutApm
       value = key_value.values.last
       if !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
         ScoutApm::Agent.instance.logger.warn "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
-      false
+        false
       else
         true
       end

data/lib/scout_apm/metric_meta.rb

@@ -1,5 +1,7 @@
 # Contains the meta information associated with a metric. Used to lookup Metrics in to Store's metric_hash.
 class ScoutApm::MetricMeta
+  include ScoutApm::BucketNameSplitter
+
   def initialize(metric_name, options = {})
     @metric_name = metric_name
     @metric_id = nil
@@ -31,4 +33,10 @@ class ScoutApm::MetricMeta
   def eql?(o)
    self.class == o.class && metric_name.downcase.eql?(o.metric_name.downcase) && scope == o.scope && client_id == o.client_id && desc == o.desc
   end
+
+  def as_json
+    json_attributes = [:bucket, :name, :desc, :extra, [:scope, :scope_hash]]
+    # query, stack_trace
+    ScoutApm::AttributeArranger.call(self, json_attributes)
+  end
 end # class MetricMeta

data/lib/scout_apm/metric_stats.rb

@@ -46,4 +46,10 @@ class ScoutApm::MetricStats
   def to_json(*a)
      %Q[{"total_exclusive_time":#{total_exclusive_time*1000},"min_call_time":#{min_call_time*1000},"call_count":#{call_count},"sum_of_squares":#{sum_of_squares*1000},"total_call_time":#{total_call_time*1000},"max_call_time":#{max_call_time*1000}}]
   end
+
+  def as_json
+    json_attributes = [:call_count, :total_call_time, :total_exclusive_time, :min_call_time, :max_call_time]
+    # uri, context
+    ScoutApm::AttributeArranger.call(self, json_attributes)
+  end
 end # class MetricStats

data/lib/scout_apm/serializers/payload_serializer.rb

@@ -3,7 +3,11 @@ module ScoutApm
   module Serializers
     class PayloadSerializer
       def self.serialize(metadata, metrics, slow_transactions)
-        Marshal.dump(:metadata => metadata, :metrics => metrics, :slow_transactions => slow_transactions)
+        if ScoutApm::Agent.instance.config.value("report_format") == 'json'
+          ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, metrics, slow_transactions)
+        else
+          Marshal.dump(:metadata => metadata, :metrics => metrics, :slow_transactions => slow_transactions)
+        end
       end
 
       def self.deserialize(data)

data/lib/scout_apm/serializers/payload_serializer_to_json.rb

@@ -0,0 +1,67 @@
+module ScoutApm
+  module Serializers
+    module PayloadSerializerToJson
+      class << self
+        def serialize(metadata, metrics, slow_transactions)
+          rearranged_metrics = rearrange_the_metrics(metrics)
+          rearranged_slow_transactions = rearrange_the_slow_transactions(slow_transactions)
+          jsonify_hash({:metadata => metadata, :metrics => rearranged_metrics, :slow_transactions => rearranged_slow_transactions})
+        end
+
+        def rearrange_the_metrics(metrics)
+          metrics.to_a.map do |meta, stats|
+            stats.as_json.merge(key: meta.as_json)
+          end
+        end
+
+        def rearrange_the_slow_transactions(slow_transactions)
+          slow_transactions.to_a.map do |slow_t|
+            slow_t.as_json.merge(metrics: rearrange_the_metrics(slow_t.metrics))
+          end
+        end
+
+        def jsonify_hash(hash)
+          str_parts = []
+          hash.each do |key, value|
+            formatted_key = format_by_type(key)
+            formatted_value = format_by_type(value)
+            str_parts << "#{formatted_key}:#{formatted_value}"
+          end
+          "{#{str_parts.join(",")}}"
+        end
+
+        def escape(string)
+          string = string.to_s
+          escapers = {
+            '\b' => '\\b',
+            '\t' => '\\t',
+            '\n' => '\\n',
+            '\f' => '\\f',
+            '\r' => '\\r',
+            '"'  => '\\"',
+            '\\' => '\\\\'
+          }
+          # TODO escape control chars
+          escapers.each {|bad, good| string = string.gsub(bad, good)}
+          string
+        end
+
+        def format_by_type(formatee)
+          case formatee
+          when Hash
+            jsonify_hash(formatee)
+          when Array
+            all_the_elements = formatee.map {|value_guy| format_by_type(value_guy)}
+            "[#{all_the_elements.join(",")}]"
+          when Numeric
+            formatee
+          when nil
+            "null"
+          else # strings and everything
+            %Q["#{escape(formatee)}"]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/slow_transaction.rb

@@ -1,5 +1,7 @@
 module ScoutApm
   class SlowTransaction
+    include ScoutApm::BucketNameSplitter
+
     BACKTRACE_THRESHOLD = 0.5 # the minimum threshold to record the backtrace for a metric.
     BACKTRACE_LIMIT = 5 # Max length of callers to display
     MAX_SIZE = 100 # Limits the size of the metric hash to prevent a metric explosion.
@@ -45,5 +47,14 @@ module ScoutApm
       @metrics = nil
       self
     end
+
+    def as_json
+      json_attributes = [:key, :time, :total_call_time, :uri, [:context, :context_hash], :prof]
+      ScoutApm::AttributeArranger.call(self, json_attributes)
+    end
+
+    def context_hash
+      context.to_hash
+    end
   end
 end

data/lib/scout_apm/store.rb

@@ -150,7 +150,7 @@ module ScoutApm
                                                            parent_stat.total_call_time,
                                                            transaction_hash.dup,
                                                            ScoutApm::Context.current,
-                                                           Thread::current[:scout_apm_trace_time],
+                                                           Time.now,
                                                            Thread::current[:scout_apm_prof])
           @slow_transactions.push(slow_transaction)
           ScoutApm::Agent.instance.logger.debug "Slow transaction sample added. [URI: #{uri}] [Context: #{ScoutApm::Context.current.to_hash}] Array Size: #{@slow_transactions.size}"

data/lib/scout_apm/tracer.rb

@@ -22,7 +22,6 @@ module ScoutApm
         # TODO - wrap a lot of this into a Trace class, store that as a Thread var.
         ScoutApm::Agent.instance.store.reset_transaction!
         ScoutApm::Context.current.add_user(:ip => options[:ip]) if options[:ip]
-        Thread::current[:scout_apm_trace_time] = Time.now.utc
         ScoutApm::Agent.instance.capacity.start_transaction!
         e = nil
         instrument(metric_name, options) do
@@ -34,7 +33,6 @@ module ScoutApm
           end
           Thread::current[:scout_apm_scope_name] = nil
         end
-        Thread::current[:scout_apm_trace_time] = nil
         ScoutApm::Agent.instance.capacity.finish_transaction!
         # The context is cleared after instrumentation (rather than before) as tracing controller-actions doesn't occur until the controller-action is called.
         # It does not trace before filters, which is a likely spot to add context. This means that any context applied during before_filters would be cleared.

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.0.0"
+  VERSION = "1.1.0.pre1"
 end
 

data/test/unit/serializers/payload_serializer_test.rb

@@ -0,0 +1,212 @@
+require 'test_helper'
+require 'scout_apm/attribute_arranger'
+require 'scout_apm/bucket_name_splitter'
+require 'scout_apm/serializers/payload_serializer'
+require 'scout_apm/serializers/payload_serializer_to_json'
+require 'scout_apm/slow_transaction'
+require 'scout_apm/metric_meta'
+require 'scout_apm/metric_stats'
+require 'scout_apm/stackprof_tree_collapser'
+require 'scout_apm/utils/fake_stack_prof'
+require 'scout_apm/context'
+require 'ostruct'
+require 'json' # to deserialize what has been manually serialized by the production code
+
+# stub the report_format value
+class ScoutApm::Agent
+  module Config
+    def self.value(key)
+      'json'
+    end
+  end
+
+  def self.instance
+    OpenStruct.new(:config => Config)
+  end
+end
+
+class PayloadSerializerTest < Minitest::Test
+
+  def test_serializes_metadata_as_json
+    metadata = {
+      :app_root => "/srv/app/rootz",
+      :unique_id => "unique_idz",
+      :agent_version => 123
+    }
+    payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, {}, {})
+
+    # symbol keys turn to strings
+    formatted_metadata = {
+      "app_root" => "/srv/app/rootz",
+      "unique_id" => "unique_idz",
+      "agent_version" => 123
+    }
+    assert_equal formatted_metadata, JSON.parse(payload)["metadata"]
+  end
+
+  def test_serializes_metrics_as_json
+    metrics = {
+      ScoutApm::MetricMeta.new('ActiveRecord/all').tap { |meta|
+        meta.desc = "SELECT * from users where filter=?"
+        meta.extra = {user: 'cooluser'}
+        meta.metric_id = nil
+        meta.scope = "Controller/apps/checkin"
+      } => ScoutApm::MetricStats.new.tap { |stats|
+        stats.call_count = 16
+        stats.max_call_time = 0.005338062
+        stats.min_call_time = 0.000613518
+        stats.sum_of_squares = 9.8040860751126e-05
+        stats.total_call_time = 0.033245704
+        stats.total_exclusive_time = 0.033245704
+      },
+      ScoutApm::MetricMeta.new("Controller/apps/checkin").tap { |meta|
+        meta.desc = nil
+        meta.extra = {}
+        meta.metric_id = nil
+        meta.scope = nil
+      } => ScoutApm::MetricStats.new.tap { |stats|
+        stats.call_count = 2
+        stats.max_call_time = 0.078521419
+        stats.min_call_time = 0.034881757
+        stats.sum_of_squares = 0.007382350213180609
+        stats.total_call_time = 0.113403176
+        stats.total_exclusive_time = 0.07813208899999999
+      }
+    }
+    payload = ScoutApm::Serializers::PayloadSerializer.serialize({}, metrics, {})
+    formatted_metrics = [
+      {
+        "key" => {
+          "bucket" => "ActiveRecord",
+          "name" => "all",
+          "desc" => "SELECT * from users where filter=?",
+          "extra" => {
+            "user" => "cooluser",
+          },
+          "scope" => {
+            "bucket" => "Controller",
+            "name" => "apps/checkin",
+          },
+        },
+        "call_count" => 16,
+        "max_call_time" => 0.005338062,
+        "min_call_time" => 0.000613518,
+        "total_call_time" => 0.033245704,
+        "total_exclusive_time" => 0.033245704,
+      },
+      {
+        "key" => {
+          "bucket" => "Controller",
+          "name" => "apps/checkin",
+          "desc" => nil,
+          "extra" => {},
+          "scope" => nil,
+        },
+        "call_count" => 2,
+        "max_call_time" => 0.078521419,
+        "min_call_time" => 0.034881757,
+        "total_call_time" => 0.113403176,
+        "total_exclusive_time" => 0.07813208899999999,
+      }
+    ]
+    assert_equal formatted_metrics, JSON.parse(payload)["metrics"]
+  end
+
+  def test_serializes_slow_transactions_as_json
+    slow_transaction_metrics = {
+      ScoutApm::MetricMeta.new('ActiveRecord/all').tap { |meta|
+        meta.desc = "SELECT * from users where filter=?"
+        meta.extra = {user: 'cooluser'}
+        meta.metric_id = nil
+        meta.scope = "Controller/apps/checkin"
+      } => ScoutApm::MetricStats.new.tap { |stats|
+        stats.call_count = 16
+        stats.max_call_time = 0.005338062
+        stats.min_call_time = 0.000613518
+        stats.sum_of_squares = 9.8040860751126e-05
+        stats.total_call_time = 0.033245704
+        stats.total_exclusive_time = 0.033245704
+      },
+      ScoutApm::MetricMeta.new("Controller/apps/checkin").tap { |meta|
+        meta.desc = nil
+        meta.extra = {}
+        meta.metric_id = nil
+        meta.scope = nil
+      } => ScoutApm::MetricStats.new.tap { |stats|
+        stats.call_count = 2
+        stats.max_call_time = 0.078521419
+        stats.min_call_time = 0.034881757
+        stats.sum_of_squares = 0.007382350213180609
+        stats.total_call_time = 0.113403176
+        stats.total_exclusive_time = 0.07813208899999999
+      }
+    }
+    context = ScoutApm::Context.new
+    context.add({"this" => "that"})
+    context.add_user({"hello" => "goodbye"})
+    slow_t = ScoutApm::SlowTransaction.new("http://example.com/blabla", "Buckethead/something/else", 1.23, slow_transaction_metrics, context, Time.at(1448198788), StackProf.new)
+    payload = ScoutApm::Serializers::PayloadSerializer.serialize({}, {}, [slow_t])
+    formatted_slow_transactions = [
+      {
+        "key" => {
+          "bucket" => "Buckethead",
+          "name" => "something/else"
+        },
+        "time" => "2015-11-22 06:26:28 -0700",
+        "total_call_time" => 1.23,
+        "uri" => "http://example.com/blabla",
+        "context" => {"this"=>"that", "user"=>{"hello"=>"goodbye"}},
+        "prof" => [],
+        "metrics" => [
+          {
+            "key" => {
+              "bucket" => "ActiveRecord",
+              "name" => "all",
+              "desc" => "SELECT * from users where filter=?",
+              "extra" => {
+                "user" => "cooluser",
+              },
+              "scope" => {
+                "bucket" => "Controller",
+                "name" => "apps/checkin",
+              },
+            },
+            "call_count" => 16,
+            "max_call_time" => 0.005338062,
+            "min_call_time" => 0.000613518,
+            "total_call_time" => 0.033245704,
+            "total_exclusive_time" => 0.033245704,
+          },
+          {
+            "key" => {
+              "bucket" => "Controller",
+              "name" => "apps/checkin",
+              "desc" => nil,
+              "extra" => {},
+              "scope" => nil,
+            },
+            "call_count" => 2,
+            "max_call_time" => 0.078521419,
+            "min_call_time" => 0.034881757,
+            "total_call_time" => 0.113403176,
+            "total_exclusive_time" => 0.07813208899999999,
+          }
+        ]
+      }
+    ]
+    assert_equal formatted_slow_transactions, JSON.parse(payload)["slow_transactions"]
+  end
+
+  def test_escapes_json_quotes
+    metadata = {
+      :quotie => "here are some \"quotes\"",
+    }
+    payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, {}, {})
+
+    # symbol keys turn to strings
+    formatted_metadata = {
+      "quotie" => "here are some \"quotes\""
+    }
+    assert_equal formatted_metadata, JSON.parse(payload)["metadata"]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre1
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -71,7 +71,9 @@ files:
 - lib/scout_apm/agent/logging.rb
 - lib/scout_apm/agent/reporting.rb
 - lib/scout_apm/app_server_load.rb
+- lib/scout_apm/attribute_arranger.rb
 - lib/scout_apm/background_worker.rb
+- lib/scout_apm/bucket_name_splitter.rb
 - lib/scout_apm/capacity.rb
 - lib/scout_apm/config.rb
 - lib/scout_apm/context.rb
@@ -106,6 +108,7 @@ files:
 - lib/scout_apm/serializers/deploy_serializer.rb
 - lib/scout_apm/serializers/directive_serializer.rb
 - lib/scout_apm/serializers/payload_serializer.rb
+- lib/scout_apm/serializers/payload_serializer_to_json.rb
 - lib/scout_apm/server_integrations/null.rb
 - lib/scout_apm/server_integrations/passenger.rb
 - lib/scout_apm/server_integrations/puma.rb
@@ -133,6 +136,7 @@ files:
 - test/unit/config_test.rb
 - test/unit/environment_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
+- test/unit/serializers/payload_serializer_test.rb
 - test/unit/sql_sanitizer_test.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses: []
@@ -149,9 +153,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: scout_apm
 rubygems_version: 2.2.2
@@ -164,4 +168,5 @@ test_files:
 - test/unit/config_test.rb
 - test/unit/environment_test.rb
 - test/unit/instruments/active_record_instruments_test.rb
+- test/unit/serializers/payload_serializer_test.rb
 - test/unit/sql_sanitizer_test.rb