elastic-apm 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e445ae7019c027e5e0b9e18aeb36b6bb646c650175d32389dee1cfafe2a274bc
-  data.tar.gz: d5868c15d2844076b6abea3ce55c90e10183cfba812116bc95293a26f09dfad5
+  metadata.gz: 5cf86b8835f2524fc990aad795d4f2f4fc8a4ed3c3742436649f5ceb44b96c82
+  data.tar.gz: c0a0a828cdd4f4eb0306131bb5b12d423e519bd57c0f19420928299505c08f03
 SHA512:
-  metadata.gz: 77fe20eda7fe120cbe7a4ff6b295cc5e5229a3f08be1373c9a4b5196a9dd355d48932acc157999ce1f4e8af777938054412bb3de9af2cd6bcf4ddca23058e8d4
-  data.tar.gz: a3c1627c60684229f7aae7379910d8ef21799ed7e05923e86cca819d7a77f4c85a43f31c003713dcafd84694d60fd474f084d7329ebaae0330a7f43c27c3508b
+  metadata.gz: b404e23f7056ece4ee3603a91e3d1f95894fb0ed62a32e7bbccf8a83ed462e17afc99073fa36ef317e430a13dce343396e1059a28b1d03c4497070f992e4133f
+  data.tar.gz: 667f2932cf52bd2eaeeb4dbdd7c37fb183ab9e78f49eafa7dfa004f16b3361dd9d71183648ab40aee996d9e4c04d8f789298acc872de2f532173ab579eb4882e

data/CHANGELOG.md

@@ -4,20 +4,28 @@ 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).
 
-## Unreleased
+## 1.0.2 (2018-09-07)
 
