elastic-apm 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2395fecd3ead993ac77f072d0b552e0814d2eb09ae985ba3d0b22e7168a9f005
-  data.tar.gz: 20e07d3f8444b83bc424de8b7772547c41eba90ac8561d406599cfb36854ebd9
+  metadata.gz: 11b66b86db45e066da0c6055bd5cb58894a5ba0eca8fb9d891b5b918fcd8d7c0
+  data.tar.gz: 87bfdbcc9b57f128f032d8e617dfe4540fcf8afeea91f80621d5e1a6b476d47e
 SHA512:
-  metadata.gz: 341eff39abd1c021aaa61967a56482ada41ac9d94f6dda54a2b480cbaff2844768ffaea7c54c8e2781211cf8209a2b8309631a3360b63bad15c7554fa9705ca6
-  data.tar.gz: 4158a60e93bd55f6cd28274e734943e1f5984c4ce963be7ad65be8fa508419f92227e18e12cc46c6813793f4b8baf490bdd52eb240e1a6c6f567057fe254a7ee
+  metadata.gz: a514f4463ee2294d1e825fd9ba0b42a764d8380e9ea4ba90254acf92ebd7ffec8d4f2a329a77307732e7206a22009c3cb91218650e499235d8ca2cae3cf1d8ae
+  data.tar.gz: 93e558bab35f323f77116031333ce065fa00b101871ea80e913b082612552857dadc9074c6c4219bf97010eddc6b9abc996fa2dac68454aed1dcb91048c9bd6c

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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).
 
