elastic-apm 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaf3f0eada3b3bfe036dc55802688666e3df0ee48848b45dd73aa6861e625dc6
-  data.tar.gz: feb50b6f3d2da29af6591f31a62ea95189ab64868fb5403e3d85ceec548868d8
+  metadata.gz: 37a020cb4be0022f87d148e568cb6c755bb7464c401141d3f9de743b4f960132
+  data.tar.gz: e7d34598029f879e51e25b88fa1e23048290e51a21a664818f50b8c3b29bbc34
 SHA512:
-  metadata.gz: b7bcd197586b7782f25fa814ec0430c33f7b21abaa6b79c81fe93ee07654df1448eea4257f8c29b6f6dce1b7778c0b88f6e825a1338bdba591fd4934b9bcaa09
-  data.tar.gz: 181bf8aa045473ef55cb794199638722e1bd7f142e558077928a94e03ca75812d21633c6781e734d7029b12e9b4d54232498f604a6be26f70daaffcd1e91f03e
+  metadata.gz: 0f604ede3b49fc35a5560e28841e5d7bcb6c209f3a9c064dbfcfed0db158e75d501dbaec057d148f5254f6077a73de81ae5134ea4001995b614a547edfcb47aa
+  data.tar.gz: 6f2911e3d564ba2967bf4f3ae583b105c4f56a03014ef47ccfc65dd1ff05d9b6b43530044ed8abff694e38b27db431b50f94d5b0bf69448f52b4b4f29d42fa6a

data/.ci/.jenkins_exclude.yml

@@ -1,5 +1,5 @@
 exclude:
-  - RUBY_VERSION: ruby:2.7-rc
+  - RUBY_VERSION: ruby:2.7
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: jruby:9.2
     FRAMEWORK: rails-4.2
@@ -26,7 +26,7 @@ exclude:
     FRAMEWORK: rails-6.0
 
   # Only test master on newest ruby
-  - RUBY_VERSION: ruby:2.7-rc
+  - RUBY_VERSION: ruby:2.6
     FRAMEWORK: rails-master
   - RUBY_VERSION: ruby:2.5
     FRAMEWORK: rails-master
@@ -70,7 +70,7 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
     FRAMEWORK: sinatra-master
 
-  - RUBY_VERSION: ruby:2.7-rc
+  - RUBY_VERSION: ruby:2.6
     FRAMEWORK: grape-master
   - RUBY_VERSION: ruby:2.5
     FRAMEWORK: grape-master
@@ -93,7 +93,7 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
     FRAMEWORK: grape-master
 
-  - RUBY_VERSION: ruby:2.7-rc
+  - RUBY_VERSION: ruby:2.6
     FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
   - RUBY_VERSION: ruby:2.5
     FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0

data/.ci/.jenkins_ruby.yml

@@ -1,5 +1,5 @@
 RUBY_VERSION:
-  - ruby:2.7-rc
+  - ruby:2.7
   - ruby:2.6
   - ruby:2.5
   - ruby:2.4

data/.ci/Jenkinsfile

@@ -24,6 +24,7 @@ pipeline {
     ITS_PIPELINE = 'apm-integration-tests-selector-mbp/master'
     RELEASE_SECRET = 'secret/apm-team/ci/apm-agent-ruby-rubygems-release'
     OPBEANS_REPO = 'opbeans-ruby'
+    REFERENCE_REPO = '/var/lib/jenkins/.git-references/apm-agent-ruby.git'
   }
   options {
     timeout(time: 2, unit: 'HOURS')
@@ -51,7 +52,7 @@ pipeline {
       steps {
         pipelineManager([ cancelPreviousRunningBuilds: [ when: 'PR' ] ])
         deleteDir()
-        gitCheckout(basedir: "${BASE_DIR}", githubNotifyFirstTimeContributor: true)
+        gitCheckout(basedir: "${BASE_DIR}", githubNotifyFirstTimeContributor: true, reference: "${env.REFERENCE_REPO}")
         stash allowEmpty: true, name: 'source', useDefaultExcludes: false
       }
     }
@@ -203,7 +204,7 @@ pipeline {
                 unstash 'source'
                 script {
                   dir(BASE_DIR){
-                    docker.image("${env.RUBY_DOCKER_TAG}").inside('-v /etc/passwd:/etc/passwd -v ${HOME}/.ssh:${HOME}/.ssh') {
+                    docker.image("${env.RUBY_DOCKER_TAG}").inside('-v ${REFERENCE_REPO}:${REFERENCE_REPO} -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']) {
@@ -228,7 +229,8 @@ pipeline {
               dir("${OPBEANS_REPO}"){
                 git credentialsId: 'f6c7695a-671e-4f4f-a331-acdce44ff9ba',
                     url: "git@github.com:elastic/${OPBEANS_REPO}.git"
-                sh script: ".ci/bump-version.sh ${env.BRANCH_NAME}", label: 'Bump version'
+                // It's required to transform the tag value to the gem version
+                sh script: ".ci/bump-version.sh ${env.BRANCH_NAME.replaceAll('^v', '')}", label: 'Bump version'
                 // The opbeans pipeline will trigger a release for the master branch
                 gitPush()
                 // The opbeans pipeline will trigger a release for the release tag

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

@@ -32,6 +32,7 @@
           recursive: true
           parent-credentials: true
           timeout: 100
+          reference-repo: /var/lib/jenkins/.git-references/apm-agent-ruby.git
         timeout: '15'
         use-author: true
         wipe-workspace: 'True'

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

@@ -33,6 +33,7 @@
           recursive: true
           parent-credentials: true
           timeout: 100
+          reference-repo: /var/lib/jenkins/.git-references/apm-agent-ruby.git
         timeout: '15'
         use-author: true
         wipe-workspace: 'True'

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

@@ -36,6 +36,7 @@
           recursive: true
           parent-credentials: true
           timeout: 100
+          reference-repo: /var/lib/jenkins/.git-references/apm-agent-ruby.git
         timeout: '15'
         use-author: true
         wipe-workspace: 'True'

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

@@ -10,14 +10,17 @@ 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}"
+git config user.email "${USER_MAIL}"
+git config 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}"
 
+# Checkout the master branch to be able to rebase the *.x branch
+git checkout master
+
 # Ensure the master branch points to the original commit to avoid commit injection
 # when running the release pipeline.
 # used GIT_BASE_COMMIT instead GIT_COMMIT to support the MultiBranchPipelines.

data/.github/ISSUE_TEMPLATE/Bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**: ...
+
+**To Reproduce**
+
+1. ...
+2. ...
+3. ...
+4. ...
+
+**Expected behavior**: ...
+
+**Environment (please complete the following information)**
+- OS: [e.g. Linux]
+- Ruby version:
+- Framework and version [e.g. Rails 6.0.1]: 
+- APM Server version:
+- Agent version:
+
+
+**Additional context**
+
+Add any other context about the problem here.
+
+- Agent config options <!-- be careful not to post sensitive information -->
+  <details>
+    <summary>Click to expand</summary>
+
+    ```
+    replace this line with your agent config options
+    remember to mask any sensitive fields like tokens
+    ```
+  </details>

data/.github/ISSUE_TEMPLATE/Feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+## What does this pull request do?
+
+<!-- Comment:
+Here you can explain the changes made on the PR.
+-->
+
+## Why is it important?
+
+<!-- Comment:
+Here you can explains how this change will impact the funcionality of the agent
+-->
+
+## Related issues
+closes #ISSUE

data/.gitignore

@@ -17,3 +17,6 @@ spec/junit-reports
 .gem
 *.bulk
 vendor/
+
+.idea/
+log/

data/.rubocop.yml

@@ -44,6 +44,9 @@ Metrics/ModuleLength:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/BlockNesting:
+  Enabled: false
+
 Metrics/MethodLength:
   Enabled: false
 
@@ -92,3 +95,6 @@ Style/SpecialGlobalVars:
 
 Style/MissingRespondToMissing:
   Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false

data/CHANGELOG.asciidoc

@@ -35,8 +35,32 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.4.0]]
+==== 3.4.0 (2020-01-10)
+
+[float]
+===== Added
+
+- Add `span.context.destination` fields {pull}647[#647]
+- Add more precise (experimental) SQL summarizer {pull}640[#640]
+- Add support for Shoryuken (AWS SQS) {pull}674[#674]
+- Add support for Sneakers (Experimental) {pull}676[#676]
+- Add option `api_key` to specify an Api key to use with the apm server {pull}655[#655]
+
+[float]
+===== Changed
+
+- Allow action dispatch spy to be disabled via `disabled_instrumentations` {pull}657[#657]
+
+[float]
+===== Fixed
+
+- Fix Rails Console detection when top-level `Console` constant defined {pull}664[#664]
+- Fix Ruby 2.7 related deprecation warnings {pull}667[#667]
+- Fix HTTP response header values not being converted to strings {pull}675[#675]
+
 [[release-notes-3.3.0]]
-==== 3.2.0 (2019-12-05)
+==== 3.3.0 (2019-12-05)
 
 [float]
 ===== Added

data/Gemfile

@@ -6,6 +6,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Tools
 gem 'bootsnap', require: false
+gem 'cucumber', require: false
 gem 'pry'
 gem 'rack-test'
 gem 'rspec', '~> 3'
@@ -16,6 +17,7 @@ gem 'timecop'
 gem 'webmock'
 
 # Integrations
+gem 'aws-sdk-sqs', require: nil
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
@@ -24,9 +26,11 @@ gem 'mongo', require: nil
 gem 'opentracing', require: nil
 gem 'rake', require: nil
 gem 'sequel', require: nil
+gem 'shoryuken', require: nil
 gem 'sidekiq', require: nil
-gem 'simplecov', require: false, group: :test
-gem 'simplecov-cobertura', require: false, group: :test
+gem 'sneakers', '~> 2.12', require: nil
+gem 'simplecov', require: false
+gem 'simplecov-cobertura', require: false
 gem 'yard', require: nil
 gem 'yarjuf'
 

data/bench/sql.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'json'
+require 'benchmark'
+include Benchmark # rubocop:disable Style/MixinUsage
+
+require 'elastic_apm/sql_summarizer'
+require 'elastic_apm/sql/signature'
+
+examples =
+  JSON
+  .parse(File.read('../apm/tests/random_sql_query_set.json'))
+  .map { |ex| ex['input'] }
+
+puts "#{'=' * 14} Parsing #{examples.length} examples #{'=' * 14}"
+
+summarizer = ElasticAPM::SqlSummarizer.new
+
+result_old = nil
+result_new = nil
+
+benchmark(CAPTION, 7, FORMAT, 'avg/ex:') do |bm|
+  old = bm.report('old:') do
+    result_old = examples.map { |i| summarizer.summarize(i) }
+  end
+  new = bm.report('new:') do
+    result_new = examples.map { |i| ElasticAPM::Sql::Signature.parse(i) }
+  end
+
+  [(new - old) / examples.length]
+end
+
+pp(result_old.count { |res| res == 'SQL' })
+pp(result_new.count { |res| res =~ /(--|\/\*\*)/ })
+
+## Stackprof
+
+require 'stackprof'
+
+puts 'Running stackprof'
+profile = StackProf.run(mode: :wall, interval: 1) do
+  examples.each { |i| ElasticAPM::Sql::Signature.parse(i) }
+end
+puts ''
+
+StackProf::Report.new(profile).print_text

data/bin/build_docs

@@ -2,4 +2,4 @@
 set -ex
 
 # Requires elastic/docs to be checked out at ../docs
-../docs/build_docs.pl --doc docs/index.asciidoc --chunk 1
+../docs/build_docs --doc docs/index.asciidoc --chunk 1

data/codecov.yml

@@ -0,0 +1,32 @@
+# Enable coverage report message for diff on commit
+# Docs can be found here: https://docs.codecov.io/v4.3.0/docs/commit-status
+coverage:
+  status:
+    project:
+      default:
+        target: 80%
+        threshold: 1
+        base: auto
+        branches: null
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: error
+        only_pulls: false
+        flags: null
+        paths: null
+    patch:
+      default:
+        target: auto
+        # Allows PRs without tests, overall stats count
+        threshold: 100
+        base: auto
+        branches: null
+        if_no_uploads: error
+        if_not_found: success
+        if_ci_failed: error
+        only_pulls: false
+        flags: null
+        paths: null
+
+# Disable comments on Pull Requests
+comment: false

data/docs/api.asciidoc

@@ -146,11 +146,30 @@ Arguments:
   * `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.
+  * `trace_context:`: An optional `TraceContext` object for Distributed Tracing.
+  * `parent:`: An optional parent transaction or span. Relevant when the span is created in another thread.
+  * `sync:`: An boolean to indicate whether the span is created synchronously or not.
   * `&block`: An optional block to wrap with the span.
   The block is passed the span as an optional argument.
 
 Returns the created span.
 
+If you'd like to create an asynchronous span, you have to pass the parent `Span` or `Transaction` to the `start_span` method.
+You can also set the `sync` flag to `false`, if you'd like the span to be marked as asynchronous. This has no effect other than being queryable in Elasticsearch.
+
+[source,ruby]
+----
+transaction = ElasticAPM.current_transaction # or start one with `.start_transaction`
+Thread.new do
+  ElasticAPM.start_span(
+    'job 1',
+    parent: transaction,
+    sync: false
+  ) { Worker.perform }
+  ElasticAPM.end_span
+end
+----
+
 [float]
 [[api-agent-end_span]]
 ==== `ElasticAPM.end_span`
@@ -171,11 +190,29 @@ Arguments:
   * `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.
+  * `trace_context:`: An optional `TraceContext` object for Distributed Tracing.
+  * `parent:`: An optional parent transaction or span. Relevant when the span is created in another thread.
+  * `sync:`: An boolean to indicate whether the span is created synchronously or not.
   * `&block`: An optional block to wrap with the span.
   The block is passed the span as an optional argument.
 
 Returns the return value of the given block.
 
+If you'd like to create an asynchronous span, you have to pass the parent `Span` or `Transaction` to the `with_span` method.
+You can also set the `sync` flag to `false`, if you'd like the span to be marked as asynchronous.
+
+[source,ruby]
+----
+transaction = ElasticAPM.current_transaction # or start one with `.start_transaction`
+Thread.new do
+  ElasticAPM.with_span(
+    'job 1',
+    parent: transaction,
+    sync: false
+  ) { Worker.perform }
+end
+----
+
 [float]
 [[api-agent-build-context]]
 ==== `ElasticAPM.build_context`