elastic-apm 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f64eb5692ec903ccffcb881d4c7de8a725171d5d85d231b00ef3031dd8972768
-  data.tar.gz: 437ad5c85f6d56cae467c816b6916159a9dd406dcdfd9c7baa4bed4125b62132
+  metadata.gz: 37a03e42bbce98f7206216314854dbe171c6964bf757fc9e25f2d990af922d38
+  data.tar.gz: c4be66c848b4345e8594a178b8fc2738f585bbcc772a81943734a6f1ad1c8b45
 SHA512:
-  metadata.gz: 1def6a88dd72516323da5f9c65a3941679d14e9a8c95b6688f29127c0c155db25dae65bd2574a822114e52f55ea201bb9df0f791476b40f2f86e513dc4cd90ab
-  data.tar.gz: 5e7b21bbf7f688da977b48b3bcdf1ccaf4d585ec2546214eda20ef158f460175d79cd67adfe8a9705e9946dab226ac1924dad780e0a1f645fd21ab6e5b47999c
+  metadata.gz: 81b744b6d0ff9aa3fa1f38b105a9aab42b98da5f15f173e3542882b81b860e3b02139090125f36c429032deba1e638d263469e3bdbf16f060eabf8da7edfcc25
+  data.tar.gz: 3070245854f3547326143d7e494f6cee9851985b5d8f2b56d07b914461cdb8f9ebb255d0466054e923b65dc77b21eb142beb477b00b4f6b14d4773eefb24ca42

data/.rubocop.yml

@@ -5,9 +5,15 @@ AllCops:
     - 'vendor/**/*'
     - 'bench/*'
 
+Layout/AlignArguments:
+  EnforcedStyle: with_fixed_indentation
+
 Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
+Layout/IndentFirstParameter:
+  Enabled: false
+
 Layout/AlignHash:
   Exclude:
     - 'Gemfile'
@@ -21,6 +27,9 @@ Lint/RescueException:
 Lint/HandleExceptions:
   Enabled: false
 
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -4,7 +4,24 @@ 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.6.1
+## 2.7.0 (2019-05-07)
+
+### Added
+
+- Added `disable_start_message` for those wanting complete silence on boot ([#397](https://github.com/elastic/apm-agent-ruby/pull/397))
+
+### Changed
+
+- Attempt to strip secrets from `request.env` ([#410](https://github.com/elastic/apm-agent-ruby/pull/410))
+
+### Fixed
+
+- Rewritten most of the internal transport code, streaming events to APM Server ([#372](https://github.com/elastic/apm-agent-ruby/pull/372))
+- Re-added `default_tags` ([#395](https://github.com/elastic/apm-agent-ruby/pull/395))
+- A bug in the Faraday spy when disabling the Net::HTTP spy ([#396](https://github.com/elastic/apm-agent-ruby/pull/396))
+- Fix disabling the ActionDispatch spy ([#399](https://github.com/elastic/apm-agent-ruby/pull/399))
+
+## 2.6.1 (2019-03-28)
 
 ### Fixed
 

data/Jenkinsfile

@@ -17,6 +17,7 @@ pipeline {
     PIPELINE_LOG_LEVEL='INFO'
     NOTIFY_TO = credentials('notify-to')
     JOB_GCS_BUCKET = credentials('gcs-bucket')
+    CODECOV_SECRET = 'secret/apm-team/ci/apm-agent-ruby-codecov'
   }
   options {
     timeout(time: 2, unit: 'HOURS')
@@ -82,9 +83,6 @@ pipeline {
           beforeAgent true
           allOf {
             anyOf {
-              not {
-                changeRequest()
-              }
               branch 'master'
               branch "\\d+\\.\\d+"
               branch "v\\d?"
@@ -139,9 +137,6 @@ pipeline {
           beforeAgent true
           allOf {
             anyOf {
-              not {
-                changeRequest()
-              }
               branch 'master'
               branch "\\d+\\.\\d+"
               branch "v\\d?"
@@ -214,7 +209,8 @@ class RubyParallelTaskGenerator extends DefaultParallelTaskGenerator {
           steps.junit(allowEmptyResults: false,
             keepLongStdio: true,
             testResults: "**/spec/ruby-agent-junit.xml")
-          steps.codecov(repo: 'apm-agent-ruby', basedir: "${steps.env.BASE_DIR}")
+          steps.codecov(repo: 'apm-agent-ruby', basedir: "${steps.env.BASE_DIR}",
+            secret: "${steps.env.CODECOV_SECRET}")
         }
       }
     }

data/README.md

@@ -1,7 +1,7 @@
 # elastic-apm
 ## Elastic APM agent for ♦️Ruby
 
-[![Jenkins](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-ruby/apm-agent-ruby-mbp/master)](https://apm-ci.elastic.co/job/apm-agent-ruby/apm-agent-ruby-mbp/master) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm) [![codecov](https://codecov.io/gh/elastic/apm-agent-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/apm-agent-ruby)
+[![Jenkins](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-ruby/apm-agent-ruby-mbp/master)](https://apm-ci.elastic.co/job/apm-agent-ruby/job/apm-agent-ruby-mbp/job/master/) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm) [![codecov](https://codecov.io/gh/elastic/apm-agent-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/apm-agent-ruby)
 
 The official Rubygem for [Elastic][] [APM][].
 

data/docs/api.asciidoc

@@ -244,6 +244,9 @@ Add a tag to the current transaction.
 Tags are basic key-value pairs that are indexed in your Elasticsearch database
 and therefore searchable.
 
+TIP: Before using custom tags, ensure you understand the different types of
+{apm-overview-ref-v}/metadata.html[metadata] that are available.
+
 [source,ruby]
 ----
 before_action do
@@ -268,6 +271,9 @@ Add custom context to the current transaction.
 Use this to further specify a context that will help you track or diagnose what's
 going on inside your app.
 
+TIP: Before using custom context, ensure you understand the different types of
+{apm-overview-ref-v}/metadata.html[metadata] that are available.
+
 If called several times during a transaction the custom context will be destructively
 merged with `merge!`.
 

data/docs/configuration.asciidoc

@@ -248,12 +248,22 @@ WARNING: Be aware that tags are indexed in Elasticsearch. Using too many unique
 [[config-disable-send]]
 ==== `disable_send`
 |============
-| Environment | `Config` key   | Default
-| N/A         | `disable_send` | `false`
+| Environment                | `Config` key   | Default
+| `ELASTIC_APM_DISABLE_SEND` | `disable_send` | `false`
 |============
 
 Disables sending payloads to APM Server.
 
+[float]
+[[config-disable-start-message]]
+==== `disable_start_message`
+|============
+| Environment                         | `Config` key            | Default
+| `ELASTIC_APM_DISABLE_START_MESSAGE` | `disable_start_message` | `false`
+|============
+
+Disables the agent's startup message announcing itself.
+
 [float]
 [[config-disabled-spies]]
 ==== `disabled_spies`
@@ -458,8 +468,8 @@ the worker pool size might help.
 
 [options="header"]
 |============
-| Environment | `Config` key    | Default | Example
-| N/A         | `proxy_address` | `nil`   | `"example.com"`
+| Environment                 | `Config` key    | Default | Example
+| `ELASTIC_APM_PROXY_ADDRESS` | `proxy_address` | `nil`   | `"example.com"`
 |============
 
 An address to use as a proxy for the HTTP client.
@@ -472,6 +482,8 @@ Options available are:
 - `proxy_port`
 - `proxy_username`
 
+There are also `ENV` version of these following the same pattern of putting `ELASTIC_APM_` in front.
+
 See https://github.com/httprb/http/wiki/Proxy-Support[Http.rb's docs].
 
 [float]

data/docs/getting-started-rack.asciidoc

@@ -18,7 +18,7 @@ Create a file `config/elastic_apm.yml`:
 
 [source,yaml]
 ----
-server_url: http://localhost:8100
+server_url: http://localhost:8200
 secret_token: ''
 ----
 

data/docs/getting-started-rails.asciidoc

@@ -21,7 +21,7 @@ Create a file `config/elastic_apm.yml`:
 
 [source,yaml]
 ----
-server_url: http://localhost:8100
+server_url: http://localhost:8200
 secret_token: ''
 ----
 

data/docs/index.asciidoc

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

data/docs/release-notes.asciidoc

@@ -0,0 +1,4 @@
+[[release-notes]]
+== Release notes
+
+Release notes are published in the https://github.com/elastic/apm-agent-ruby/blob/master/CHANGELOG.md[changelog].

data/lib/elastic_apm/agent.rb

@@ -33,7 +33,7 @@ module ElasticAPM
 
         unless config.active?
           config.logger.debug format(
-            '%sAgent disabled with active: false',
+            "%sAgent disabled with `active: false'",
             Logging::PREFIX
           )
           return
@@ -75,26 +75,31 @@ module ElasticAPM
     attr_reader :config, :transport, :instrumenter,
       :stacktrace_builder, :context_builder, :error_builder, :metrics
 
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def start
-      info '[%s] Starting agent, reporting to %s', VERSION, config.server_url
+      unless config.disable_start_message
+        info '[%s] Starting agent, reporting to %s', VERSION, config.server_url
+      end
 
       transport.start
       instrumenter.start
       metrics.start
 
       config.enabled_spies.each do |lib|
+        debug "Requiring spy: #{lib}"
         require "elastic_apm/spies/#{lib}"
       end
 
       self
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def stop
       debug 'Stopping agent'
 
+      metrics.stop
       instrumenter.stop
       transport.stop
-      metrics.stop
 
       self
     end

data/lib/elastic_apm/config.rb

@@ -32,6 +32,7 @@ module ElasticAPM
       custom_key_filters: [],
       default_tags: {},
       disable_send: false,
+      disable_start_message: false,
       disabled_spies: %w[json],
       environment: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
       filter_exception_types: [],
@@ -72,6 +73,7 @@ module ElasticAPM
       'ELASTIC_APM_DEFAULT_TAGS' => [:dict, 'default_tags'],
       'ELASTIC_APM_DISABLED_SPIES' => [:list, 'disabled_spies'],
       'ELASTIC_APM_DISABLE_SEND' => [:bool, 'disable_send'],
+      'ELASTIC_APM_DISABLE_START_MESSAGE' => [:bool, 'disable_start_message'],
       'ELASTIC_APM_ENVIRONMENT' => 'environment',
       'ELASTIC_APM_FRAMEWORK_NAME' => 'framework_name',
       'ELASTIC_APM_FRAMEWORK_VERSION' => 'framework_version',
@@ -151,6 +153,7 @@ module ElasticAPM
     attr_accessor :current_user_username_method
     attr_accessor :default_tags
     attr_accessor :disable_send
+    attr_accessor :disable_start_message
     attr_accessor :disabled_spies
     attr_accessor :environment
     attr_accessor :filter_exception_types
@@ -197,6 +200,7 @@ module ElasticAPM
     alias :capture_headers? :capture_headers
     alias :capture_env? :capture_env
     alias :disable_send? :disable_send
+    alias :disable_start_message? :disable_start_message
     alias :http_compression? :http_compression
     alias :instrument? :instrument
     alias :verify_server_cert? :verify_server_cert
@@ -243,7 +247,6 @@ module ElasticAPM
     # rubocop:disable Metrics/MethodLength
     def available_spies
       %w[
-        action_dispatch
         delayed_job
         elasticsearch
         faraday

data/lib/elastic_apm/error_builder.rb

@@ -11,6 +11,8 @@ module ElasticAPM
       error = Error.new context: context || Context.new
       error.exception = Error::Exception.new(exception, handled: handled)
 
+      Util.reverse_merge!(error.context.tags, @agent.config.default_tags)
+
       if exception.backtrace
         add_stacktrace error, :exception, exception.backtrace
       end

data/lib/elastic_apm/instrumenter.rb

@@ -63,6 +63,7 @@ module ElasticAPM
     end
 
     def subscriber=(subscriber)
+      debug 'Registering subscriber'
       @subscriber = subscriber
       @subscriber.register!
     end
@@ -99,7 +100,8 @@ module ElasticAPM
           type,
           context: context,
           trace_context: trace_context,
-          sampled: sampled
+          sampled: sampled,
+          tags: config.default_tags
         )
 
       transaction.start

data/lib/elastic_apm/metadata/system_info.rb

@@ -13,10 +13,10 @@ module ElasticAPM
 
         container_info = ContainerInfo.read!
         @container = container_info.container
-        @kupernetes = container_info.kupernetes
+        @kubernetes = container_info.kubernetes
       end
 
-      attr_reader :hostname, :architecture, :platform, :container, :kupernetes
+      attr_reader :hostname, :architecture, :platform, :container, :kubernetes
 
       private
 

data/lib/elastic_apm/metadata/system_info/container_info.rb

@@ -5,10 +5,10 @@ module ElasticAPM
     class SystemInfo
       # @api private
       class ContainerInfo
-        CGROUP_PATH = '/proc/pid/cgroup'
+        CGROUP_PATH = '/proc/self/cgroup'
 
-        attr_accessor :container_id, :kupernetes_namespace,
-          :kupernetes_node_name, :kupernetes_pod_name, :kupernetes_pod_uid
+        attr_accessor :container_id, :kubernetes_namespace,
+          :kubernetes_node_name, :kubernetes_pod_name, :kubernetes_pod_uid
 
         def initialize(cgroup_path: CGROUP_PATH)
           @cgroup_path = cgroup_path
@@ -34,32 +34,36 @@ module ElasticAPM
             end
         end
 
-        def kupernetes
-          @kupernetes =
+        # rubocop:disable Metrics/MethodLength
+        def kubernetes
+          @kubernetes =
             begin
-              kupernetes = {}
-
-              kupernetes[:namespace] = kupernetes_namespace
-              kupernetes[:node_name] = kupernetes_node_name
-              kupernetes[:pod_name] = kupernetes_pod_name
-              kupernetes[:pod_uid] = kupernetes_pod_uid
-              return nil if kupernetes.values.all?(&:nil?)
-
-              kupernetes
+              kubernetes = {
+                namespace: kubernetes_namespace,
+                node: { name: kubernetes_node_name },
+                pod: {
+                  name: kubernetes_pod_name,
+                  uid: kubernetes_pod_uid
+                }
+              }
+              return nil if kubernetes.values.all?(&:nil?)
+
+              kubernetes
             end
         end
+        # rubocop:enable Metrics/MethodLength
 
         private
 
         def read_from_env!
-          self.kupernetes_namespace =
-            ENV.fetch('KUBERNETES_NAMESPACE', kupernetes_namespace)
-          self.kupernetes_node_name =
-            ENV.fetch('KUBERNETES_NODE_NAME', kupernetes_node_name)
-          self.kupernetes_pod_name =
-            ENV.fetch('KUBERNETES_POD_NAME', kupernetes_pod_name)
-          self.kupernetes_pod_uid =
-            ENV.fetch('KUBERNETES_POD_UID', kupernetes_pod_uid)
+          self.kubernetes_namespace =
+            ENV.fetch('KUBERNETES_NAMESPACE', kubernetes_namespace)
+          self.kubernetes_node_name =
+            ENV.fetch('KUBERNETES_NODE_NAME', kubernetes_node_name)
+          self.kubernetes_pod_name =
+            ENV.fetch('KUBERNETES_POD_NAME', kubernetes_pod_name)
+          self.kubernetes_pod_uid =
+            ENV.fetch('KUBERNETES_POD_UID', kubernetes_pod_uid)
         end
 
         CONTAINER_ID_REGEX = /^[0-9A-Fa-f]{64}$/.freeze
@@ -103,7 +107,7 @@ module ElasticAPM
               pod_id = kubepods_match[1] || kubepods_match[2]
 
               self.container_id = container_id
-              self.kupernetes_pod_uid = pod_id
+              self.kubernetes_pod_uid = pod_id
             elsif CONTAINER_ID_REGEX.match(container_id)
               self.container_id = container_id
             end

data/lib/elastic_apm/metrics.rb

@@ -24,7 +24,10 @@ module ElasticAPM
       def initialize(config, tags: nil, &block)
         @config = config
         @tags = tags
-        @samplers = [CpuMem].map { |kls| kls.new(config) }
+        @samplers = [CpuMem].map do |kls|
+          debug "Adding metrics collector '#{kls}'"
+          kls.new(config)
+        end
         @callback = block
       end
 
@@ -32,7 +35,12 @@ module ElasticAPM
 
       # rubocop:disable Metrics/MethodLength
       def start
-        return unless config.collect_metrics?
+        unless config.collect_metrics?
+          debug 'Skipping metrics'
+          return
+        end
+
+        debug 'Starting metrics'
 
         @timer_task = Concurrent::TimerTask.execute(
           run_now: true,
@@ -40,6 +48,7 @@ module ElasticAPM
           timeout_interval: TIMEOUT_INTERVAL
         ) do
           begin
+            debug 'Collecting metrics'
             collect_and_send
             true
           rescue StandardError => e
@@ -56,6 +65,8 @@ module ElasticAPM
       def stop
         return unless running?
 
+        debug 'Stopping metrics'
+
         @timer_task.shutdown
         @running = false
       end