+## 2.8.1 (2019-05-29)
+
+### Fixed
+
+- Database statements are properly truncated ([#431](https://github.com/elastic/apm-agent-ruby/pull/431))
+
 ## 2.8.0 (2019-05-20)
 
 ### Added

data/Gemfile

@@ -6,7 +6,6 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
-gem 'pry'
 gem 'rack-test'
 gem 'rspec'
 gem 'rspec-its'
@@ -16,6 +15,7 @@ gem 'webmock'
 
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
+gem 'faraday', require: nil
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
@@ -45,6 +45,8 @@ else
   gem framework
 end
 
+gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+
 unless version =~ /^(master|6)/
   gem 'delayed_job', require: nil
 end

data/Jenkinsfile

@@ -32,7 +32,7 @@ pipeline {
     quietPeriod(10)
   }
   triggers {
-    issueCommentTrigger('.*(?:jenkins\\W+)?run\\W+(?:the\\W+)?tests(?:\\W+please)?.*')
+    issueCommentTrigger('(?i).*(?:jenkins\\W+)?run\\W+(?:the\\W+)?tests(?:\\W+please)?.*')
   }
   parameters {
     booleanParam(name: 'Run_As_Master_Branch', defaultValue: false, description: 'Allow to run any steps on a PR, some steps normally only run on master branch.')
@@ -266,6 +266,10 @@ def runBenchmark(version){
           } catch(e){
             throw e
           } finally {
+            archiveArtifacts(
+              allowEmptyArchive: true, 
+              artifacts: "**/benchmark-${transformedVersion}.raw,**/benchmark-${transformedVersion}.error", 
+              onlyIfSuccessful: false)
             sendBenchmarks(file: "benchmark-${transformedVersion}.bulk",
               index: "benchmark-ruby", archive: true)
           }

data/bench/app.rb

@@ -1,39 +1,53 @@
+#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+require 'active_record'
+require 'action_controller/railtie'
 require 'elastic-apm'
+require 'elastic_apm/railtie'
 
-class App
-  module Helpers
-    def with_app(config = {})
-      app = App.new(config)
-      app.start
-      result = yield app
-      app.stop
+$log = Logger.new('/tmp/bench.log')
 
-      result
-    end
+ActiveRecord::Base.logger = $log
 
-  end
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: '/tmp/bench.sqlite3')
 
-  def initialize(config = {})
-    @config = ElasticAPM::Config.new(
-      {
-        environment: 'bench',
-        disable_send: true
-      }.merge(config)
-    )
-    # @serializer = ElasticAPM::Serializers::Transactions.new(@config)
-    @mock_env = Rack::MockRequest.env_for('/')
+ActiveRecord::Schema.define do
+  create_table :posts, force: true do |t|
+    t.string :title
+    t.timestamps
   end
+end
 
-  attr_reader :mock_env, :serializer
+class Post < ActiveRecord::Base
+end
 
-  def start
-    @agent = ElasticAPM.start(@config)
+10.times { |i| Post.create! title: "Post #{i}" }
+
+class ApplicationController < ActionController::Base
+  def index
+    render inline: '<%= Post.pluck(:title).join(", ") %>'
   end
 
-  def stop
-    ElasticAPM.stop
+  def favicon
+    render nothing: true
   end
 end
+
+class App < Rails::Application
+  config.secret_key_base = '__secret'
+  config.logger = $log
+  config.eager_load = false
+
+  config.elastic_apm.disable_send = true
+  config.elastic_apm.logger = $log
+  config.elastic_apm.log_level = Logger::DEBUG
+end
+
+App.initialize!
+
+App.routes.draw do
+  get '/favicon.ico', to: 'application#favicon'
+  root to: 'application#index'
+end

data/bench/benchmark.rb

@@ -1,64 +1,36 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+ENV['RAILS_ENV'] = 'production'
+
+require 'bundler'
 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
+def app
+  App
 end
 
-def avg(benchmarks)
-  [benchmarks.reduce(Tms.new(0), &:+) / benchmarks.length]
-end
+include Rack::Test::Methods
 
-def banner(text)
-  puts "=== #{text}"
+def perform
+  10_000.times do
+    get '/'
+  end
 end
 
-def do_bench(transaction_count: 10, **config)
-  puts "Count: #{transaction_count} transactions... \n \n"
+bench = Benchmark.benchmark(CAPTION, 15, FORMAT) do |b|
+  perform # warm up
 
-  bench = Benchmark.benchmark(CAPTION, 7, FORMAT, 'avg:') do |x|
-    benchmarks =
-      with_app(config) do |app|
-        # warm-up
-        puts "1 run of warm-up"
-        perform(app, count: transaction_count)
+  b.report('with agent:') { perform }
 
-        5.times.map do |i|
-          x.report("run[#{i}]") { perform(app, count: transaction_count) }
-        end
-      end
+  ElasticAPM.stop
+  perform # warm up
 
-    avg(benchmarks)
-  end
+  b.report('without agent:') { perform }
 end
-
-transaction_count = Integer(ARGV.shift || 100_000)
-
-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

@@ -1,46 +1,55 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-Encoding.default_external = 'utf-8'
-
 require 'time'
-require 'bundler/setup'
 require 'json'
 
 input = STDIN.read.split("\n")
-STDERR.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_msg = `git log -n 1 --pretty="format:%H|||%s"`.split('|||')
 git_date = `git log -n 1 --pretty="format:%ai"`
 platform = Gem::Platform.local
 
-payloads = titles.zip(averages, counts).map do |(title, avg, count)|
-  return nil unless avg
-
-  {
-    title: title,
-    avg: avg,
-    transaction_count: count,
-    executed_at: Time.new.iso8601,
-    'git.commit' => git_sha,
-    'git.date' => String(git_date).strip != '' && Time.parse(git_date).iso8601,
-    'git.subject' => git_msg,
-    hostname: `hostname`.chomp,
-    engine: RUBY_ENGINE,
-    arch: platform.cpu,
-    os: platform.os,
-    ruby_version: "#{RUBY_ENGINE == 'jruby' ? 'j' : ''}#{RUBY_VERSION}"
-  }
-end.compact
-
-STDERR.puts '=== Reporting to ES'
-STDERR.puts payloads.inspect
-
-payloads.each do |payload|
-  puts '{ "index" : { "_index" : "benchmark-ruby", "_type" : "_doc" } }'
-  puts payload.to_json
+def doc(payload)
+  puts({ index: { _index: "benchmark-ruby", _type: "_doc" } }.to_json)
+  puts(payload.to_json)
 end
+
+meta = {
+  executed_at: Time.new.iso8601,
+  'git.commit' => git_sha,
+  'git.date' => String(git_date).strip != '' && Time.parse(git_date).iso8601,
+  'git.subject' => git_msg,
+  hostname: `hostname`.chomp,
+  engine: RUBY_ENGINE,
+  arch: platform.cpu,
+  os: platform.os,
+  ruby_version: "#{RUBY_ENGINE == 'jruby' ? 'j' : ''}#{RUBY_VERSION}"
+}
+
+results =
+  input
+  .grep(/^with/)
+  .map do |line|
+    title = line.match(/^(.*):/) { |m| m[1] }
+    user, system, total, real = line.scan(/[0-9\.]+/).map(&:to_f)
+    meta.merge(
+      title: title,
+      user: user,
+      system: system,
+      total: total,
+      real: real,
+    )
+  end
+
+results.each { |result| doc result }
+
+overhead =
+  (results[0][:total] - results[1][:total]) *
+  1000 /  # milliseconds
+  10_000     # transactions
+
+doc meta.merge(
+  title: 'overhead',
+  overhead: overhead
+)

data/bench/stackprof.rb

@@ -1,36 +1,23 @@
+#!/usr/bin/env ruby
 # 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'
+require './bench/app'
 
-env = Rack::MockRequest.env_for('/')
+def app
+  App
+end
+
+include Rack::Test::Methods
 
 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
+    get '/'
   end
 end
 puts ''
 
-ElasticAPM.stop
-
 StackProf::Report.new(profile).print_text

data/docs/configuration.asciidoc

@@ -579,6 +579,18 @@ It has to be provided in *<<config-format-duration, duration format>>*.
 
 The path to a custom CA certificate for connecting to APM Server.
 
+[float]
+[[config-stack-trace-limit]]
+==== `stack_trace_limit`
+
+[options="header"]
+|============
+| Environment                     | `Config` key        | Default
+| `ELASTIC_APM_STACK_TRACE_LIMIT` | `stack_trace_limit` | `999999`
+|============
+
+The maximum number of stack trace lines per span/error.
+
 [float]
 [[config-transaction-max-spans]]
 ==== `transaction_max_spans`

data/docs/debugging.asciidoc

@@ -0,0 +1,30 @@
+[[debugging]]
+== Debugging the agent itself
+
+Hopefully the agent Just Works™, but depending on your situation the agent might need some tuning.
+
+First, to learn more about what's going on inside the agent, you can increase the amount of log messages it writes. To do this, set the log level with the option `log_level = 0` -- `0` being the level of most messages, `DEBUG`.
+
+In your `config/elastic_apm.yml`:
+
+[source,yaml]
+----
+log_level: <%= Logger::DEBUG %>
+----
+
+[float]
+[[debugging-log-messages]]
+=== Log messages
+
+[float]
+[[debugging-errors-queue-full]]
+==== `Queue is full (256 items), skipping…`
+
+The agent has an internal queue that holds events after they are done, and before they are safely serialized and sent to APM Server. To avoid using up all of your memory, this queue has a fixed size. Depending on your load and server setup, events may be added to the queue faster than they are consumed, hence the warning.
+
+Things to consider:
+
+  - Is `server_url` misconfigured or APM Server down? If the agent fails to connect you will also see log messages containing `Connection error` or `Couldn't establish connection to APM Server`.
+  - Experiencing high load? The agent can spawn multiple instances of its Workers that pick off the queue by changing the option `pool_size` (default is `1`).
+  - If you have high load you may also consider setting `transaction_sample_rate` to something smaller than `1.0`. This determines whether to include _spans_ for every _transaction_. If you have enough traffic, skipping some (probably) identical spans won't have a noticeable effect on your data.
+

data/docs/index.asciidoc

@@ -26,5 +26,7 @@ include::./supported-technologies.asciidoc[]
 
 include::./api.asciidoc[]
 
+include::./debugging.asciidoc[]
+
 include::./release-notes.asciidoc[]
 

data/lib/elastic_apm/config.rb

@@ -403,7 +403,7 @@ module ElasticAPM
     end
 
     def set_rails(app) # rubocop:disable Metrics/AbcSize
-      self.service_name ||= format_name(service_name || app.class.parent_name)
+      self.service_name ||= format_name(service_name || rails_app_name(app))
       self.framework_name ||= 'Ruby on Rails'
       self.framework_version ||= Rails::VERSION::STRING
       self.logger ||= Rails.logger
@@ -412,6 +412,14 @@ module ElasticAPM
       self.view_paths = app.config.paths['app/views'].existent
     end
 
+    def rails_app_name(app)
+      if Rails::VERSION::MAJOR >= 6
+        app.class.module_parent_name
+      else
+        app.class.parent_name
+      end
+    end
+
     def build_logger
       logger = Logger.new(log_path == '-' ? STDOUT : log_path)
       logger.level = log_level

data/lib/elastic_apm/sql_summarizer.rb

@@ -6,7 +6,7 @@ module ElasticAPM
   # @api private
   class SqlSummarizer
     DEFAULT = 'SQL'
-    TABLE_REGEX = %{["'`]?([A-Za-z0-9_]+)}
+    TABLE_REGEX = %{["'`]?([A-Za-z0-9_]+)["'`]?}
 
     REGEXES = {
       /^BEGIN/i => 'BEGIN',
@@ -26,7 +26,7 @@ module ElasticAPM
     def summarize(sql)
       self.class.cache[sql] ||=
         REGEXES.find do |regex, sig|
-          if (match = sql.match(regex))
+          if (match = sql[0...1000].match(regex))
             break format(FORMAT, sig, match[1] && match[1].gsub(/["']/, ''))
           end
         end || DEFAULT

data/lib/elastic_apm/transport/serializers/span_serializer.rb

@@ -50,7 +50,7 @@ module ElasticAPM
 
             {
               instance: db.instance,
-              statement: db.statement,
+              statement: Util.truncate(db.statement, max_length: 10_000),
               type: db.type,
               user: db.user
             }

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '2.8.0'
+  VERSION = '2.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -73,6 +73,7 @@ files:
 - docs/configuration.asciidoc
 - docs/context.asciidoc
 - docs/custom-instrumentation.asciidoc
+- docs/debugging.asciidoc
 - docs/getting-started-rack.asciidoc
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc