elastic-apm 1.0.0.beta2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21a3aac2c28d8806a3f8703746bc0cfb81620680c4daba5393bc27f88b15b213
-  data.tar.gz: 18faebc9de42ca039c12d5ce97791c51186d5bdabbf0276078a4906c415741dc
+  metadata.gz: 4c8a85fd85634ae33591a952d1a9833d6b2a7e828b36a366c5811f5d9116e901
+  data.tar.gz: 1bf462f1c2d14b015a2b52fc3dd510fad3fa642a14eb4b16f1aecca293bd25f7
 SHA512:
-  metadata.gz: 7fff60cded68fdac8b9b3dfdd0cbd88a2e7fc91007cfd80c78278281493c152ab0115e4145665e4b6bd3c946f4fd8956e5b4c4036a4bf14a6f7f1dd00024dce0
-  data.tar.gz: 7d87ef00a486b5bcc7d84f1c98ade6a3eb997f042685f608de3c6421762706ce20309aa8e1b6a9ac3a87b23f7d21a555ef9a5f87270ead7c0bb04290e87ea7d6
+  metadata.gz: 530ecf5853ada4749b8c7f0e14a1faa7bd37a5af3221082f3b00bca1f078a8c49e1fa55543f97183709207f5021a946333f8f7ccc91842781602fb1139418781
+  data.tar.gz: 57c299275b25b447378a3c73352082f171f75805183ed00f7ac2ba4ad7cbf2fe6a78dc1c5e4627ee40a7241177b8413f190d624e2a3b175a87446e66c68472a3

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
   Exclude:
     - 'elastic-apm.gemspec'
     - 'vendor/**/*'
+    - 'bench/*'
 
 Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation

data/CHANGELOG.md