+### Added
+
+- Rake task instrumentation ([#192](https://github.com/elastic/apm-agent-ruby/pull/192))
+- `default_tags` option ([#183](https://github.com/elastic/apm-agent-ruby/pull/183))
+
+### Fixed
+
+- Fallback from missing JRUBY_VERSION ([#180](https://github.com/elastic/apm-agent-ruby/pull/180))
 
 ## 1.0.1 (2018-07-30)
 
 ### Fixed
 
-- Fixed internal LRU cache to be threadsafe ([#178](https://github.com/elastic/apm-agent-ruby/pulls/178))
+- Fixed internal LRU cache to be threadsafe ([#178](https://github.com/elastic/apm-agent-ruby/pull/178))
 
 ## 1.0.0 (2018-06-29)
 
 ### Added
 
-- Added config.disable_send ([#156](https://github.com/elastic/apm-agent-ruby/pulls/156))
+- Added config.disable_send ([#156](https://github.com/elastic/apm-agent-ruby/pull/156))
 
 ### Changed
 
@@ -25,14 +33,14 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### Fixed
 
-- Fixed some Elasticsearch spans not validating JSON Schema ([#157](https://github.com/elastic/apm-agent-ruby/pulls/157))
+- Fixed some Elasticsearch spans not validating JSON Schema ([#157](https://github.com/elastic/apm-agent-ruby/pull/157))
 
 ## 0.8.0 (2018-06-13)
 
 ### Added
 
-- Added an option to disable metrics collection ([#145](https://github.com/elastic/apm-agent-ruby/pulls/145))
-- Filters can cancel the entire payload by returning `nil` ([#148](https://github.com/elastic/apm-agent-ruby/pulls/148))
+- Added an option to disable metrics collection ([#145](https://github.com/elastic/apm-agent-ruby/pull/145))
+- Filters can cancel the entire payload by returning `nil` ([#148](https://github.com/elastic/apm-agent-ruby/pull/148))
 - Added `ENV` version of the logging options ([#146](https://github.com/elastic/apm-agent-ruby/pull/146))
 - Added `config.ignore_url_patterns` ([#151](https://github.com/elastic/apm-agent-ruby/pull/151))
 

data/Gemfile

@@ -12,6 +12,7 @@ gem 'json-schema'
 gem 'mongo'
 gem 'pry'
 gem 'rack-test'
+gem 'rake'
 gem 'redis', require: nil
 gem 'rspec'
 gem 'rubocop'

data/bench/benchmark.rb

@@ -42,7 +42,11 @@ def do_bench(transaction_count: 10, **config)
   bench = Benchmark.benchmark(CAPTION, 7, FORMAT, 'avg:') do |x|
     benchmarks =
       with_app(config) do |app|
-        10.times.map do |i|
+        # warm-up
+        puts "1 run of warm-up"
+        perform(app, count: transaction_count)
+
+        5.times.map do |i|
           x.report("run[#{i}]") { perform(app, count: transaction_count) }
         end
       end
@@ -51,7 +55,7 @@ def do_bench(transaction_count: 10, **config)
   end
 end
 
-transaction_count = Integer(ARGV.shift || 10_000)
+transaction_count = Integer(ARGV.shift || 100_000)
 
 banner 'Default settings'
 do_bench transaction_count: transaction_count

data/bench/report.rb

@@ -13,8 +13,10 @@ if ELASTICSEARCH_URL == ''
   puts 'ELASTICSEARCH_URL missing, exiting ...'
   exit 1
 else
-  # debug
-  # puts ELASTICSEARCH_URL.gsub(/:[^\/]+(.*)@/) { |m| ":#{Array.new(m.length - 2).map { '*' }.join}@" }
+  # DEBUG
+  # puts ELASTICSEARCH_URL.gsub(/:[^\/]+(.*)@/) do |m|
+  #   ":#{Array.new(m.length - 2).map { '*' }.join}@"
+  # end
 end
 
 CONN = Faraday.new(url: ELASTICSEARCH_URL) do |f|
@@ -35,30 +37,31 @@ 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('|||')
-git_date ||= Time.new.iso8601
-git_branch = `git branch | grep '\*' | awk '{print $2}'`
+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' => Time.parse(git_date).iso8601,
+    'git.date' => String(git_date).strip != '' && Time.parse(git_date).iso8601,
     'git.subject' => git_msg,
-    'git.branch' => git_branch,
     hostname: `hostname`.chomp,
     engine: RUBY_ENGINE,
     arch: platform.cpu,
     os: platform.os,
-    ruby_version: RUBY_VERSION
+    ruby_version: "#{RUBY_ENGINE == 'jruby' ? 'j' : ''}#{RUBY_VERSION}"
   }
-end
+end.compact
 
 puts '=== Reporting to ES'
+puts payloads.inspect
 
 payloads.each do |payload|
   result = CONN.post('/benchmark-ruby/_doc') do |req|

data/docs/api.asciidoc

@@ -208,6 +208,8 @@ Arguments:
 
 Returns the set `value`.
 
+WARNING: Be aware that tags are indexed in Elasticsearch. Using too many unique keys will result in *https://www.elastic.co/blog/found-crash-elasticsearch#mapping-explosion[Mapping explosion]*.
+
 [float]
 [[api-agent-set-custom-context]]
 ==== `ElasticAPM.set_custom_context`

data/docs/configuration.asciidoc

@@ -389,6 +389,32 @@ Use this option to disable any of these.
 
 Get an array of enabled spies with `ElasticAPM.agent.config.enabled_spies`.
 
+[float]
+[[config-instrumented-rake-tasks]]
+==== `instrumented_rake_tasks`
+
+[options="header"]
+|============
+| Environment                           | `Config` key              | Default | Example
+| `ELASTIC_APM_INSTRUMENTED_RAKE_TASKS` | `instrumented_rake_tasks` | `[]`    | `['my_task']`
+|============
+
+Elastic APM can instrument your Rake tasks but given that they are used for a multitude of sometimes very different and not always relevant things, this is opt in.
+
+[float]
+[[config-default-tags]]
+==== `default_tags`
+
+[options="header"]
+|============
+| Environment                | `Config` key   | Default | Example
+| `ELASTIC_APM_DEFAULT_TAGS` | `default_tags` | `{}`    | `region=us1`
+|============
+
+Add default tags to add to every transaction.
+
+WARNING: Be aware that tags are indexed in Elasticsearch. Using too many unique keys will result in *https://www.elastic.co/blog/found-crash-elasticsearch#mapping-explosion[Mapping explosion]*.
+
 [float]
 [[config-custom-key-filters]]
 ==== `custom_key_filters`

data/docs/index.asciidoc

@@ -5,7 +5,7 @@ ifdef::env-github[]
 NOTE: For the best reading experience, please view this documentation at https://www.elastic.co/guide/en/apm/agent/ruby[elastic.co]
 endif::[]
 
-= APM Ruby Agent Reference (Beta)
+= APM Ruby Agent Reference
 
 [[introduction]]
 == Introduction
@@ -31,6 +31,7 @@ include::./configuration.asciidoc[]
 == Advanced Topics
 include::./context.asciidoc[]
 include::./custom-instrumentation.asciidoc[]
+include::./troubleshooting.asciidoc[]
 
 include::./api.asciidoc[]
 

data/docs/troubleshooting.asciidoc

@@ -0,0 +1,28 @@
+[[debugging]]
+=== Debugging APM
+
+The agent not working for you? There are a few settings that might help:
+
+[float]
+[[debugging-debug-transactions]]
+==== `debug_transactions`
+
+[options="header"]
+|============
+| Environment                      | `Config` key         | Default
+| `ELASTIC_APM_DEBUG_TRANSACTIONS` | `debug_transactions` | `false`
+|============
+
+When on, Elastic APM will log a summary of each transaction when submitted.
+
+[float]
+[[debugging-debug-http]]
+==== `debug_http`
+
+[options="header"]
+|============
+| Environment              | `Config` key | Default
+| `ELASTIC_APM_DEBUG_HTTP` | `debug_http` | `false`
+|============
+
+When on, Elastic APM will log debug information from all the requests it makes to APM Server.

data/lib/elastic_apm/agent.rb

@@ -132,12 +132,24 @@ module ElasticAPM
       instrumenter.current_transaction
     end
 
-    def transaction(*args, &block)
-      instrumenter.transaction(*args, &block)
+    def transaction(name = nil, type = nil, context: nil, sampled: nil, &block)
+      instrumenter.transaction(
+        name,
+        type,
+        context: context,
+        sampled: sampled,
+        &block
+      )
     end
 
-    def span(*args, &block)
-      instrumenter.span(*args, &block)
+    def span(name, type = nil, backtrace: nil, context: nil, &block)
+      instrumenter.span(
+        name,
+        type,
+        backtrace: backtrace,
+        context: context,
+        &block
+      )
     end
 
     def build_context(rack_env)
@@ -167,16 +179,16 @@ module ElasticAPM
 
     # context
 
-    def set_tag(*args)
-      instrumenter.set_tag(*args)
+    def set_tag(key, value)
+      instrumenter.set_tag(key, value)
     end
 
-    def set_custom_context(*args)
-      instrumenter.set_custom_context(*args)
+    def set_custom_context(context)
+      instrumenter.set_custom_context(context)
     end
 
-    def set_user(*args)
-      instrumenter.set_user(*args)
+    def set_user(user)
+      instrumenter.set_user(user)
     end
 
     def add_filter(key, callback)

data/lib/elastic_apm/config.rb

@@ -42,6 +42,9 @@ module ElasticAPM
       span_frames_min_duration: 5,
 
       disabled_spies: %w[json],
+      instrumented_rake_tasks: [],
+
+      default_tags: {},
 
       current_user_id_method: :id,
       current_user_email_method: :email,
@@ -95,7 +98,11 @@ module ElasticAPM
       'ELASTIC_APM_TRANSACTION_MAX_SPANS' => [:int, 'transaction_max_spans'],
 
       'ELASTIC_APM_DISABLE_SEND' => [:bool, 'disable_send'],
-      'ELASTIC_APM_DISABLED_SPIES' => [:list, 'disabled_spies']
+      'ELASTIC_APM_DISABLED_SPIES' => [:list, 'disabled_spies'],
+      'ELASTIC_APM_INSTRUMENTED_RAKE_TASKS' =>
+        [:list, 'instrumented_rake_tasks'],
+
+      'ELASTIC_APM_DEFAULT_TAGS' => [:dict, 'default_tags']
     }.freeze
 
     def initialize(options = {})
@@ -153,6 +160,7 @@ module ElasticAPM
     attr_accessor :span_frames_min_duration
 
     attr_accessor :disabled_spies
+    attr_accessor :instrumented_rake_tasks
 
     attr_accessor :view_paths
     attr_accessor :root_path
@@ -162,12 +170,14 @@ module ElasticAPM
     attr_accessor :current_user_email_method
     attr_accessor :current_user_username_method
 
+    attr_accessor :default_tags
+
     attr_reader   :custom_key_filters
     attr_reader   :ignore_url_patterns
 
     alias :disable_environment_warning? :disable_environment_warning
-    alias :verify_server_cert? :verify_server_cert
     alias :disable_send? :disable_send
+    alias :verify_server_cert? :verify_server_cert
 
     def app=(app)
       case app_type?(app)
@@ -182,7 +192,7 @@ module ElasticAPM
     end
 
     def app_type?(app)
-      if defined?(::Rails) && app.is_a?(Rails::Application)
+      if defined?(Rails::Application) && app.is_a?(Rails::Application)
         return :rails
       end
 
@@ -219,6 +229,7 @@ module ElasticAPM
         sidekiq
         sinatra
         tilt
+        rake
       ]
     end
     # rubocop:enable Metrics/MethodLength
@@ -252,6 +263,7 @@ module ElasticAPM
           when :float then value.to_f
           when :bool then !%w[0 false].include?(value.strip.downcase)
           when :list then value.split(/[ ,]/)
+          when :dict then Hash[value.split('&').map { |kv| kv.split('=') }]
           else value
           end
 

data/lib/elastic_apm/context.rb

@@ -14,9 +14,9 @@ module ElasticAPM
     attr_accessor :request, :response, :user
     attr_reader :custom, :tags
 
-    def initialize
-      @custom = {}
-      @tags = {}
+    def initialize(custom: {}, tags: {})
+      @custom = custom
+      @tags = tags
     end
   end
 end

data/lib/elastic_apm/filters/secrets_filter.rb

@@ -48,11 +48,11 @@ module ElasticAPM
       end
 
       def filter_key?(key)
-        @key_filters.any? { |regex| key =~ regex }
+        @key_filters.any? { |regex| key.match regex }
       end
 
       def filter_value?(value)
-        VALUE_FILTERS.any? { |regex| value =~ regex }
+        VALUE_FILTERS.any? { |regex| value.match regex }
       end
     end
   end

data/lib/elastic_apm/instrumenter.rb

@@ -55,9 +55,9 @@ module ElasticAPM
       @transaction_info.current = transaction
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    def transaction(*args)
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def transaction(name = nil, type = nil, context: nil, sampled: nil)
       unless config.instrument
         yield if block_given?
         return
@@ -68,13 +68,10 @@ module ElasticAPM
         return transaction
       end
 
-      if args.last.is_a? Hash
-        args.last[:sampled] = random_sample?
-      else
-        args.push(sampled: random_sample?)
-      end
+      sampled = random_sample? if sampled.nil?
 
-      transaction = Transaction.new self, *args
+      transaction =
+        Transaction.new self, name, type, context: context, sampled: sampled
 
       self.current_transaction = transaction
       return transaction unless block_given?
@@ -88,21 +85,29 @@ module ElasticAPM
 
       transaction
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength
 
     def random_sample?
       rand <= config.transaction_sample_rate
     end
 
-    def span(*args, &block)
+    # rubocop:disable Metrics/MethodLength
+    def span(name, type = nil, backtrace: nil, context: nil, &block)
       unless current_transaction
         return yield if block_given?
         return
       end
 
-      current_transaction.span(*args, &block)
+      current_transaction.span(
+        name,
+        type,
+        backtrace: backtrace,
+        context: context,
+        &block
+      )
     end
+    # rubocop:enable Metrics/MethodLength
 
     def set_tag(key, value)
       return unless current_transaction

data/lib/elastic_apm/middleware.rb

@@ -16,7 +16,8 @@ module ElasticAPM
 
         resp = @app.call env
 
-        submit_transaction(transaction, *resp) if transaction
+        status, headers, body = resp
+        submit_transaction(transaction, status, headers, body) if transaction
       rescue InternalError
         raise # Don't report ElasticAPM errors
       rescue ::Exception => e
@@ -38,7 +39,7 @@ module ElasticAPM
 
     def path_ignored?(env)
       config.ignore_url_patterns.any? do |r|
-        env['PATH_INFO'] =~ r
+        env['PATH_INFO'].match r
       end
     end
 

data/lib/elastic_apm/normalizers/active_record.rb

@@ -10,7 +10,7 @@ module ElasticAPM
         register 'sql.active_record'
 
         def initialize(*args)
-          super(*args)
+          super
 
           @type = format('db.%s.sql', lookup_adapter || 'unknown').freeze
           @summarizer = SqlSummarizer.new

data/lib/elastic_apm/serializers/errors.rb

@@ -30,7 +30,7 @@ module ElasticAPM
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       def build_all(errors)
-        { errors: Array(errors).map(&method(:build)) }
+        { errors: Array(errors).map { |e| build(e) } }
       end
 
       private

data/lib/elastic_apm/serializers/transactions.rb

@@ -13,7 +13,7 @@ module ElasticAPM
           result: transaction.result.to_s,
           duration: ms(transaction.duration),
           timestamp: micros_to_time(transaction.timestamp).utc.iso8601(3),
-          spans: transaction.spans.map(&method(:build_span)),
+          spans: transaction.spans.map { |s| build_span(s) },
           sampled: transaction.sampled,
           context: transaction.context.to_h
         }
@@ -27,7 +27,7 @@ module ElasticAPM
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       def build_all(transactions)
-        { transactions: Array(transactions).map(&method(:build)) }
+        { transactions: Array(transactions).map { |t| build(t) } }
       end
 
       private

data/lib/elastic_apm/service_info.rb

@@ -45,9 +45,9 @@ module ElasticAPM
     def runtime
       case RUBY_ENGINE
       when 'ruby'
-        { name: RUBY_ENGINE, version: RUBY_VERSION }
+        { name: RUBY_ENGINE, version: RUBY_VERSION || RUBY_ENGINE_VERSION }
       when 'jruby'
-        { name: RUBY_ENGINE, version: ENV['JRUBY_VERSION'] }
+        { name: RUBY_ENGINE, version: JRUBY_VERSION || RUBY_ENGINE_VERSION }
       end
     end
   end

data/lib/elastic_apm/spies/rake.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  module Spies
+    # @api private
+    class RakeSpy
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def install
+        ::Rake::Task.class_eval do
+          alias execute_without_apm execute
+
+          def execute(*args)
+            agent = ElasticAPM.start
+
+            unless agent && agent.config.instrumented_rake_tasks.include?(name)
+              return execute_without_apm(*args)
+            end
+
+            transaction = ElasticAPM.transaction("Rake::Task[#{name}]", 'Rake')
+
+            begin
+              result = execute_without_apm(*args)
+
+              transaction.submit('success') if transaction
+            rescue StandardError => e
+              transaction.submit(:error) if transaction
+              ElasticAPM.report(e)
+
+              raise
+            ensure
+              transaction.release if transaction
+              ElasticAPM.stop
+            end
+
+            result
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    end
+    register 'Rake::Task', 'rake', RakeSpy.new
+  end
+end

data/lib/elastic_apm/transaction.rb

@@ -29,6 +29,7 @@ module ElasticAPM
       @notifications = [] # for AS::Notifications
 
       @context = context || Context.new
+      @context.tags.merge!(instrumenter.config.default_tags) { |_, old, _| old }
 
       @sampled = sampled
 

data/lib/elastic_apm/util/inflector.rb

@@ -85,7 +85,7 @@ module ElasticAPM
         raise if e.name && !(camel_cased_word.to_s.split("::").include?(e.name.to_s) ||
                              e.name.to_s == camel_cased_word.to_s)
       rescue ArgumentError => e
-        raise unless /not missing constant #{const_regexp(camel_cased_word)}!$/.match?(e.message)
+        raise unless /not missing constant #{const_regexp(camel_cased_word)}!$/.match(e.message)
       end
     end
   end

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2018-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -60,6 +60,7 @@ files:
 - docs/getting-started-rack.asciidoc
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc
+- docs/troubleshooting.asciidoc
 - elastic-apm.gemspec
 - lib/elastic-apm.rb
 - lib/elastic_apm.rb
@@ -106,6 +107,7 @@ files:
 - lib/elastic_apm/spies/json.rb
 - lib/elastic_apm/spies/mongo.rb
 - lib/elastic_apm/spies/net_http.rb
+- lib/elastic_apm/spies/rake.rb
 - lib/elastic_apm/spies/redis.rb
 - lib/elastic_apm/spies/sequel.rb
 - lib/elastic_apm/spies/sidekiq.rb