elastic-apm 2.10.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dbd55033ad5acde5c178afb8af7e3c49aea9e64391901ddd571e6eb4a5db139
-  data.tar.gz: 0c117a6853b5e54af3f1ad2b42e0ff99e4d061c95da66a89ee35f525b7d11fd0
+  metadata.gz: 45fe1b55dccff365970dd59f2a4f58d9cb76141fd3651e7ce9c166b796bfce0a
+  data.tar.gz: 66a2df97b05471613e7d1b5eecdb739ccbf94514b15730cb065153c7128503da
 SHA512:
-  metadata.gz: 4e5a48afa71841e62e52917e71d6201b68d4b7d36636b93e5b0076999e5a6b13a31f6dac0f39501245122d143497648dafef50fa02a15a30dc767482b4a1181d
-  data.tar.gz: 671f26c821de9e4090aef5f1af8855729d86f4b3b1ef824d3f5114231e9ecb34ef2e1aa81cb9b84ffcfab7a307418bf95a90df4e034075c5d9bc56798344b31c
+  metadata.gz: e542f184535be90fee811ceee0fd404f65b59575b0e90a8dc8023807ec5b535f9d1c084b7654f5c59fed9d5521a2cbf5f2bd70dac8691db009be1dd24b07be5f
+  data.tar.gz: 7d87ebdbbfc32727017f6f0fa8451640ac3fef289366bc3a077899d874bb346a3b94dbadafe96596f2b1a8163c42d79b1b41ce940c6e1fd8fb358fc96767ca84

data/.ci/Jenkinsfile

@@ -23,6 +23,7 @@ pipeline {
     DOCKER_SECRET = 'secret/apm-team/ci/docker-registry/prod'
     GITHUB_CHECK_ITS_NAME = 'Integration Tests'
     ITS_PIPELINE = 'apm-integration-tests-selector-mbp/master'
+    RELEASE_SECRET = 'secret/apm-team/ci/apm-agent-ruby-rubygems-release'
   }
   options {
     timeout(time: 2, unit: 'HOURS')
@@ -178,6 +179,39 @@ pipeline {
           githubNotify(context: "${env.GITHUB_CHECK_ITS_NAME}", description: "${env.GITHUB_CHECK_ITS_NAME} ...", status: 'PENDING', targetUrl: "${env.JENKINS_URL}search/?q=${env.ITS_PIPELINE.replaceAll('/','+')}")
         }
       }