@@ -4,18 +4,20 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 1.0.0.beta2 (2018-06-21)
+## 1.0.0 (2018-06-29)
 
 ### Added
 
 - Added config.disable_send ([#156](https://github.com/elastic/apm-agent-ruby/pulls/156))
 
+### Changed
+
+- Set the default `span_frame_min_duration` to 5ms
+
 ### Fixed
 
 - Fixed some Elasticsearch spans not validating JSON Schema ([#157](https://github.com/elastic/apm-agent-ruby/pulls/157))
 
-## 1.0.0.beta1 (2018-06-14)
-
 ## 0.8.0 (2018-06-13)
 
 ### Added

data/Gemfile

@@ -39,3 +39,8 @@ when /.+/
 else
   gem framework
 end
+
+group :bench do
+  gem 'ruby-prof', platforms: %i[ruby]
+  gem 'stackprof', platforms: %i[ruby]
+end

data/bench/.gitignore

@@ -0,0 +1,2 @@
+tmp/*
+db/*

data/bench/app.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+require 'elastic-apm'
+
+class App
+  module Helpers
+    def with_app(config = {})
+      app = App.new(config)
+      app.start
+      result = yield app
+      app.stop
+
+      result
+    end
+
+  end
+
+  def initialize(config = {})
+    @config = ElasticAPM::Config.new(
+      {
+        environment: 'bench',
+        enabled_environments: ['bench'],
+        disable_send: true
+      }.merge(config)
+    )
+    @serializer = ElasticAPM::Serializers::Transactions.new(@config)
+    @mock_env = Rack::MockRequest.env_for('/')
+  end
+
+  attr_reader :mock_env, :serializer
+
+  def start
+    @agent = ElasticAPM.start(@config)
+  end
+
+  def stop
+    ElasticAPM.stop
+  end
+end

data/bench/benchmark.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'benchmark'
+include Benchmark
+
+require 'rack/test'
+
+require './bench/app'
+include App::Helpers
+
+def perform(app, count: 1000)
+  app.start
+
+  transactions = count.times.map do |i|
+    ElasticAPM.transaction "Transaction##{i}",
+      context: ElasticAPM.build_context(app.mock_env) do
+      ElasticAPM.span('Number one') { 'ok 1' }
+      ElasticAPM.span('Number two') { 'ok 2' }
+      ElasticAPM.span('Number three') { 'ok 3' }
+    end
+  end
+
+  app.serializer.build_all(transactions)
+
+  app.stop
+end
+
+def avg(benchmarks)
+  [benchmarks.reduce(Tms.new(0), &:+) / benchmarks.length]
+end
+
+def banner(text)
+  puts "=== #{text}"
+end
+
+def do_bench(transaction_count: 10, **config)
+  puts "Count: #{transaction_count} transactions... \n \n"
+
+  bench = Benchmark.benchmark(CAPTION, 7, FORMAT, 'avg:') do |x|
+    benchmarks =
+      with_app(config) do |app|
+        10.times.map do |i|
+          x.report("run[#{i}]") { perform(app, count: transaction_count) }
+        end
+      end
+
+    avg(benchmarks)
+  end
+end
+
+transaction_count = Integer(ARGV.shift || 10)
+
+banner 'Default settings'
+do_bench transaction_count: transaction_count
+
+banner 'With transaction_sample_rate = 0'
+do_bench(transaction_count: transaction_count, transaction_sample_rate: 0)

data/bench/report.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Encoding.default_external = 'utf-8'
+
+require 'time'
+require 'bundler/setup'
+require 'faraday'
+require 'json'
+
+ELASTICSEARCH_URL = ENV.fetch('CLOUD_ADDR') { '' }.chomp
+if ELASTICSEARCH_URL == ''
+  puts 'ELASTICSEARCH_URL missing, exiting ...'
+  exit 1
+end
+
+input = STDIN.read.split("\n")
+puts input
+
+titles = input.grep(/^===/).map { |t| t.gsub(/^=== /, '') }
+counts = input.grep(/^Count: /).map { |a| a.gsub(/^Count: /, '').to_i }
+averages = input.grep(/^avg/).map { |a| a.match(/\((.+)\)/)[1].to_f }
+
+git_sha, git_date, git_msg = `git log -n 1 --pretty="format:%H|||%ai|||%s"`.split('|||')
+platform = Gem::Platform.local
+
+payloads = titles.zip(averages, counts).map do |(title, avg, count)|
+  {
+    title: title,
+    avg: avg,
+    transaction_count: count,
+    executed_at: Time.new.iso8601,
+    'git.commit' => git_sha,
+    'git.date' => Time.parse(git_date).iso8601,
+    'git.subject' => git_msg,
+    hostname: `hostname`.chomp,
+    engine: RUBY_ENGINE,
+    arch: platform.cpu,
+    os: platform.os,
+    ruby_version: RUBY_VERSION
+  }
+end
+
+puts '=== Reporting to ES'
+
+CONN = Faraday.new(url: ELASTICSEARCH_URL) do |f|
+  f.response :logger
+  f.adapter Faraday.default_adapter
+end
+
+payloads.each do |payload|
+  result = CONN.post('/benchmark-ruby/_doc') do |req|
+    req.headers['Content-Type'] = 'application/json'
+    req.body = payload.to_json
+  end
+
+  puts result.body unless (200...300).include?(result.status)
+end

data/bench/rubyprof.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'ruby-prof'
+require 'rack/test'
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+require 'elastic-apm'
+
+require './bench/app'
+include App::Helpers
+
+def perform(app, count: 1000)
+  app.start
+
+  transactions = count.times.map do |i|
+    ElasticAPM.transaction "Transaction##{i}",
+      context: ElasticAPM.build_context(app.mock_env) do
+      ElasticAPM.span('Number one') { 'ok 1' }
+      ElasticAPM.span('Number two') { 'ok 2' }
+      ElasticAPM.span('Number three') { 'ok 3' }
+    end
+  end
+
+  app.stop
+end
+
+def do_bench(transaction_count: 1000, **config)
+  with_app(config) do |app|
+    profile = RubyProf::Profile.new
+    profile.exclude_common_methods!
+    profile.start
+    perform(app, count: transaction_count)
+    profile.stop
+    printer = RubyProf::GraphHtmlPrinter.new(profile)
+    printer.print(File.open('bench/tmp/out.html', 'w'))
+  end
+end
+
+do_bench(transaction_count: 10_000)

data/bench/stackprof.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+Dir.chdir('./bench')
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'stackprof'
+require 'rack/test'
+require 'elastic-apm'
+
+ElasticAPM.start environment: 'bench', enabled_environments: ['bench']
+
+env = Rack::MockRequest.env_for('/')
+
+puts 'Running '
+profile = StackProf.run(mode: :cpu) do
+  10_000.times do
+    ElasticAPM.transaction 'Name', 'custom',
+      context: ElasticAPM.build_context(env) do
+      ElasticAPM.span 'Number one' do
+        'ok'
+      end
+      ElasticAPM.span 'Number two' do
+        'ok'
+      end
+      ElasticAPM.span 'Number three' do
+        'ok'
+      end
+    end
+  end
+end
+puts ''
+
+ElasticAPM.stop
+
+StackProf::Report.new(profile).print_text

data/docs/configuration.asciidoc

@@ -286,18 +286,18 @@ storage use in your Elasticsearch cluster.
 
 |============
 | Environment                            | `Config` key               | Default
-| `ELASTIC_APM_SPAN_FRAMES_MIN_DURATION` | `span_frames_min_duration` | `-1`
+| `ELASTIC_APM_SPAN_FRAMES_MIN_DURATION` | `span_frames_min_duration` | `5`
 |============
 
-In its default settings, the APM agent will collect a stack trace with every recorded span.
-While this is very helpful to find the exact place in your code that causes the span,
-collecting this stack trace does have some overhead.
+Use this to disable stacktrace collection for spans with a duration shorter than or equal to the given amount of milleseconds.
 
-With the default setting, `-1`, stack traces will be collected for all spans.
+The default is 5ms.
+
+Set it to `-1` to disable the feature and collect stack traces for all spans.
 Setting it to a positive value, e.g. `5`, will limit stack trace collection to spans
 with durations equal or longer than the given value in milliseconds, e.g. 5 milliseconds.
 
-To disable stack trace collection for spans completely, set the value to 0.
+To disable stack trace collection for spans completely, set the value to `0`.
 
 [float]
 [[config-max-queue-size]]

data/docs/custom-instrumentation.asciidoc

@@ -17,20 +17,18 @@ ElasticAPM includes some nifty helpers if you just want to instrument a regular
 
 [source,ruby]
 ----
-class ThingsController < ApplicationController
+class Thing
   include SpanHelpers
 
-  def index
-    @result = do_hard_work
+  def do_the_work
+    # ...
   end
+  span_method :do_hard_work # takes optional `name` and `type`
 
-  private
-
-  def do_hard_work
+  def self.do_all_the_work
     # ...
   end
-
-  span_method :do_hard_work # takes optional `name` and `type`
+  span_class_method :do_hard_work, 'Custom name', 'custom.work_thing'
 end
 ----
 

data/lib/elastic_apm/config.rb

@@ -39,7 +39,7 @@ module ElasticAPM
       source_lines_span_app_frames: 5,
       source_lines_error_library_frames: 0,
       source_lines_span_library_frames: 0,
-      span_frames_min_duration: -1,
+      span_frames_min_duration: 5,
 
       disabled_spies: %w[json],
 

data/lib/elastic_apm/normalizers.rb

@@ -44,7 +44,7 @@ module ElasticAPM # :nodoc:
       end
 
       def for(name)
-        @normalizers.fetch(name, @default)
+        @normalizers.fetch(name) { @default }
       end
 
       def keys

data/lib/elastic_apm/span_helpers.rb

@@ -5,11 +5,11 @@ module ElasticAPM
   module SpanHelpers
     # @api private
     module ClassMethods
-      def span_class_method(method, name, type)
+      def span_class_method(method, name = nil, type = nil)
         __span_method_on(singleton_class, method, name, type)
       end
 
-      def span_method(method, name, type)
+      def span_method(method, name = nil, type = nil)
         __span_method_on(self, method, name, type)
       end
 

data/lib/elastic_apm/spies.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'forwardable'
 require 'elastic_apm/util/inflector'
 
 module ElasticAPM

data/lib/elastic_apm/spies/mongo.rb

@@ -43,7 +43,7 @@ module ElasticAPM
             type: 'mongodb'.freeze,
             user: nil
           )
-          span = ElasticAPM.span(event.command_name, TYPE, context: ctx)
+          span = ElasticAPM.span(event.command_name.to_s, TYPE, context: ctx)
           @events[event.operation_id] = span
         end
 

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '1.0.0.beta2'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -42,6 +42,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bench/.gitignore
+- bench/app.rb
+- bench/benchmark.rb
+- bench/report.rb
+- bench/rubyprof.rb
+- bench/stackprof.rb
+- bench/tmp/.gitkeep
 - bin/build_docs
 - bin/console
 - bin/setup
@@ -135,9 +142,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6