elastic-apm 2.9.1 → 2.10.0

data/.ci/jobs/apm-agent-ruby-mbp.yml

@@ -4,3 +4,37 @@
     display-name: APM Agent Ruby
     description: APM Agent Ruby
     script-path: .ci/Jenkinsfile
+    scm:
+    - github:
+        branch-discovery: no-pr
+        discover-pr-forks-strategy: merge-current
+        discover-pr-forks-trust: permission
+        discover-pr-origin: merge-current
+        discover-tags: true
+        repo: apm-agent-ruby
+        repo-owner: elastic
+        credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
+        ssh-checkout:
+          credentials: f6c7695a-671e-4f4f-a331-acdce44ff9ba
+        build-strategies:
+        - tags:
+            ignore-tags-older-than: -1
+            ignore-tags-newer-than: -1
+        - regular-branches: true
+        - change-request:
+            ignore-target-only-changes: false
+        clean:
+          after: true
+          before: true
+        prune: true
+        shallow-clone: true
+        depth: 3
+        do-not-fetch-tags: true
+        submodule:
+          disable: false
+          recursive: true
+          parent-credentials: true
+          timeout: 100
+        timeout: '15'
+        use-author: true
+        wipe-workspace: 'True'

data/.ci/jobs/defaults.yml

@@ -12,46 +12,11 @@
     project-type: multibranch
     logrotate:
       daysToKeep: 30
-      numToKeep: 100
+      numToKeep: 300
     number-to-keep: '100'
     days-to-keep: '30'
     concurrent: true
     node: linux
-    script-path: .ci/Jenkinsfile
-    scm:
-    - github:
-        branch-discovery: all
-        discover-pr-forks-strategy: merge-current
-        discover-pr-forks-trust: permission
-        discover-pr-origin: merge-current
-        discover-tags: true
-        repo: apm-agent-ruby
-        repo-owner: elastic
-        credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
-        ssh-checkout:
-          credentials: f6c7695a-671e-4f4f-a331-acdce44ff9ba
-        build-strategies:
-        - tags:
-            ignore-tags-older-than: -1
-            ignore-tags-newer-than: -1
-        - regular-branches: true
-        - change-request:
-            ignore-target-only-changes: false
-        clean:
-          after: true
-          before: true
-        prune: true
-        shallow-clone: true
-        depth: 3
-        do-not-fetch-tags: true
-        submodule:
-          disable: false
-          recursive: true
-          parent-credentials: true
-          timeout: 100
-        timeout: '15'
-        use-author: true
-        wipe-workspace: 'True'
     periodic-folder-trigger: 1d
     prune-dead-branches: true
     publishers:

data/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+-   repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    -   id: check-case-conflict
+    -   id: check-executables-have-shebangs
+    -   id: check-json
+    -   id: check-merge-conflict
+    -   id: check-yaml
+    -   id: check-xml
+    -   id: end-of-file-fixer
+
+-   repo: git@github.com:elastic/apm-pipeline-library
+    rev: current
+    hooks:
+    -   id: check-bash-syntax
+    -   id: check-abstract-classes-and-trait
+    -   id: check-jsonslurper-class
+    -   id: check-jenkins-pipelines
+    -   id: check-unicode-non-breaking-spaces
+    -   id: remove-unicode-non-breaking-spaces
+    -   id: check-jjbb

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --require spec_helper
---format documentation

data/.rubocop.yml

@@ -66,9 +66,6 @@ Style/DoubleNegation:
 Style/EmptyMethod:
   Enabled: false
 
-Rails/Delegate:
-  Enabled: false
-
 Style/NumericPredicate:
   Enabled: false
 
@@ -83,3 +80,6 @@ Naming/MemoizedInstanceVariableName:
 
 Style/SpecialGlobalVars:
   Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,18 @@ 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.10.0