+      stage('Release') {
+        options { skipDefaultCheckout() }
+        environment {
+          RUBY_DOCKER_TAG = 'ruby:2.6'
+        }
+        when {
+          beforeAgent true
+          anyOf {
+            tag pattern: 'v\\d+.*', comparator: 'REGEXP'
+          }
+        }
+        steps {
+          withGithubNotify(context: 'Release') {
+            deleteDir()
+            unstash 'source'
+            script {
+              dir(BASE_DIR){
+                docker.image("${env.RUBY_DOCKER_TAG}").inside('-v /etc/passwd:/etc/passwd -v ${HOME}/.ssh:${HOME}/.ssh') {
+                  withEnv(["HOME=${env.WORKSPACE}/${env.BASE_DIR ?: ''}"]) {
+                    rubygemsLogin.withApi(secret: "${env.RELEASE_SECRET}") {
+                      sshagent(['f6c7695a-671e-4f4f-a331-acdce44ff9ba']) {
+                        sh '.ci/prepare-git-context.sh'
+                        sh 'gem install rake yard rspec'
+                        sh 'rake release'
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
     post {
       cleanup {

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

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -exo pipefail
+
+# Enable git+ssh. Env variables are created on the fly with the gitCheckout
+git config remote.origin.url "git@github.com:${ORG_NAME}/${REPO_NAME}.git"
+
+# Enable to fetch branches when cloning with a detached and shallow clone
+git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
+
+# Force the git user details when pushing using the last commit details
+USER_MAIL=$(git log -1 --pretty=format:'%ae')
+USER_NAME=$(git log -1 --pretty=format:'%an')
+git config --global user.email "${USER_MAIL}"
+git config --global user.name "${USER_NAME}"
+
+# Checkout the branch as it's detached based by default.
+# See https://issues.jenkins-ci.org/browse/JENKINS-33171
+git fetch --all
+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}"

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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.11.0 (2019-09-23)
+
+### Added
+
+- Add `Rails` module with `#start` method to run Rails setup explicitly ([#522](https://github.com/elastic/apm-agent-ruby/pull/522))
+- Support for log/trace correlation ([#527](https://github.com/elastic/apm-agent-ruby/pull/527))
+
+### Changed
+
+- Split dot-separated `span.type` into `.type`, `.subtype` and `.action` (auto-upgrades dot style) ([#531](https://github.com/elastic/apm-agent-ruby/pull/531))
+
 ## 2.10.1
 
 ### Fixed
@@ -11,11 +22,14 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 - Fixed loading options from a config file specified by `ELASTIC_APM_CONFIG_FILE` ([#518](https://github.com/elastic/apm-agent-ruby/pull/518))
 - Fixed an issue with CentralConfig polling not starting ([#525](https://github.com/elastic/apm-agent-ruby/pull/525))
 
+### Added
+
+- Support for chained exceptions ([#488](https://github.com/elastic/apm-agent-ruby/pull/488))
+
 ## 2.10.0
 
 ### Added
 
-- Support for chained exceptions ([#488](https://github.com/elastic/apm-agent-ruby/pull/488))
 - 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))

data/docs/api.asciidoc

@@ -30,9 +30,10 @@ ElasticAPM.start(server_url: 'http://localhost:8200')
   * `config`: An optional hash or `ElasticAPM::Config` instance with configuration
   options.  See <<configuration,Configuration>>.
 
-If you are using <<getting-started-rails,Ruby on Rails>> this is done
-automatically for you.
-If not see <<getting-started-rack,Getting started with Rack>>.
+If you are using <<getting-started-rails,Ruby on Rails>> this is done automatically for you.
+If you choose not to require the `elastic_apm` gem and instead want to start the
+agent and hook into Rails manually, see <<rails-start,hooking into Rails explicitly>>.
+If you're not using Rails, see <<getting-started-rack,Getting started with Rack>>.
 
 [float]
 [[api-agent-stop]]
@@ -140,7 +141,9 @@ end
 Arguments:
 
   * `name`: A name for your span. **Required**.
-  * `type`: The type of work eg. `db.postgresql.query`.
+  * `type`: The type of span eg. `db`.
+  * `subtype`: The subtype of span eg. `postgresql`.
+  * `action`: The action type of span eg. `connect` or `query`.
   * `context`: An instance of `Span::Context`.
   * `include_stacktrace`: Whether or not to collect a Stacktrace.
   * `&block`: An optional block to wrap with the span.
@@ -163,7 +166,9 @@ Wraps a block in a Span.
 Arguments:
 
   * `name`: A name for your span. **Required**.
-  * `type`: The type of work eg. `db.postgresql.query`.
+  * `type`: The type of span eg. `db`.
+  * `subtype`: The subtype of span eg. `postgresql`.
+  * `action`: The action type of span eg. `connect` or `query`.
   * `context`: An instance of `Span::Context`.
   * `include_stacktrace`: Whether or not to collect a Stacktrace.
   * `&block`: An optional block to wrap with the span.
@@ -186,6 +191,18 @@ Arguments:
 
 Returns the built context.
 
+[float]
+[[rails-start]]
+=== Manually hooking into Rails
+
+Start the agent and hook into Rails explicitly. This is useful if you skip requiring
+the gem and using the `Railtie`.
+
+[source,ruby]
+----
+ElasticAPM::Rails.start(server_url: 'http://localhost:8200')
+----
+
 [float]
 === Errors
 

data/docs/index.asciidoc

@@ -18,6 +18,8 @@ include::./getting-started-rack.asciidoc[]
 
 include::./configuration.asciidoc[]
 
+include::./log-correlation.asciidoc[]
+
 include::./metrics.asciidoc[]
 
 include::./advanced.asciidoc[]

data/docs/log-correlation.asciidoc

@@ -0,0 +1,96 @@
+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::[]
+
+[[log-correlation]]
+== Log correlation
+
+Trace/log correlation can be set up in three different ways.
+
+[float]
+[[rails-tagged-logging]]
+==== Rails TaggedLogging
+
+Rails applications configured with an `ActiveSupport::TaggedLogging` logger can append the correlation IDs to log output.
+For example in your `config/environments/production.rb` file, add the following:
+
+[source,ruby]
+----
+config.log_tags = [ :request_id, proc { ElasticAPM.log_ids } ]
+
+# Logs will then include the correlation IDs:
+#
+# [transaction.id=c1ae84c8642891eb trace.id=b899fc7915e801b7558e336e4952bafe] Started GET "/" for 127.0.0.1 at 2019-09-16 11:28:46 +0200
+# [transaction.id=c1ae84c8642891eb trace.id=b899fc7915e801b7558e336e4952bafe] Processing by ApplicationController#index as HTML
+# [transaction.id=c1ae84c8642891eb trace.id=b899fc7915e801b7558e336e4952bafe]   Rendering text template
+# [transaction.id=c1ae84c8642891eb trace.id=b899fc7915e801b7558e336e4952bafe]   Rendered text template (Duration: 0.1ms | Allocations: 17)
+# [transaction.id=c1ae84c8642891eb trace.id=b899fc7915e801b7558e336e4952bafe] Completed 200 OK in 1ms (Views: 0.4ms | Allocations: 171)
+----
+**Note:** Because of the order in which Rails computes the tags for logs and executes the request, the span id might not be included.
+Consider using `Lograge` instead, as the timing of its hooks allow the span id to be captured in logs.
+
+[float]
+[[lograge]]
+==== Lograge
+
+With `lograge` enabled and set up in your Rails application, modify the `custom_options` block in the Rails environment
+configuration file. The returned `Hash` will be included in the structured Lograge logs.
+
+[source,ruby]
+----
+config.lograge.custom_options = lambda do |event|
+  ElasticAPM.log_ids do |transaction_id, span_id, trace_id|
+    { :'transaction.id' => transaction_id,
+      :'span.id' => span_id,
+      :'trace.id' => trace_id }
+  end
+end
+
+# Logs will then include the correlation IDs:
+#
+# I, [2019-09-16T11:59:05.439602 #8674]  INFO -- : method=GET path=/ format=html controller=ApplicationController action=index status=200 duration=0.36 view=0.20 transaction.id=56a9186a9257aa08 span.id=8e84a786ab0abbb2 trace.id=1bbab8ac4c7c9584f53eb882ff0dfdd8
+----
+
+You can also nest the ids in a separate document as in the following example:
+
+[source,ruby]
+----
+config.lograge.custom_options = lambda do |event|
+  ElasticAPM.log_ids do |transaction_id, span_id, trace_id|
+    { elastic_apm: { :'transaction.id' => transaction_id,
+                     :'span.id' => span_id,
+                     :'trace.id' => trace_id } }
+  end
+end
+
+# Logs will then include the correlation IDs in a separate document:
+#
+# I, [2019-09-16T13:39:35.962603 #9327]  INFO -- : method=GET path=/ format=html controller=ApplicationController action=index status=200 duration=0.37 view=0.20 elastic_apm={:transaction_id=>"2fb84f5d0c48a296", :span_id=>"2e5c5a7c85f83be7", :trace_id=>"43e1941c4a6fff343a4e018ff7b92000"}
+----
+
+[float]
+[[manually-formatting-logs]]
+==== Manually formatting logs
+
+You can access the correlation ids directly and add them through the log formatter.
+
+[source,ruby]
+----
+require 'elastic_apm'
+require 'logger'
+
+logger = Logger.new(STDOUT)
+logger.progname = 'TestRubyApp'
+logger.formatter  = proc do |severity, datetime, progname, msg|
+  "[#{datetime}][#{progname}][#{severity}][#{ElasticAPM.log_ids}] #{msg}\n"
+end
+
+# Logs will then include the correlation IDs:
+#
+# [2019-09-16 11:54:59 +0200][RailsTestApp][INFO][transaction.id=3b92edcccc0a6d1e trace.id=1275686e35de91f776557637e799651e] Started GET "/" for 127.0.0.1 at 2019-09-16 11:54:59 +0200
+# [2019-09-16 11:54:59 +0200][RailsTestApp][INFO][transaction.id=3b92edcccc0a6d1e trace.id=1275686e35de91f776557637e799651e] Processing by ApplicationController#index as HTML
+# [2019-09-16 11:54:59 +0200][RailsTestApp][INFO][transaction.id=3b92edcccc0a6d1e span.id=3bde4e9c85ab359c trace.id=1275686e35de91f776557637e799651e]   Rendering text template
+# [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)
+----

data/lib/elastic_apm.rb

@@ -62,6 +62,26 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       agent&.current_span
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # 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.
+    # @return [String] Unless block given
+    def log_ids
+      trace_id = (current_transaction || current_span)&.trace_id
+      if block_given?
+        return yield(current_transaction&.id, current_span&.id, trace_id)
+      end
+
+      ids = []
+      ids << "transaction.id=#{current_transaction.id}" if current_transaction
+      ids << "span.id=#{current_span.id}" if current_span
+      ids << "trace.id=#{trace_id}" if trace_id
+      ids.join(' ')
+    end
+    # rubocop:enable Metrics/AbcSize
+
     # Start a new transaction or return the currently running
     #
     # @param name [String] A description of the transaction, eg
@@ -207,16 +227,21 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
 
     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"`
-    # @param type [String] The kind of span, eq `db.mysql2.query`
+    # @param type [String] The span type, eq `db`
+    # @param subtype [String] The span subtype, eq `postgresql`
+    # @param action [String] The span action type, eq `connect` or `query`
     # @param context [Span::Context] Context information about the span
     # @param include_stacktrace [Boolean] Whether or not to capture a stacktrace
     # @return [Span]
     def start_span(
       name,
       type = nil,
+      subtype: nil,
+      action: nil,
       context: nil,
       include_stacktrace: true,
       trace_context: nil
@@ -224,6 +249,8 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       agent&.start_span(
         name,
         type,
+        subtype: subtype,
+        action: action,
         context: context,
         trace_context: trace_context
       ).tap do |span|
@@ -233,6 +260,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
         span.original_backtrace ||= caller
       end
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
 
     # Ends the current span
     #
@@ -241,7 +269,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
       agent&.end_span
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
     # Wrap a block in a Span, ending it after the block
     #
     # @param name [String] A description of the span, eq `SELECT FROM "users"`
@@ -253,6 +281,8 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
     def with_span(
       name,
       type = nil,
+      subtype: nil,
+      action: nil,
       context: nil,
       include_stacktrace: true,
       trace_context: nil
@@ -269,6 +299,8 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
           start_span(
             name,
             type,
+            subtype: subtype,
+            action: action,
             context: context,
             include_stacktrace: include_stacktrace,
             trace_context: trace_context
@@ -278,7 +310,7 @@ module ElasticAPM # rubocop:disable Metrics/ModuleLength
         end_span
       end
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
 
     # Build a [Context] from a Rack `env`. The context may include information
     # about the request, response, current user and more

data/lib/elastic_apm/agent.rb

@@ -159,9 +159,12 @@ module ElasticAPM
       instrumenter.end_transaction(result)
     end
 
+    # rubocop:disable Metrics/ParameterLists
     def start_span(
       name = nil,
       type = nil,
+      subtype: nil,
+      action: nil,
       backtrace: nil,
       context: nil,
       trace_context: nil
@@ -169,11 +172,14 @@ module ElasticAPM
       instrumenter.start_span(
         name,
         type,
+        subtype: subtype,
+        action: action,
         backtrace: backtrace,
         context: context,
         trace_context: trace_context
       )
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def end_span
       instrumenter.end_span

data/lib/elastic_apm/config.rb

@@ -234,7 +234,7 @@ module ElasticAPM
     end
 
     def app_type?(app)
-      if defined?(Rails::Application) && app.is_a?(Rails::Application)
+      if defined?(::Rails::Application) && app.is_a?(::Rails::Application)
         return :rails
       end
 
@@ -255,15 +255,15 @@ module ElasticAPM
     def set_rails(app) # rubocop:disable Metrics/AbcSize
       self.service_name ||= format_name(service_name || rails_app_name(app))
       self.framework_name ||= 'Ruby on Rails'
-      self.framework_version ||= Rails::VERSION::STRING
-      self.logger ||= Rails.logger
+      self.framework_version ||= ::Rails::VERSION::STRING
+      self.logger ||= ::Rails.logger
 
-      self.__root_path = Rails.root.to_s
+      self.__root_path = ::Rails.root.to_s
       self.__view_paths = app.config.paths['app/views'].existent
     end
 
     def rails_app_name(app)
-      if Rails::VERSION::MAJOR >= 6
+      if ::Rails::VERSION::MAJOR >= 6
         app.class.module_parent_name
       else
         app.class.parent_name

data/lib/elastic_apm/instrumenter.rb

@@ -134,9 +134,12 @@ module ElasticAPM
 
     # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/ParameterLists
     def start_span(
       name,
       type = nil,
+      subtype: nil,
+      action: nil,
       backtrace: nil,
       context: nil,
       trace_context: nil
@@ -155,6 +158,8 @@ module ElasticAPM
 
       span = Span.new(
         name: name,
+        subtype: subtype,
+        action: action,
         transaction_id: transaction.id,
         trace_context: trace_context || parent.trace_context.child,
         type: type,
@@ -170,6 +175,7 @@ module ElasticAPM
 
       span.start
     end
+    # rubocop:enable Metrics/ParameterLists
     # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity
     # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
 

data/lib/elastic_apm/normalizers/action_controller.rb

@@ -6,11 +6,14 @@ module ElasticAPM
       # @api private
       class ProcessActionNormalizer < Normalizer
         register 'process_action.action_controller'
-        TYPE = 'app.controller.action'
+
+        TYPE = 'app'
+        SUBTYPE = 'controller'
+        ACTION = 'action'
 
         def normalize(transaction, _name, payload)
           transaction.name = endpoint(payload)
-          [transaction.name, TYPE, nil]
+          [transaction.name, TYPE, SUBTYPE, ACTION, nil]
         end
 
         private

data/lib/elastic_apm/normalizers/action_mailer.rb

@@ -6,10 +6,13 @@ module ElasticAPM
       # @api private
       class ProcessActionNormalizer < Normalizer
         register 'process.action_mailer'
-        TYPE = 'app.mailer.action'
+
+        TYPE = 'app'
+        SUBTYPE = 'mailer'
+        ACTION = 'action'
 
         def normalize(_transaction, _name, payload)
-          [endpoint(payload), TYPE, nil]
+          [endpoint(payload), TYPE, SUBTYPE, ACTION, nil]
         end
 
         private

data/lib/elastic_apm/normalizers/action_view.rb

@@ -7,8 +7,8 @@ module ElasticAPM
       class RenderNormalizer < Normalizer
         private
 
-        def normalize_render(payload, type)
-          [path_for(payload[:identifier]), type, nil]
+        def normalize_render(payload, type, subtype, action)
+          [path_for(payload[:identifier]), type, subtype, action, nil]
         end
 
         def path_for(path)
@@ -41,30 +41,35 @@ module ElasticAPM
       # @api private
       class RenderTemplateNormalizer < RenderNormalizer
         register 'render_template.action_view'
-        TYPE = 'template.view'
+        TYPE = 'template'
+        SUBTYPE = 'view'
 
         def normalize(_transaction, _name, payload)
-          normalize_render(payload, TYPE)
+          normalize_render(payload, TYPE, SUBTYPE, nil)
         end
       end
 
       # @api private
       class RenderPartialNormalizer < RenderNormalizer
         register 'render_partial.action_view'
-        TYPE = 'template.view.partial'
+        TYPE = 'template'
+        SUBTYPE = 'view'
+        ACTION = 'partial'
 
         def normalize(_transaction, _name, payload)
-          normalize_render(payload, TYPE)
+          normalize_render(payload, TYPE, SUBTYPE, ACTION)
         end
       end
 
       # @api private
       class RenderCollectionNormalizer < RenderNormalizer
         register 'render_collection.action_view'
-        TYPE = 'template.view.collection'
+        TYPE = 'template'
+        SUBTYPE = 'view'
+        ACTION = 'collection'
 
         def normalize(_transaction, _name, payload)
-          normalize_render(payload, TYPE)
+          normalize_render(payload, TYPE, SUBTYPE, ACTION)
         end
       end
     end

data/lib/elastic_apm/normalizers/active_record.rb

@@ -9,10 +9,13 @@ module ElasticAPM
       class SqlNormalizer < Normalizer
         register 'sql.active_record'
 
+        TYPE = 'db'
+        ACTION = 'sql'
+
         def initialize(*args)
           super
 
-          @type = format('db.%s.sql', lookup_adapter || 'unknown').freeze
+          @subtype = lookup_adapter || 'unknown'
           @summarizer = SqlSummarizer.new
         end
 
@@ -22,7 +25,7 @@ module ElasticAPM
           name = summarize(payload[:sql]) || payload[:name]
           context =
             Span::Context.new(db: { statement: payload[:sql], type: 'sql' })
-          [name, @type, context]
+          [name, TYPE, @subtype, ACTION, context]
         end
 
         private

data/lib/elastic_apm/rails.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'elastic_apm/subscriber'
+
+module ElasticAPM
+  # Module for explicitly starting the ElasticAPM agent and hooking into Rails.
+  # It is recommended to use the Railtie instead.
+  module Rails
+    extend self
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # Start the ElasticAPM agent and hook into Rails.
+    # Note that the agent won't be started if the Rails console is being used.
+    #
+    # @param config [Config, Hash] An instance of Config or a Hash config.
+    # @return [true, nil] true if the agent was started, nil otherwise.
+    def start(config)
+      config = Config.new(config) unless config.is_a?(Config)
+      if (reason = should_skip?(config))
+        unless config.disable_start_message?
+          config.logger.info "Skipping because: #{reason}. " \
+            "Start manually with `ElasticAPM.start'"
+        end
+        return
+      end
+
+      ElasticAPM.start(config).tap do |agent|
+        attach_subscriber(agent)
+      end
+
+      if ElasticAPM.running? &&
+         !ElasticAPM.agent.config.disabled_spies.include?('action_dispatch')
+        require 'elastic_apm/spies/action_dispatch'
+      end
+      ElasticAPM.running?
+    rescue StandardError => e
+      config.logger.error format('Failed to start: %s', e.message)
+      config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    private
+
+    def should_skip?(_config)
+      if ::Rails.const_defined? 'Rails::Console'
+        return 'Rails console'
+      end
+
+      nil
+    end
+
+    def attach_subscriber(agent)
+      return unless agent
+
+      agent.instrumenter.subscriber = ElasticAPM::Subscriber.new(agent)
+    end
+  end
+end

data/lib/elastic_apm/railtie.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'elastic_apm/subscriber'
+require 'elastic_apm/rails'
 
 module ElasticAPM
   # @api private
-  class Railtie < Rails::Railtie
+  class Railtie < ::Rails::Railtie
     config.elastic_apm = ActiveSupport::OrderedOptions.new
 
     Config.schema.each do |key, args|
@@ -18,55 +18,13 @@ module ElasticAPM
 
         # Prepend Rails.root to log_path if present
         if c.log_path && !c.log_path.start_with?('/')
-          c.log_path = Rails.root.join(c.log_path)
+          c.log_path = ::Rails.root.join(c.log_path)
         end
       end
 
-      if start(config)
+      if Rails.start(config)
         app.middleware.insert 0, Middleware
       end
     end
-
-    config.after_initialize do
-      if ElasticAPM.running? &&
-         !ElasticAPM.agent.config.disabled_spies.include?('action_dispatch')
-        require 'elastic_apm/spies/action_dispatch'
-      end
-    end
-
-    private
-
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-    def start(config)
-      if (reason = should_skip?(config))
-        unless config.disable_start_message?
-          config.logger.info "Skipping because: #{reason}. " \
-            "Start manually with `ElasticAPM.start'"
-        end
-        return
-      end
-
-      ElasticAPM.start(config).tap do |agent|
-        attach_subscriber(agent)
-      end
-    rescue StandardError => e
-      config.logger.error format('Failed to start: %s', e.message)
-      config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
-    end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-
-    def should_skip?(_config)
-      if Rails.const_defined? 'Rails::Console'
-        return 'Rails console'
-      end
-
-      nil
-    end
-
-    def attach_subscriber(agent)
-      return unless agent
-
-      agent.instrumenter.subscriber = ElasticAPM::Subscriber.new(agent)
-    end
   end
 end

data/lib/elastic_apm/span.rb

@@ -14,17 +14,26 @@ module ElasticAPM
 
     DEFAULT_TYPE = 'custom'
 
-    # rubocop:disable Metrics/ParameterLists
+    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
     def initialize(
       name:,
       transaction_id:,
       trace_context:,
       type: nil,
+      subtype: nil,
+      action: nil,
       context: nil,
       stacktrace_builder: nil
     )
       @name = name
-      @type = type || DEFAULT_TYPE
+
+      if subtype.nil? && type&.include?('.')
+        @type, @subtype, @action = type.split('.')
+      else
+        @type = type || DEFAULT_TYPE
+        @subtype = subtype
+        @action = action
+      end
 
       @transaction_id = transaction_id
       @trace_context = trace_context
@@ -32,10 +41,23 @@ module ElasticAPM
       @context = context || Span::Context.new
       @stacktrace_builder = stacktrace_builder
     end
-    # rubocop:enable Metrics/ParameterLists
-
-    attr_accessor :name, :type, :original_backtrace, :trace_context
-    attr_reader :context, :stacktrace, :duration, :timestamp, :transaction_id
+    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+
+    attr_accessor(
+      :action,
+      :name,
+      :original_backtrace,
+      :subtype,
+      :trace_context,
+      :type
+    )
+    attr_reader(
+      :context,
+      :duration,
+      :stacktrace,
+      :timestamp,
+      :transaction_id
+    )
 
     # life cycle
 

data/lib/elastic_apm/spies/faraday.rb

@@ -5,6 +5,9 @@ module ElasticAPM
   module Spies
     # @api private
     class FaradaySpy
+      TYPE = 'ext'
+      SUBTYPE = 'faraday'
+
       def self.without_net_http
         return yield unless defined?(NetHTTPSpy)
 
@@ -37,9 +40,13 @@ module ElasticAPM
                    end
 
             name = "#{method.upcase} #{host}"
-            type = "ext.faraday.#{method}"
 
-            ElasticAPM.with_span name, type do |span|
+            ElasticAPM.with_span(
+              name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: method.to_s
+            ) do |span|
               ElasticAPM::Spies::FaradaySpy.without_net_http do
                 trace_context = span&.trace_context || transaction.trace_context
 

data/lib/elastic_apm/spies/http.rb

@@ -5,6 +5,9 @@ module ElasticAPM
   module Spies
     # @api private
     class HTTPSpy
+      TYPE = 'ext'
+      SUBTYPE = 'http_rb'
+
       # rubocop:disable Metrics/MethodLength
       def install
         ::HTTP::Client.class_eval do
@@ -19,9 +22,13 @@ module ElasticAPM
             host = req.uri.host
 
             name = "#{method} #{host}"
-            type = "ext.http_rb.#{method}"
 
-            ElasticAPM.with_span name, type do |span|
+            ElasticAPM.with_span(
+              name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: method
+            ) do |span|
               trace_context = span&.trace_context || transaction.trace_context
               req['Elastic-Apm-Traceparent'] = trace_context.to_header
               perform_without_apm(req, options)

data/lib/elastic_apm/spies/mongo.rb

@@ -14,7 +14,9 @@ module ElasticAPM
 
       # @api private
       class Subscriber
-        TYPE = 'db.mongodb.query'
+        TYPE = 'db'
+        SUBTYPE = 'mongodb'
+        ACTION = 'query'
 
         def initialize
           @events = {}
@@ -51,6 +53,8 @@ module ElasticAPM
             ElasticAPM.start_span(
               name,
               TYPE,
+              subtype: SUBTYPE,
+              action: ACTION,
               context: build_context(event)
             )
 

data/lib/elastic_apm/spies/net_http.rb

@@ -6,6 +6,8 @@ module ElasticAPM
     # @api private
     class NetHTTPSpy
       KEY = :__elastic_apm_net_http_disabled
+      TYPE = 'ext'
+      SUBTYPE = 'net_http'
 
       # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       class << self
@@ -46,9 +48,13 @@ module ElasticAPM
             host ||= address
 
             name = "#{method} #{host}"
-            type = "ext.net_http.#{method}"
 
-            ElasticAPM.with_span name, type do |span|
+            ElasticAPM.with_span(
+              name,
+              TYPE,
+              subtype: SUBTYPE,
+              action: method.to_s
+            ) do |span|
               trace_context = span&.trace_context || transaction.trace_context
               req['Elastic-Apm-Traceparent'] = trace_context.to_header
               request_without_apm(req, body, &block)

data/lib/elastic_apm/subscriber.rb

@@ -29,8 +29,8 @@ module ElasticAPM
 
     Notification = Struct.new(:id, :span)
 
+    # rubocop:disable Metrics/MethodLength
     def start(name, id, payload)
-      # debug "AS::Notification#start:#{name}:#{id}"
       return unless (transaction = @agent.current_transaction)
 
       normalized = @normalizers.normalize(transaction, name, payload)
@@ -39,12 +39,20 @@ module ElasticAPM
         if normalized == :skip
           nil
         else
-          name, type, context = normalized
-          @agent.start_span(name, type, context: context)
+          name, type, subtype, action, context = normalized
+
+          @agent.start_span(
+            name,
+            type,
+            subtype: subtype,
+            action: action,
+            context: context
+          )
         end
 
       transaction.notifications << Notification.new(id, span)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def finish(_name, id, _payload)
       # debug "AS::Notification#finish:#{name}:#{id}"

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

@@ -13,7 +13,7 @@ module ElasticAPM
 
         attr_reader :context_serializer
 
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def build(span)
           {
             span: {
@@ -21,7 +21,7 @@ module ElasticAPM
               transaction_id: span.transaction_id,
               parent_id: span.parent_id,
               name: keyword_field(span.name),
-              type: keyword_field(span.type),
+              type: join_type(span),
               duration: ms(span.duration),
               context: context_serializer.build(span.context),
               stacktrace: span.stacktrace.to_a,
@@ -30,7 +30,7 @@ module ElasticAPM
             }
           }
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
 
         # @api private
         class ContextSerializer < Serializer
@@ -66,6 +66,14 @@ module ElasticAPM
             }
           end
         end
+
+        private
+
+        def join_type(span)
+          combined = [span.type, span.subtype, span.action]
+          combined.compact!
+          combined.join '.'
+        end
       end
     end
   end

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 2.11.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -59,6 +59,7 @@ files:
 - ".ci/jobs/apm-agent-ruby.yml"
 - ".ci/jobs/defaults.yml"
 - ".ci/linting.groovy"
+- ".ci/prepare-git-context.sh"
 - ".gitignore"
 - ".hound.yml"
 - ".pre-commit-config.yaml"
@@ -92,6 +93,7 @@ files:
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc
 - docs/introduction.asciidoc
+- docs/log-correlation.asciidoc
 - docs/metrics.asciidoc
 - docs/opentracing.asciidoc
 - docs/release-notes.asciidoc
@@ -139,6 +141,7 @@ files:
 - lib/elastic_apm/normalizers/action_view.rb
 - lib/elastic_apm/normalizers/active_record.rb
 - lib/elastic_apm/opentracing.rb
+- lib/elastic_apm/rails.rb
 - lib/elastic_apm/railtie.rb
 - lib/elastic_apm/span.rb
 - lib/elastic_apm/span/context.rb
@@ -206,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The official Elastic APM agent for Ruby