elastic-apm 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45fe1b55dccff365970dd59f2a4f58d9cb76141fd3651e7ce9c166b796bfce0a
-  data.tar.gz: 66a2df97b05471613e7d1b5eecdb739ccbf94514b15730cb065153c7128503da
+  metadata.gz: 7d21cbf7caa8a07dc2b34131917e7b635b45c21284fade6a1755235b440bef98
+  data.tar.gz: '0778604992d95bff8e6790cd0e8ce0bc10dd44ea1b07ef0098a87e58efd8eaa4'
 SHA512:
-  metadata.gz: e542f184535be90fee811ceee0fd404f65b59575b0e90a8dc8023807ec5b535f9d1c084b7654f5c59fed9d5521a2cbf5f2bd70dac8691db009be1dd24b07be5f
-  data.tar.gz: 7d87ebdbbfc32727017f6f0fa8451640ac3fef289366bc3a077899d874bb346a3b94dbadafe96596f2b1a8163c42d79b1b41ce940c6e1fd8fb358fc96767ca84
+  metadata.gz: 29a2fd0b89e884d3214bef3ab402d311f76ce2a9263a197bb9b90621ddea93acbfce565672d1b91f4eec5db13e0b67e9633b9ae909c4851e581dd180a76b1738
+  data.tar.gz: 8ecf3bce6665417caa94fd2ca3d88c519843cfc62e2649df9e8f5f96b9bff655a0ebdf4b84ceb340cadf4ce792ed12923b86777e66b37761a21ff241456f2a90

data/CHANGELOG.md

@@ -4,6 +4,22 @@ 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.12.0 (2019-10-01)
+
+### Changed
+
+- `disabled_spies` renamed to `disabled_instrumentations` with fallback ([#539](https://github.com/elastic/apm-agent-ruby/pull/539))
+- Rename `set_tag` to `set_label` and deprecate `set_tag` ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
+- Allow non-String label values ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
+
+### Fixed
+
+- Handles a case where stacktrace frames are empty ([#538](https://github.com/elastic/apm-agent-ruby/pull/538))
+
+### Deprecated
+
+- Deprecate `set_tag` ([#543](https://github.com/elastic/apm-agent-ruby/pull/543))
+
 ## 2.11.0 (2019-09-23)
 
 ### Added

data/docs/api.asciidoc

@@ -260,7 +260,7 @@ Returns `[String]` ID of the generated `[ElasticAPM::Error]` object.
 
 Add a tag to the current transaction.
 Tags are basic key-value pairs that are indexed in your Elasticsearch database
-and therefore searchable.
+and therefore searchable. The value will always be converted to a String.
 
 TIP: Before using custom tags, ensure you understand the different types of
 {apm-overview-ref-v}/metadata.html[metadata] that are available.
@@ -281,6 +281,35 @@ 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]*.
 
+NOTE: This method has been deprecated in favor of `set_label`, which does not convert values to Strings.
+
+[float]
+[[api-agent-set-label]]
+==== `ElasticAPM.set_label`
+
+Add a label to the current transaction.
+Labels are basic key-value pairs that are indexed in your Elasticsearch database and therefore searchable.
+The value can be a string, nil, numeric or boolean.
+
+TIP: Before using custom labels, ensure you understand the different types of
+{apm-overview-ref-v}/metadata.html[metadata] that are available.
+
+[source,ruby]
+----
+before_action do
+  ElasticAPM.set_label(:company_id, current_user.company.id)
+end
+----
+
+Arguments:
+
+  * `key`: A string key. Note that `.`, `*` or `"` will be converted to `_`.
+  * `value`: A value.
+
+Returns the set `value`.
+
+WARNING: Be aware that labels 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

@@ -249,17 +249,31 @@ Eg. `ELASTIC_APM_CUSTOM_KEY_FILTERS="a,b" # => [/a/, /b/]`
 [[config-default-tags]]
 ==== `default_tags`
 
+[options="header"]
+|============
+| Environment                  | `Config` key     | Default | Example
+| `ELASTIC_APM_DEFAULT_LABELS` | `default_labels` | `{}`    | `region=us1`
+|============
+
+Add default labels to every transaction. Note that this will eventually be deprecated in favor of `global_labels`.
+
+WARNING: Be aware that labels are indexed in Elasticsearch. Using too many unique keys will result in *https://www.elastic.co/blog/found-crash-elasticsearch#mapping-explosion[Mapping explosion]*.
+
+NOTE: `global_labels` are supported as of APM server version 7.2. `default_tags` and `default_labels` will eventually be
+deprecated so please transition to using `global_labels` instead. In the meantime, any `default_labels`
+that are set will override `global_labels`.
+
 [options="header"]
 |============
 | Environment                | `Config` key   | Default | Example
 | `ELASTIC_APM_DEFAULT_TAGS` | `default_tags` | `{}`    | `region=us1`
 |============
 
-Add default tags to add to every transaction.
+Add default tags to add to every transaction. Note that this option has been deprecated in favor of `default_labels`.
 
 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]*.
 
-NOTE: `global_labels` are supported as of APM server version 7.2. `default_tags` will eventually be
+NOTE: `global_labels` are supported as of APM server version 7.2. `default_tags` and `default_labels` will eventually be
 deprecated so please transition to using `global_labels` instead. In the meantime, any `default_tags`
 that are set will override `global_labels`.
 
@@ -284,19 +298,19 @@ Disables sending payloads to APM Server.
 Disables the agent's startup message announcing itself.
 
 [float]
-[[config-disabled-spies]]
-==== `disabled_spies`
+[[config-disabled-instrumentations]]
+==== `disabled_instrumentations`
 
 [options="header"]
 |============
-| Environment                  | `Config` key     | Default
-| `ELASTIC_APM_DISABLED_SPIES` | `disabled_spies` | `['json']`
+| Environment                             | `Config` key                | Default
+| `ELASTIC_APM_DISABLED_INSTRUMENTATIONS` | `disabled_instrumentations` | `['json']`
 |============
 
 Elastic APM automatically instruments select third party libraries.
 Use this option to disable any of these.
 
-Get an array of enabled spies with `ElasticAPM.agent.config.enabled_spies`.
+Get an array of enabled instrumentations with `ElasticAPM.agent.config.enabled_instrumentations`.
 
 [float]
 [[config-environment]]

data/lib/elastic_apm.rb

@@ -66,7 +66,8 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     # Get a formatted string containing transaction, span, and trace ids.
     # If a block is provided, the ids are yielded.
     #
-    # @yield [String|nil, String|nil, String|nil] The transaction, span, and trace ids.
+    # @yield [String|nil, String|nil, String|nil] The transaction, span,
+    # and trace ids.
     # @return [String] Unless block given
     def log_ids
       trace_id = (current_transaction || current_span)&.trace_id
@@ -363,8 +364,29 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     # @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)
-      agent&.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
+    # @param value [Object] A value
+    # @return [Object] The given value
+    def set_label(key, value)
+      case value
+      when TrueClass,
+           FalseClass,
+           Numeric,
+           NilClass,
+           String
+        agent&.set_label(key, value)
+      else
+        agent&.set_label(key, value.to_s)
+      end
     end
 
     # Provide further context for the current transaction

data/lib/elastic_apm/agent.rb

@@ -101,7 +101,7 @@ module ElasticAPM
       instrumenter.start
       metrics.start
 
-      config.enabled_spies.each do |lib|
+      config.enabled_instrumentations.each do |lib|
         debug "Requiring spy: #{lib}"
         require "elastic_apm/spies/#{lib}"
       end
@@ -185,8 +185,8 @@ module ElasticAPM
       instrumenter.end_span
     end
 
-    def set_tag(key, value)
-      instrumenter.set_tag(key, value)
+    def set_label(key, value)
+      instrumenter.set_label(key, value)
     end
 
     def set_custom_context(context)

data/lib/elastic_apm/config.rb

@@ -16,6 +16,7 @@ module ElasticAPM
   # @api private
   class Config
     extend Options
+    extend Deprecations
 
     DEPRECATED_OPTIONS = %i[
       compression_level=
@@ -47,9 +48,11 @@ module ElasticAPM
     option :current_user_username_method,      type: :string, default: 'username'
     option :custom_key_filters,                type: :list,   default: [],      converter: RegexpList.new
     option :default_tags,                      type: :dict,   default: {}
+    option :default_labels,                    type: :dict,   default: {}
     option :disable_send,                      type: :bool,   default: false
     option :disable_start_message,             type: :bool,   default: false
-    option :disabled_spies,                    type: :list,   default: %w[json]
+    option :disabled_instrumentations,         type: :list,   default: %w[json]
+    option :disabled_spies,                    type: :list,   default: []
     option :environment,                       type: :string, default: ENV['RAILS_ENV'] || ENV['RACK_ENV']
     option :framework_name,                    type: :string
     option :framework_version,                 type: :string
@@ -121,7 +124,7 @@ module ElasticAPM
     end
 
     # rubocop:disable Metrics/MethodLength
-    def available_spies
+    def available_instrumentations
       %w[
         delayed_job
         elasticsearch
@@ -140,8 +143,8 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/MethodLength
 
-    def enabled_spies
-      available_spies - disabled_spies
+    def enabled_instrumentations
+      available_instrumentations - disabled_instrumentations
     end
 
     def method_missing(name, *args)
@@ -160,6 +163,32 @@ module ElasticAPM
       end
     end
 
+    def use_ssl?
+      server_url.start_with?('https')
+    end
+
+    def collect_metrics?
+      metrics_interval > 0
+    end
+
+    def span_frames_min_duration?
+      span_frames_min_duration != 0
+    end
+
+    def span_frames_min_duration=(value)
+      super
+      @span_frames_min_duration_us = nil
+    end
+
+    def span_frames_min_duration_us
+      @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
+    end
+
+    def inspect
+      super.split.first + '>'
+    end
+
+    # DEPRECATED
     # rubocop:disable Metrics/MethodLength
     def capture_body=(value)
       if value =~ /(all|transactions|errors|off)/
@@ -185,31 +214,54 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/MethodLength
 
-    def use_ssl?
-      server_url.start_with?('https')
+    # 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 collect_metrics?
-      metrics_interval > 0
+    def disabled_spies
+      disabled_instrumentations
     end
 
-    def span_frames_min_duration?
-      span_frames_min_duration != 0
+    def enabled_spies
+      enabled_instrumentations
     end
 
-    def span_frames_min_duration=(value)
+    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
-      @span_frames_min_duration_us = nil
     end
 
-    def span_frames_min_duration_us
-      @span_frames_min_duration_us ||= span_frames_min_duration * 1_000_000
+    # DEPRECATED
+
+    def default_tags=(tags)
+      @options[:default_labels].value.empty? || (raise LABELS_AND_TAGS_CONFLICT)
+      super
+      @options[:default_labels].set(tags)
     end
 
-    def inspect
-      super.split.first + '>'
+    def default_tags
+      default_labels
     end
 
+    deprecate :default_tags=, :default_labels=
+
     private
 
     def load_config_file

data/lib/elastic_apm/context.rb

@@ -9,9 +9,9 @@ require 'elastic_apm/context/user'
 module ElasticAPM
   # @api private
   class Context
-    def initialize(custom: {}, tags: {}, user: nil)
+    def initialize(custom: {}, labels: {}, user: nil)
       @custom = custom
-      @tags = tags
+      @labels = labels
       @user = user || User.new
     end
 
@@ -19,10 +19,10 @@ module ElasticAPM
     attr_accessor :response
     attr_accessor :user
     attr_reader :custom
-    attr_reader :tags
+    attr_reader :labels
 
     def empty?
-      return false if tags.any?
+      return false if labels.any?
       return false if custom.any?
       return false if user.any?
       return false if request || response

data/lib/elastic_apm/error_builder.rb

@@ -11,7 +11,7 @@ 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)
+      Util.reverse_merge!(error.context.labels, @agent.config.default_labels)
 
       if exception.backtrace
         add_stacktrace error, :exception, exception.backtrace
@@ -49,7 +49,7 @@ module ElasticAPM
         error.log.stacktrace = stacktrace
       end
 
-      error.culprit = stacktrace.frames.first.function
+      error.culprit = stacktrace.frames.first&.function
     end
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
@@ -66,7 +66,7 @@ module ElasticAPM
 
       return unless transaction.context
 
-      Util.reverse_merge!(error.context.tags, transaction.context.tags)
+      Util.reverse_merge!(error.context.labels, transaction.context.labels)
       Util.reverse_merge!(error.context.custom, transaction.context.custom)
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/lib/elastic_apm/instrumenter.rb

@@ -101,7 +101,7 @@ module ElasticAPM
           context: context,
           trace_context: trace_context,
           sampled: sampled,
-          tags: config.default_tags
+          labels: config.default_labels
         )
 
       transaction.start
@@ -191,11 +191,11 @@ module ElasticAPM
 
     # metadata
 
-    def set_tag(key, value)
+    def set_label(key, value)
       return unless current_transaction
 
       key = key.to_s.gsub(/[\."\*]/, '_').to_sym
-      current_transaction.context.tags[key] = value.to_s
+      current_transaction.context.labels[key] = value
     end
 
     def set_custom_context(context)

data/lib/elastic_apm/metrics.rb

@@ -21,9 +21,9 @@ module ElasticAPM
 
       TIMEOUT_INTERVAL = 5 # seconds
 
-      def initialize(config, tags: nil, &block)
+      def initialize(config, labels: nil, &block)
         @config = config
-        @tags = tags
+        @labels = labels
         @samplers = [CpuMem, VM].map do |kls|
           debug "Adding metrics collector '#{kls}'"
           kls.new(config)
@@ -31,7 +31,7 @@ module ElasticAPM
         @callback = block
       end
 
-      attr_reader :config, :samplers, :callback, :tags
+      attr_reader :config, :samplers, :callback, :labels
 
       # rubocop:disable Metrics/MethodLength
       def start
@@ -76,7 +76,7 @@ module ElasticAPM
       end
 
       def collect_and_send
-        metricset = Metricset.new(tags: tags, **collect)
+        metricset = Metricset.new(labels: labels, **collect)
         return if metricset.empty?
 
         callback.call(metricset)

data/lib/elastic_apm/metricset.rb

@@ -3,14 +3,14 @@
 module ElasticAPM
   # @api private
   class Metricset
-    def initialize(timestamp: Util.micros, tags: nil, **samples)
+    def initialize(timestamp: Util.micros, labels: nil, **samples)
       @timestamp = timestamp
-      @tags = tags
+      @labels = labels
       @samples = samples
     end
 
     attr_accessor :timestamp
-    attr_reader :samples, :tags
+    attr_reader :samples, :labels
 
     def empty?
       samples.empty?

data/lib/elastic_apm/opentracing.rb

@@ -23,7 +23,7 @@ module ElasticAPM
       end
 
       # rubocop:disable Metrics/MethodLength
-      def set_tag(key, val)
+      def set_label(key, val)
         if elastic_span.is_a?(Transaction)
           case key.to_s
           when 'type'
@@ -33,10 +33,10 @@ module ElasticAPM
           when /user\.(\w+)/
             set_user_value($1, val)
           else
-            elastic_span.context.tags[key] = val
+            elastic_span.context.labels[key] = val
           end
         else
-          elastic_span.context.tags[key] = val
+          elastic_span.context.labels[key] = val
         end
       end
       # rubocop:enable Metrics/MethodLength
@@ -191,7 +191,7 @@ module ElasticAPM
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        tags: {},
+        labels: {},
         ignore_active_scope: false,
         finish_on_close: true,
         **
@@ -201,7 +201,7 @@ module ElasticAPM
           child_of: child_of,
           references: references,
           start_time: start_time,
-          tags: tags,
+          labels: labels,
           ignore_active_scope: ignore_active_scope
         )
         scope = scope_manager.activate(span, finish_on_close: finish_on_close)
@@ -225,7 +225,7 @@ module ElasticAPM
         child_of: nil,
         references: nil,
         start_time: Time.now,
-        tags: {},
+        labels: {},
         ignore_active_scope: false,
         **
       )
@@ -263,8 +263,8 @@ module ElasticAPM
         span_context ||=
           SpanContext.from_trace_context(elastic_span.trace_context)
 
-        tags.each do |key, value|
-          elastic_span.context.tags[key] = value
+        labels.each do |key, value|
+          elastic_span.context.labels[key] = value
         end
 
         elastic_span.start Util.micros(start_time)

data/lib/elastic_apm/rails.rb

@@ -29,7 +29,9 @@ module ElasticAPM
       end
 
       if ElasticAPM.running? &&
-         !ElasticAPM.agent.config.disabled_spies.include?('action_dispatch')
+         !ElasticAPM.agent.config.disabled_instrumentations.include?(
+           'action_dispatch'
+         )
         require 'elastic_apm/spies/action_dispatch'
       end
       ElasticAPM.running?

data/lib/elastic_apm/span/context.rb

@@ -4,14 +4,14 @@ module ElasticAPM
   class Span
     # @api private
     class Context
-      def initialize(db: nil, http: nil, tags: {})
+      def initialize(db: nil, http: nil, labels: {})
         @sync = true
         @db = db && Db.new(db)
         @http = http && Http.new(http)
-        @tags = tags
+        @labels = labels
       end
 
-      attr_accessor :sync, :db, :http, :tags
+      attr_accessor :sync, :db, :http, :labels
 
       # @api private
       class Db

data/lib/elastic_apm/spies/sidekiq.rb

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

data/lib/elastic_apm/stacktrace_builder.rb

@@ -12,6 +12,8 @@ module ElasticAPM
     RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
     JRUBY_ORG_REGEX = %r{org/jruby}.freeze
 
+    GEMS_PATH = defined?(Bundler) ? Bundler.bundle_path.to_s : Gem.dir
+
     def initialize(config)
       @config = config
       @cache = Util::LruCache.new(2048, &method(:build_frame))
@@ -64,9 +66,12 @@ module ElasticAPM
       [file, number, method, module_name]
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     def library_frame?(config, abs_path)
       return false unless abs_path
 
+      return true if abs_path.start_with?(GEMS_PATH)
+
       if abs_path.start_with?(config.__root_path)
         return true if abs_path.start_with?(config.__root_path + '/vendor')
         return false
@@ -77,6 +82,7 @@ module ElasticAPM
 
       false
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def strip_load_path(path)
       return nil if path.nil?

data/lib/elastic_apm/transaction.rb

@@ -20,7 +20,7 @@ module ElasticAPM
       type = nil,
       sampled: true,
       context: nil,
-      tags: nil,
+      labels: nil,
       trace_context: nil
     )
       @name = name
@@ -29,7 +29,7 @@ module ElasticAPM
       @sampled = sampled
 
       @context = context || Context.new # TODO: Lazy generate this?
-      Util.reverse_merge!(@context.tags, tags) if tags
+      Util.reverse_merge!(@context.labels, labels) if labels
 
       @trace_context = trace_context || TraceContext.new(recorded: sampled)
 

data/lib/elastic_apm/transport/serializers.rb

@@ -34,6 +34,16 @@ module ElasticAPM
             h.each { |k, v| hash[k] = keyword_field(v) }
           end
         end
+
+        def mixed_object(hash)
+          return unless hash
+
+          hash.tap do |h|
+            h.each do |k, v|
+              hash[k] = v.is_a?(String) ? keyword_field(v) : v
+            end
+          end
+        end
       end
 
       # @api private

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

@@ -10,7 +10,7 @@ module ElasticAPM
 
           {
             custom: context.custom,
-            tags: keyword_object(context.tags),
+            tags: mixed_object(context.labels),
             request: build_request(context.request),
             response: build_response(context.response),
             user: build_user(context.user)

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

@@ -9,7 +9,7 @@ module ElasticAPM
           {
             metricset: {
               timestamp: metricset.timestamp.to_i,
-              tags: keyword_object(metricset.tags),
+              tags: keyword_object(metricset.labels),
               samples: build_samples(metricset.samples)
             }
           }

data/lib/elastic_apm/version.rb

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

metadata

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