+
+### Added
+
+- Add Ruby specific metrics ([#437](https://github.com/elastic/apm-agent-ruby/pull/437))
+- Support for APM Agent Configuration via Kibana ([#464](https://github.com/elastic/apm-agent-ruby/pull/464))
+- Change span name format and add command to context's db.statement for `MongoSpy` ([#488](https://github.com/elastic/apm-agent-ruby/pull/490))
+
+### Changed
+
+- `ElasticAPM.report` and `ElasticAPM.report_message` return the string ID of the generated `Error` objects ([#507](https://github.com/elastic/apm-agent-ruby/pull/507))
+
 ## 2.9.1 (2019-06-28)
 
 ### Fixed

data/docs/api.asciidoc

@@ -212,7 +212,7 @@ Arguments:
   * `handled`: Whether the error was _handled_ eg. wasn't rescued and was represented
   to the user. Default: `true`.
 
-Returns `[ElasticAPM::Error]`.
+Returns `[String]` ID of the generated `[ElasticAPM::Error]` object.
 
 [float]
 [[api-agent-report-message]]
@@ -231,7 +231,7 @@ Arguments:
 
   * `message`: A custom error string. **Required**.
 
-Returns `[ElasticAPM::Error]`.
+Returns `[String]` ID of the generated `[ElasticAPM::Error]` object.
 
 [float]
 [[api-context]]

data/docs/configuration.asciidoc

@@ -62,7 +62,7 @@ Some options can be set with `ENV` variables and all of them may be set in
 your source code.
 
 When setting values for lists using `ENV` variables, strings are split by comma
-eg `ELASTIC_APM_ENABLED_ENVIRONMENTS=development,production`.
+eg `ELASTIC_APM_CUSTOM_KEY_FILTERS="a,b" # => [/a/, /b/]`.
 
 [float]
 [[config-config-file]]
@@ -213,6 +213,21 @@ Whether or not to attach the request headers to transactions and errors.
 
 Whether or not to attach `ENV` from Rack to transactions and errors.
 
+[float]
+[[config-central-config]]
+==== `central_config`
+|============
+| Environment                  | `Config` key     | Default
+| `ELASTIC_APM_CENTRAL_CONFIG` | `central_config` | `true`
+|============
+
+Enable {kibana-ref}/agent-configuration.html[APM Agent Configuration via Kibana].
+If set to `true`, the client will poll the APM Server regularly for new agent configuration.
+
+Usually APM Server determines how often to poll, but if not the default interval is 5 minutes.
+
+NOTE: This feature requires APM Server v7.3 or later and that the APM Server is configured with `kibana.enabled: true`.
+
 [float]
 [[config-custom-key-filters]]
 ==== `custom_key_filters`
@@ -244,6 +259,10 @@ 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]*.
 
+NOTE: `global_labels` are supported as of APM server version 7.2. `default_tags` 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`.
+
 [float]
 [[config-disable-send]]
 ==== `disable_send`
@@ -337,6 +356,23 @@ Version number of the used framework.
 For Ruby on Rails and Sinatra, this defaults to the used version of the framework,
 otherwise, the default is `nil`.
 
+[float]
+[[config-global-labels]]
+==== `global_labels`
+
+[options="header"]
+|============
+| Environment                 | `Config` key    | Default  | Example
+| `ELASTIC_APM_GLOBAL_LABELS` | `global_labels` | `nil`    | `dept=engineering,rack=number8`
+|============
+
+Labels added to all events, with the format key=value[,key=value[,...]].
+
+NOTE: This option requires APM Server 7.2 or greater, and will have no effect when using older
+server versions. `default_tags` will eventually be deprecated but in the meantime, their value
+will override any `global_labels`. Please transition to using `global_labels` instead of
+`default_tags` in light of this deprecation.
+
 [float]
 [[config-hostname]]
 ==== `hostname`

data/docs/metrics.asciidoc

@@ -12,11 +12,15 @@ You can adjust the interval by setting <<config-metrics-interval,`metrics_interv
 
 The metrics will be stored in the `apm-*` index and have the `processor.event` property set to `metric`.
 
+[float]
+[[metrics-system]]
+=== System metrics
+
 **Note:** Metrics from the Ruby agent are Linux only for now.
 
 [float]
 [[metric-system.cpu.total.norm.pct]]
-=== `system.cpu.total.norm.pct`
+==== `system.cpu.total.norm.pct`
 
 * *Type:* Float
 * *Format:* Percent
@@ -26,7 +30,7 @@ normalised by the number of cores.
 
 [float]
 [[metric-system.memory.total]]
-=== `system.memory.total`
+==== `system.memory.total`
 
 * *Type:* Long
 * *Format:* Bytes
@@ -35,7 +39,7 @@ The total memory of the system in bytes.
 
 [float]
 [[metric-system.memory.actual.free]]
-=== `system.memory.actual.free`
+==== `system.memory.actual.free`
 
 * *Type:* Long
 * *Format:* Bytes
@@ -44,7 +48,7 @@ Free memory of the system in bytes.
 
 [float]
 [[metric-system.process.cpu.total.norm.pct]]
-=== `system.process.cpu.total.norm.pct`
+==== `system.process.cpu.total.norm.pct`
 
 * *Type:* Float
 * *Format:* Percent
@@ -54,7 +58,7 @@ This value is normalized by the number of CPU cores and it ranges from 0 to 100%
 
 [float]
 [[metric-system.process.memory.size]]
-=== `system.process.memory.size`
+==== `system.process.memory.size`
 
 * *Type:* Long
 * *Format:* Bytes
@@ -63,10 +67,77 @@ The total virtual memory the process has.
 
 [float]
 [[metric-system.process.memory.rss.bytes]]
-=== `system.process.memory.rss.bytes`
+==== `system.process.memory.rss.bytes`
 
 * *Type:* Long
 * *Format:* Bytes
 
 The Resident Set Size,
 the amount of memory the process occupies in main memory (RAM).
+
+[float]
+[[metrics-ruby]]
+=== Ruby Metrics
+
+[float]
+[[metric-ruby.gc.counts]]
+==== `ruby.gc.count`
+
+* *Type:* Integer
+* *Format:* Count
+
+The number of Garbage Collection runs since the process started.
+
+[float]
+[[metric-ruby.threads]]
+==== `ruby.threads`
+
+* *Type:* Integer
+* *Format:* Count
+
+The number of threads belonging to the current process.
+
+[float]
+[[metric-ruby.heap.slots.live]]
+==== `ruby.heap.slots.live`
+
+* *Type:* Integer
+* *Format:* Slots
+
+Current amount of heap slots that are live.
+
+**NB:** Not currently supported on JRuby.
+
+[float]
+[[metric-ruby.heap.slots.free]]
+==== `ruby.heap.slots.free`
+
+* *Type:* Integer
+* *Format:* Slots
+
+Current amount of heap slots that are free.
+
+**NB:** Not currently supported on JRuby.
+
+[float]
+[[metrics-ruby.heap.allocations.total]]
+==== `ruby.heap.allocations.total`
+
+* *Type:* Integer
+* *Format:* Objects
+
+Current amount of allocated objects on the heap.
+
+**NB:** Not currently supported on JRuby.
+
+[float]
+[[metrics-ruby.gc.time]]
+==== `ruby.gc.time`
+
+* *Type:* Float
+* *Format:* Seconds
+
+The total time spent in garbage collection.
+
+**NB:** You need to enable Ruby's GC Profiler for this to get reported.
+You can do this at any time when your application boots by calling `GC::Profiler.enable`.

data/lib/elastic_apm.rb

@@ -305,7 +305,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     # @param exception [Exception] The exception
     # @param context [Context] An optional [Context]
     # @param handled [Boolean] Whether the exception was rescued
-    # @return [Error] The generated [Error]
+    # @return [String] ID of the generated [Error]
     def report(exception, context: nil, handled: true)
       agent&.report(exception, context: context, handled: handled)
     end
@@ -314,7 +314,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     #
     # @param message [String] The message
     # @param context [Context] An optional [Context]
-    # @return [Error] The generated [Error]
+    # @return [String] ID of the generated [Error]
     def report_message(message, context: nil, **attrs)
       agent&.report_message(
         message,

data/lib/elastic_apm/agent.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
+require 'elastic_apm/error'
+
 require 'elastic_apm/context_builder'
 require 'elastic_apm/error_builder'
 require 'elastic_apm/stacktrace_builder'
-require 'elastic_apm/error'
+
+require 'elastic_apm/central_config'
 require 'elastic_apm/transport/base'
-require 'elastic_apm/spies'
 require 'elastic_apm/metrics'
 
+require 'elastic_apm/spies'
+
 module ElasticAPM
   # rubocop:disable Metrics/ClassLength
   # @api private
@@ -57,6 +61,7 @@ module ElasticAPM
       !!@instance
     end
 
+    # rubocop:disable Metrics/MethodLength
     def initialize(config)
       @config = config
 
@@ -64,6 +69,7 @@ module ElasticAPM
       @context_builder = ContextBuilder.new(config)
       @error_builder = ErrorBuilder.new(self)
 
+      @central_config = CentralConfig.new(config)
       @transport = Transport::Base.new(config)
       @instrumenter = Instrumenter.new(
         config,
@@ -71,6 +77,7 @@ module ElasticAPM
       ) { |event| enqueue event }
       @metrics = Metrics.new(config) { |event| enqueue event }
     end
+    # rubocop:enable Metrics/MethodLength
 
     attr_reader :config, :transport, :instrumenter,
       :stacktrace_builder, :context_builder, :error_builder, :metrics
@@ -189,6 +196,7 @@ module ElasticAPM
         handled: handled
       )
       enqueue error
+      error.id
     end
 
     def report_message(message, context: nil, backtrace: nil, **attrs)
@@ -199,6 +207,7 @@ module ElasticAPM
         **attrs
       )
       enqueue error
+      error.id
     end
 
     # filters

data/lib/elastic_apm/central_config.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'elastic_apm/central_config/cache_control'
+
+module ElasticAPM
+  # @api private
+  class CentralConfig
+    include Logging
+
+    # @api private
+    class ResponseError < InternalError
+      def initialize(response)
+        @response = response
+      end
+
+      attr_reader :response
+    end
+    class ClientError < ResponseError; end
+    class ServerError < ResponseError; end
+
+    DEFAULT_MAX_AGE = 300
+
+    def initialize(config)
+      @config = config
+      @modified_options = {}
+      @service_info = {
+        'service.name': config.service_name,
+        'service.environment': config.environment
+      }.to_json
+    end
+
+    attr_reader :config
+    attr_reader :scheduled_task, :promise # for specs
+
+    def start
+      return unless config.central_config?
+
+      fetch_and_apply_config
+    end
+
+    def fetch_and_apply_config
+      @promise =
+        Concurrent::Promise
+        .execute(&method(:fetch_config))
+        .on_success(&method(:handle_success))
+        .rescue(&method(:handle_error))
+    end
+
+    def stop
+      @scheduled_task&.cancel
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def fetch_config
+      resp = perform_request
+
+      case resp.status
+      when 200..299
+        resp
+      when 300..399
+        resp
+      when 400..499
+        raise ClientError, resp
+      when 500..599
+        raise ServerError, resp
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def assign(update)
+      # For each updated option, store the original value,
+      # unless already stored
+      update.each_key do |key|
+        @modified_options[key] ||= config.get(key.to_sym)&.value
+      end
+
+      # If the new update doesn't set a previously modified option,
+      # revert it to the original
+      @modified_options.each_key do |key|
+        next if update.key?(key)
+        update[key] = @modified_options.delete(key)
+      end
+
+      config.assign(update)
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def handle_success(resp)
+      if resp.status == 304
+        info 'Received 304 Not Modified'
+      else
+        update = JSON.parse(resp.body.to_s)
+        assign(update)
+
+        info 'Updated config from Kibana'
+      end
+
+      schedule_next_fetch(resp)
+
+      true
+    rescue Exception => e
+      error 'Failed to apply remote config, %s', e.inspect
+      debug { e.backtrace.join('\n') }
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def handle_error(error)
+      error(
+        'Failed fetching config: %s, trying again in %d seconds',
+        error.response.body, DEFAULT_MAX_AGE
+      )
+
+      assign({})
+
+      schedule_next_fetch(error.response)
+    end
+
+    def perform_request
+      Http.post(
+        config.server_url + '/agent/v1/config/',
+        body: @service_info,
+        headers: { etag: 1, content_type: 'application/json' }
+      )
+    end
+
+    def schedule_next_fetch(resp)
+      seconds =
+        if (cache_header = resp.headers['Cache-Control'])
+          CacheControl.new(cache_header).max_age
+        else
+          DEFAULT_MAX_AGE
+        end
+
+      @scheduled_task =
+        Concurrent::ScheduledTask
+        .execute(seconds, &method(:fetch_and_apply_config))
+    end
+  end
+end