elastic-apm 2.12.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d21cbf7caa8a07dc2b34131917e7b635b45c21284fade6a1755235b440bef98
-  data.tar.gz: '0778604992d95bff8e6790cd0e8ce0bc10dd44ea1b07ef0098a87e58efd8eaa4'
+  metadata.gz: 77a4cbfd5c5c3031b8d83865203a8b0fa2d4b7146b98e1b52828a3ac9513765d
+  data.tar.gz: bbed03cae2b396e1967a82036d67feaf00d86cc07d8d0eef51a5bb9bb5cf9607
 SHA512:
-  metadata.gz: 29a2fd0b89e884d3214bef3ab402d311f76ce2a9263a197bb9b90621ddea93acbfce565672d1b91f4eec5db13e0b67e9633b9ae909c4851e581dd180a76b1738
-  data.tar.gz: 8ecf3bce6665417caa94fd2ca3d88c519843cfc62e2649df9e8f5f96b9bff655a0ebdf4b84ceb340cadf4ce792ed12923b86777e66b37761a21ff241456f2a90
+  metadata.gz: 9621a7cf92e596e45a26d863f781e4ad9f8f9122bc976d0906f78e1c1d5e80801aec4ab402677f542022769f4ef7c101aec77fa80f8cb7e40d486ea76a977a58
+  data.tar.gz: f32184577052ee7be8f72b24cb9d41445bd072f945541080d08edffe980549d4eb2807a7909ae30676a0620890140f8022a49fd11d903abece0ac267baa44588

data/.ci/Jenkinsfile

@@ -47,7 +47,6 @@ pipeline {
     Checkout the code and stash it, to use it on other stages.
     */
     stage('Checkout') {
-      agent { label 'immutable' }
       options { skipDefaultCheckout() }
       steps {
         deleteDir()
@@ -56,7 +55,6 @@ pipeline {
       }
     }
     stage('Sanity checks') {
-      agent { label 'linux && immutable && docker' }
       when {
         beforeAgent true
         anyOf {
@@ -85,7 +83,6 @@ pipeline {
     Execute unit tests.
     */
     stage('Test') {
-      agent { label 'linux && immutable' }
       options { skipDefaultCheckout() }
       steps {
         withGithubNotify(context: 'Tests', tab: 'tests') {
@@ -136,7 +133,6 @@ pipeline {
             The result JSON files are also archive into Jenkins.
           */
           stage('Run Benchmarks') {
-            agent { label 'linux && immutable' }
             steps {
               withGithubNotify(context: 'Run Benchmarks') {
                 deleteDir()
@@ -183,6 +179,7 @@ pipeline {
         options { skipDefaultCheckout() }
         environment {
           RUBY_DOCKER_TAG = 'ruby:2.6'
+          HOME = '/var/lib/jenkins'
         }
         when {
           beforeAgent true

data/.ci/downstreamTests.groovy

@@ -42,7 +42,6 @@ pipeline {
     Checkout the code and stash it, to use it on other stages.
     */
     stage('Checkout') {
-      agent { label 'immutable' }
       options { skipDefaultCheckout() }
       steps {
         deleteDir()
@@ -54,14 +53,12 @@ pipeline {
       }
     }
     stage('Test') {
-      agent { label 'linux && immutable' }
       options { skipDefaultCheckout() }
       steps {
         runTests('.ci/.jenkins_framework.yml')
       }
     }
     stage('Master Test') {
-      agent { label 'linux && immutable' }
       options { skipDefaultCheckout() }
       steps {
         catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE', message: "The tests for the master framework have failed. Let's warn instead.") {

data/.ci/prepare-git-context.sh

@@ -20,4 +20,5 @@ git checkout "${BRANCH_NAME}"
 
 # Ensure the master branch points to the original commit to avoid commit injection
 # when running the release pipeline.
-git reset --hard "${GIT_COMMIT}"
+# used GIT_BASE_COMMIT instead GIT_COMMIT to support the MultiBranchPipelines.
+git reset --hard "${GIT_BASE_COMMIT}"

data/.rubocop.yml

@@ -78,6 +78,9 @@ Layout/EmptyLineAfterGuardClause:
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
 Style/SpecialGlobalVars:
   Enabled: false
 

data/CHANGELOG.md

@@ -4,6 +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).
 
+## 3.0.0 (2019-10-08)
+
+### Breaking Changes
+
+The following changes are breaking, as they may change the way data is grouped or shown in Kibana or how your app
+defines agent settings.
+
+- Decrease stack_trace_limit to 50 ([#515](https://github.com/elastic/apm-agent-ruby/pull/515))
+- Errors' `message` no longer include their `type` ([#323](https://github.com/elastic/apm-agent-ruby/pull/323/files))
+- External request spans now have type `external.http.{library}` ([#514](https://github.com/elastic/apm-agent-ruby/pull/514))
+- Durations are measured using monotonic time ([#550](https://github.com/elastic/apm-agent-ruby/pull/550))
+- Rename set_tag to set_label ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
+- Rename disabled_spies to disabled_instrumentations ([#539](https://github.com/elastic/apm-agent-ruby/pull/539))
+
 ## 2.12.0 (2019-10-01)
 
 ### Changed

data/docs/log-correlation.asciidoc

@@ -94,3 +94,28 @@ end
 # [2019-09-16 11:54:59 +0200][RailsTestApp][INFO][transaction.id=3b92edcccc0a6d1e span.id=f3d7e32f176d4c93 trace.id=1275686e35de91f776557637e799651e]   Rendered text template (Duration: 0.1ms | Allocations: 17)
 # [2019-09-16 11:54:59 +0200][RailsTestApp][INFO][transaction.id=3b92edcccc0a6d1e span.id=3bde4e9c85ab359c trace.id=1275686e35de91f776557637e799651e] Completed 200 OK in 1ms (Views: 0.3ms | Allocations: 187)
 ----
+
+[float]
+==== Extracting trace IDs from the logs
+
+For log correlation to work, the trace IDs must be extracted from the log message and stored in separate fields in the Elasticsearch document. There are many ways to achieve this, for example by using ingest node and defining a pipeline with a grok processor.
+You can extract the trace id from the Lograge output generated above like this:
+
+[source,json]
+----
+PUT _ingest/pipeline/extract_trace_id
+{
+  "description": "Extract trace id from Lograge logs",
+  "processors": [
+    {
+      "grok": {
+        "field": "message",
+        "patterns": ["%{TIME}.*\\| [A-Z]\\, \\[%{TIMESTAMP_ISO8601}.*\\]  %{LOGLEVEL:log.level} [-]{2} \\: \\[[0-9A-Fa-f\\-]{36}\\] \\{.*\\\"trace\\.id\\\"\\:\\\"%{TRACE_ID:trace.id}.*\\}"],
+        "pattern_definitions": { "TRACE_ID": "[0-9A-Fa-f]{32}" }
+      }
+    }
+  ]
+}
+----
+
+Please see {apm-overview-ref-v}/observability-integrations.html[Observability integrations] for more information.

data/lib/elastic_apm.rb

@@ -3,7 +3,6 @@
 require 'elastic_apm/version'
 require 'elastic_apm/internal_error'
 require 'elastic_apm/logging'
-require 'elastic_apm/deprecations'
 
 # Core
 require 'elastic_apm/agent'
@@ -19,8 +18,6 @@ require 'elastic_apm/railtie' if defined?(::Rails::Railtie)
 # ElasticAPM
 module ElasticAPM # rubocop:disable Metrics/ModuleLength
   class << self
-    extend ElasticAPM::Deprecations
-
     ### Life cycle
 
     # Starts the ElasticAPM Agent
@@ -83,28 +80,6 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     end
     # rubocop:enable Metrics/AbcSize
 
-    # Start a new transaction or return the currently running
-    #
-    # @param name [String] A description of the transaction, eg
-    # `ExamplesController#index`
-    # @param type [String] The kind of the transaction, eg `app.request.get` or
-    # `db.mysql2.query`
-    # @param context [Context] An optional [Context]
-    # @yield [Transaction] Optional block encapsulating transaction
-    # @return [Transaction] Unless block given
-    # @deprecated See `with_transaction` or `start_transaction`
-    def transaction(name = nil, type = nil, context: nil, &block)
-      return (block_given? ? yield : nil) unless agent
-
-      if block_given?
-        with_transaction(name, type, context: context, &block)
-      else
-        start_transaction(name, type, context: context)
-      end
-    end
-
-    deprecate :transaction, :with_transaction
-
     # rubocop:disable Metrics/MethodLength
     # Start a new transaction
     #
@@ -118,15 +93,8 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       name = nil,
       type = nil,
       context: nil,
-      trace_context: nil,
-      traceparent: nil
+      trace_context: nil
     )
-      if traceparent
-        trace_context ||= traceparent
-        warn "[ElasticAPM] [DEPRECATED] `start_transaction' with" \
-          "`traceparent:' has been renamed. Use `trace_context:' instead."
-      end
-
       agent&.start_transaction(
         name,
         type,
@@ -158,20 +126,13 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       name = nil,
       type = nil,
       context: nil,
-      trace_context: nil,
-      traceparent: nil
+      trace_context: nil
     )
       unless block_given?
         raise ArgumentError,
           'expected a block. Do you want `start_transaction\' instead?'
       end
 
-      if traceparent
-        trace_context ||= traceparent
-        warn "[ElasticAPM] [DEPRECATED] `with_transaction' with " \
-          "`traceparent:' has been renamed. Use `trace_context:' instead."
-      end
-
       return yield(nil) unless agent
 
       begin
@@ -189,46 +150,6 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     end
     # rubocop:enable Metrics/MethodLength
 
-    # rubocop:disable Metrics/MethodLength
-    # Start a new span
-    #
-    # @param name [String] A description of the span, eq `SELECT FROM "users"`
-    # @param type [String] The kind of span, eq `db.mysql2.query`
-    # @param context [Span::Context] Context information about the span
-    # @yield [Span] Optional block encapsulating span
-    # @return [Span] Unless block given
-    # @deprecated See `with_span` or `start_span`
-    def span(
-      name,
-      type = nil,
-      context: nil,
-      include_stacktrace: true,
-      &block
-    )
-      return (block_given? ? yield : nil) unless agent
-
-      if block_given?
-        with_span(
-          name,
-          type,
-          context: context,
-          include_stacktrace: include_stacktrace,
-          &block
-        )
-      else
-        start_span(
-          name,
-          type,
-          context: context,
-          include_stacktrace: include_stacktrace
-        )
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    deprecate :span, :with_span
-
-    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
     # Start a new span
     #
     # @param name [String] A description of the span, eq `SELECT FROM "users"`
@@ -319,15 +240,9 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     # @param rack_env [Rack::Env] A Rack env
     # @return [Context] The built context
     def build_context(
-      deprecated_env = nil,
       rack_env: nil,
       for_type: :transaction
     )
-      if !rack_env && (rack_env = deprecated_env)
-        warn "[ElasticAPM] [DEPRECATED] `build_context' expects two keyword" \
-          "arguments, `rack_env:' and `for_type:'"
-      end
-
       agent&.build_context(rack_env: rack_env, for_type: for_type)
     end
 
@@ -359,18 +274,6 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
 
     ### Context
 
-    # Set a _tag_ value for the current transaction
-    #
-    # @param key [String,Symbol] A key
-    # @param value [Object] A value (will be converted to string)
-    # @return [Object] The given value
-    # @deprecated See `set_label` instead
-    def set_tag(key, value)
-      set_label(key, value.to_s)
-    end
-
-    deprecate :set_tag, :set_label
-
     # Set a _label_ value for the current transaction
     #
     # @param key [String,Symbol] A key

data/lib/elastic_apm/config.rb

@@ -16,19 +16,8 @@ module ElasticAPM
   # @api private
   class Config
     extend Options
-    extend Deprecations
-
-    DEPRECATED_OPTIONS = %i[
-      compression_level=
-      compression_minimum_size=
-      debug_http=
-      debug_transactions=
-      flush_interval=
-      http_open_timeout=
-      http_read_timeout=
-      enabled_environments=
-      disable_environment_warning=
-    ].freeze
+
+    DEPRECATED_OPTIONS = %i[].freeze
 
     # rubocop:disable Metrics/LineLength, Layout/ExtraSpacing
     option :config_file,                       type: :string, default: 'config/elastic_apm.yml'
@@ -188,80 +177,6 @@ module ElasticAPM
       super.split.first + '>'
     end
 
-    # DEPRECATED
-    # rubocop:disable Metrics/MethodLength
-    def capture_body=(value)
-      if value =~ /(all|transactions|errors|off)/
-        set(:capture_body, value)
-        return
-      end
-
-      case value
-      when true
-        warn "Boolean value for option `capture_body' has " \
-          "been deprecated. Setting to 'all'"
-        self.capture_body = 'all'
-      when false
-        warn "Boolean value for option `capture_body' has " \
-          "been deprecated. Setting to 'off'"
-        self.capture_body = 'off'
-      else
-        default = options[:capture_body].default
-        warn "Unknown value `#{value}' for option "\
-          "`capture_body'. Defaulting to `#{default}'"
-        self.capture_body = default
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    # DEPRECATED
-    # The spies methods are only somewhat public and only mentioned briefly in
-    # the docs.
-
-    def disabled_spies=(list)
-      self.disabled_instrumentations = list
-    end
-
-    def disabled_spies
-      disabled_instrumentations
-    end
-
-    def enabled_spies
-      enabled_instrumentations
-    end
-
-    def available_spies
-      available_instrumentations
-    end
-
-    deprecate :disabled_spies=, :disabled_instrumentations=
-    deprecate :disabled_spies, :disabled_instrumentations
-    deprecate :enabled_spies, :enabled_instrumentations
-    deprecate :available_spies, :available_instrumentations
-
-    LABELS_AND_TAGS_CONFLICT = 'You have both \'default_labels\' and ' \
-      '\'default_tags\' set. \'default_tags\' has been deprecated in favor '\
-      'of \'default_labels\'. Please consider upgrading.'.freeze
-
-    def default_labels=(labels)
-      @options[:default_tags].value.empty? || (raise LABELS_AND_TAGS_CONFLICT)
-      super
-    end
-
-    # DEPRECATED
-
-    def default_tags=(tags)
-      @options[:default_labels].value.empty? || (raise LABELS_AND_TAGS_CONFLICT)
-      super
-      @options[:default_labels].set(tags)
-    end
-
-    def default_tags
-      default_labels
-    end
-
-    deprecate :default_tags=, :default_labels=
-
     private
 
     def load_config_file

data/lib/elastic_apm/error/exception.rb

@@ -6,18 +6,23 @@ module ElasticAPM
     class Exception
       MOD_SPLIT = '::'
 
-      def initialize(exception, **attrs)
-        @message =
-          "#{exception.class}: #{exception.message}"
-        @type = exception.class.to_s
-        @module = format_module exception
-        @cause = exception.cause && Exception.new(exception.cause)
+      def initialize(attrs = nil)
+        return unless attrs
 
         attrs.each do |key, val|
           send(:"#{key}=", val)
         end
       end
 
+      def self.from_exception(exception, **attrs)
+        new({
+          message: exception.message.to_s,
+          type: exception.class.to_s,
+          module: format_module(exception),
+          cause: exception.cause && Exception.from_exception(exception.cause)
+        }.merge(attrs))
+      end
+
       attr_accessor(
         :attributes,
         :code,
@@ -29,10 +34,12 @@ module ElasticAPM
         :cause
       )
 
-      private
+      class << self
+        private
 
-      def format_module(exception)
-        exception.class.to_s.split(MOD_SPLIT)[0...-1].join(MOD_SPLIT)
+        def format_module(exception)
+          exception.class.to_s.split(MOD_SPLIT)[0...-1].join(MOD_SPLIT)
+        end
       end
     end
   end

data/lib/elastic_apm/error_builder.rb

@@ -9,7 +9,8 @@ module ElasticAPM
 
     def build_exception(exception, context: nil, handled: true)
       error = Error.new context: context || Context.new
-      error.exception = Error::Exception.new(exception, handled: handled)
+      error.exception =
+        Error::Exception.from_exception(exception, handled: handled)
 
       Util.reverse_merge!(error.context.labels, @agent.config.default_labels)
 

data/lib/elastic_apm/opentracing.rb

@@ -65,10 +65,17 @@ module ElasticAPM
       end
       # rubocop:enable Lint/UnusedMethodArgument
 
-      def finish(end_time: Time.now)
+      # rubocop:disable Metrics/MethodLength
+      def finish(clock_end: Util.monotonic_micros, end_time: nil)
         return unless (instrumenter = ElasticAPM.agent&.instrumenter)
 
-        elastic_span.done end_time: Util.micros(end_time)
+        if end_time
+          warn '[ElasticAPM] DEPRECATED: Setting a custom end time as a ' \
+            '`Time` is deprecated. Use `clock_end:` and monotonic time instead.'
+          clock_end = end_time
+        end
+
+        elastic_span.done clock_end: clock_end
 
         case elastic_span
         when ElasticAPM::Transaction
@@ -79,6 +86,7 @@ module ElasticAPM
 
         instrumenter.enqueue.call elastic_span
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 

data/lib/elastic_apm/span.rb

@@ -61,18 +61,19 @@ module ElasticAPM
 
     # life cycle
 
-    def start(timestamp = Util.micros)
-      @timestamp = timestamp
-
+    def start(clock_start = Util.monotonic_micros)
+      @timestamp = Util.micros
+      @clock_start = clock_start
       self
     end
 
-    def stop(end_timestamp = Util.micros)
-      @duration ||= (end_timestamp - timestamp)
+    def stop(clock_end = Util.monotonic_micros)
+      @duration ||= (clock_end - @clock_start)
+      self
     end
 
-    def done(end_time: Util.micros)
-      stop end_time
+    def done(clock_end: Util.monotonic_micros)
+      stop clock_end
 
       build_stacktrace! if should_build_stacktrace?
       self.original_backtrace = nil # release original

data/lib/elastic_apm/spies/sidekiq.rb

@@ -14,8 +14,7 @@ module ElasticAPM
         def call(_worker, job, queue)
           name = SidekiqSpy.name_for(job)
           transaction = ElasticAPM.start_transaction(name, 'Sidekiq')
-          # TODO: Remove #to_s when #set_tag is removed in v3.0
-          ElasticAPM.set_label(:queue, queue.to_s)
+          ElasticAPM.set_label(:queue, queue)
 
           yield
 

data/lib/elastic_apm/trace_context.rb

@@ -3,7 +3,6 @@
 module ElasticAPM
   # @api private
   class TraceContext
-    extend Deprecations
     class InvalidTraceparentHeader < StandardError; end
 
     VERSION = '00'
@@ -77,19 +76,6 @@ module ElasticAPM
       format('%s-%s-%s-%s', version, trace_id, id, hex_flags)
     end
 
-    # @deprecated Use parent_id instead
-    def span_id
-      @parent_id
-    end
-
-    # @deprecated Use parent_id instead
-    def span_id=(span_id)
-      @parent_id = span_id
-    end
-
-    deprecate :span_id, :parent_id
-    deprecate :span_id=, :parent_id=
-
     private
 
     def hex(len)

data/lib/elastic_apm/transaction.rb

@@ -6,7 +6,6 @@ require 'forwardable'
 module ElasticAPM
   # @api private
   class Transaction
-    extend Deprecations
     extend Forwardable
 
     def_delegators :@trace_context,
@@ -53,27 +52,22 @@ module ElasticAPM
       !!duration
     end
 
-    def done?
-      stopped?
-    end
-
-    deprecate :done?, :stopped?
-
     # life cycle
 
-    def start(timestamp = Util.micros)
-      @timestamp = timestamp
+    def start(clock_start = Util.monotonic_micros)
+      @timestamp = Util.micros
+      @clock_start = clock_start
       self
     end
 
-    def stop(end_timestamp = Util.micros)
+    def stop(clock_end = Util.monotonic_micros)
       raise 'Transaction not yet start' unless timestamp
-      @duration = end_timestamp - timestamp
+      @duration = clock_end - @clock_start
       self
     end
 
-    def done(result = nil, end_time: Util.micros)
-      stop end_time
+    def done(result = nil, clock_end: Util.monotonic_micros)
+      stop clock_end
       self.result = result if result
       self
     end

data/lib/elastic_apm/util.rb

@@ -3,15 +3,15 @@
 module ElasticAPM
   # @api private
   module Util
-    def self.nearest_minute(target = Time.now.utc)
-      target - target.to_i % 60
-    end
-
     def self.micros(target = Time.now)
       utc = target.utc
       utc.to_i * 1_000_000 + utc.usec
     end
 
+    def self.monotonic_micros
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, :microsecond)
+    end
+
     def self.git_sha
       sha = `git rev-parse --verify HEAD 2>&1`.chomp
       $? && $?.success? ? sha : nil

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby