elastic-apm 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37a020cb4be0022f87d148e568cb6c755bb7464c401141d3f9de743b4f960132
-  data.tar.gz: e7d34598029f879e51e25b88fa1e23048290e51a21a664818f50b8c3b29bbc34
+  metadata.gz: 50ba0e1480f379488014123efe0974b22741593d451f1a501390dd0f8af17be2
+  data.tar.gz: f448574e08404ef0354998ef7e87173e653ef837309a3114f8694dcae97dbae3
 SHA512:
-  metadata.gz: 0f604ede3b49fc35a5560e28841e5d7bcb6c209f3a9c064dbfcfed0db158e75d501dbaec057d148f5254f6077a73de81ae5134ea4001995b614a547edfcb47aa
-  data.tar.gz: 6f2911e3d564ba2967bf4f3ae583b105c4f56a03014ef47ccfc65dd1ff05d9b6b43530044ed8abff694e38b27db431b50f94d5b0bf69448f52b4b4f29d42fa6a
+  metadata.gz: d7a730f4a97d7c974fa6f8d4acd5f5d5274f552eeeaacf169d2feb27e19b0b8ac1959df2cd8efa7718517cdf7bd1f81ad6e09d3fc57bba1f96d48b5c7572c472
+  data.tar.gz: 0e695ab76052b342ae71ba7e4eed6a6a03f1368ac67638fbc3a4e8ef2c1558e183d3911eeb38aba296d4ae469f37c4665123f4fe204760ce9f74dcdc238150ee

data/.ci/.jenkins_exclude.yml

@@ -1,4 +1,27 @@
 exclude:
+  # Ruby 2.3
+  # Only includes rails-5.2, sinatra-2.0
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: rails-6.0
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: rails-5.1
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: rails-5.0
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: rails-4.2
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: sinatra-1.4
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: grape-1.3
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: rails-master
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: sinatra-master
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: grape-master
+
   - RUBY_VERSION: ruby:2.7
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: jruby:9.2
@@ -18,8 +41,6 @@ exclude:
 
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-6.0
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: rails-6.0
   - RUBY_VERSION: jruby:9.1
     FRAMEWORK: rails-6.0
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
@@ -32,8 +53,6 @@ exclude:
     FRAMEWORK: rails-master
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-master
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: rails-master
   - RUBY_VERSION: jruby:9.2
     FRAMEWORK: rails-master
   - RUBY_VERSION: jruby:9.1
@@ -53,8 +72,6 @@ exclude:
     FRAMEWORK: sinatra-master
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: sinatra-master
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: sinatra-master
   - RUBY_VERSION: jruby:9.2
     FRAMEWORK: sinatra-master
   - RUBY_VERSION: jruby:9.1
@@ -76,8 +93,6 @@ exclude:
     FRAMEWORK: grape-master
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: grape-master
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: grape-master
   - RUBY_VERSION: jruby:9.2
     FRAMEWORK: grape-master
   - RUBY_VERSION: jruby:9.1
@@ -93,25 +108,29 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
     FRAMEWORK: grape-master
 
+  # Unsupported
+  - RUBY_VERSION: jruby:9.1
+    FRAMEWORK: grape-1.3
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
+    FRAMEWORK: grape-1.3
+
   - RUBY_VERSION: ruby:2.6
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: ruby:2.5
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: ruby:2.4
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
-  - RUBY_VERSION: ruby:2.3
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: jruby:9.2
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: jruby:9.1
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-12-jdk
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
-    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.3,sinatra-2.0,rails-6.0

data/.ci/.jenkins_framework.yml

@@ -8,6 +8,6 @@ FRAMEWORK:
   - sinatra-2.0
   - sinatra-1.4
 
-  - grape-1.2
+  - grape-1.3
 
-  - grape-1.2,sinatra-2.0,rails-6.0
+  - grape-1.3,sinatra-2.0,rails-6.0

data/.ci/Jenkinsfile

@@ -5,10 +5,15 @@ import co.elastic.matrix.*
 import groovy.transform.Field
 
 /**
- This is required to store the results of the tests.
+ This is required to know if there any failures when running the downstream jobs.
 */
 @Field def rubyTasksFailed = false
 
+/**
+ This is required to store the build status for the downstream jobs.
+*/
+@Field def rubyDownstreamJobs = [:]
+
 pipeline {
   agent { label 'linux && immutable' }
   environment {
@@ -94,8 +99,9 @@ pipeline {
             script {
               def ruby = readYaml(file: '.ci/.jenkins_ruby.yml')
               def testTasks = [:]
+              def i = 0
               ruby['RUBY_VERSION'].each{ rubyVersion ->
-                testTasks[rubyVersion] = { runJob(rubyVersion) }
+                testTasks[rubyVersion] = { runJob(rubyVersion, i++) }
               }
               parallel(testTasks)
               }
@@ -143,10 +149,7 @@ pipeline {
                   script {
                     def versions = readYaml(file: ".ci/.jenkins_ruby.yml")
                     def benchmarkTask = [:]
-                    // TODO: benchmark for the jruby:9.2 and similar versions got some issues with
-                    //       NoMethodError: undefined method `[]' for nil:NilClass
-                    //      <main> at bench/report.rb:48
-                    versions['RUBY_VERSION'].findAll { !it.contains('9.2') }.each{ v ->
+                    versions['RUBY_VERSION'].each{ v ->
                       benchmarkTask[v] = runBenchmark(v)
                     }
                     parallel(benchmarkTask)
@@ -157,12 +160,18 @@ pipeline {
           }
         }
       }
-      stage('Populate Test failures') {
+      stage('Populate Downstream failures') {
         when {
           expression { return rubyTasksFailed }
         }
         steps {
-          error('There were some failures when running the "Test" stage')
+          script {
+            def message = 'Failures when running the "Test" stage'
+            if (notifyBuildResult.isAnyDownstreamJobFailedWithTimeout(rubyDownstreamJobs)) {
+              message += ' related to a timeout issue'
+            }
+            error(message)
+          }
         }
       }
       stage('Integration Tests') {
@@ -243,7 +252,7 @@ pipeline {
     }
     post {
       cleanup {
-        notifyBuildResult()
+        notifyBuildResult(downstreamJobs: rubyDownstreamJobs)
       }
     }
   }
@@ -268,7 +277,7 @@ def runBenchmark(version){
             dockerLogin(secret: "${DOCKER_SECRET}", registry: "${DOCKER_REGISTRY}")
           }
           try{
-            sh "./spec/scripts/benchmarks.sh ${version}"
+            sh """./spec/scripts/benchmarks.sh "${version}" "${REFERENCE_REPO}" """
           } catch(e){
             throw e
           } finally {
@@ -285,19 +294,23 @@ def runBenchmark(version){
   }
 }
 
-def runJob(rubyVersion){
+def runJob(String rubyVersion, int sleep = 1){
+  def buildObject
   try {
-    build( job: "apm-agent-ruby/apm-agent-ruby-downstream/${env.BRANCH_NAME}",
-      parameters: [
-        string(name: 'RUBY_VERSION', value: "${rubyVersion}"),
-        string(name: 'BRANCH_SPECIFIER', value: "${env.GIT_BASE_COMMIT}")
-      ],
-      quietPeriod: 15
-    )
+    def quiet = (sleep * randomNumber(min: 2, max: 6)) + 5
+    buildObject = build(job: "apm-agent-ruby/apm-agent-ruby-downstream/${env.BRANCH_NAME}",
+                        parameters: [
+                          string(name: 'RUBY_VERSION', value: "${rubyVersion}"),
+                          string(name: 'BRANCH_SPECIFIER', value: "${env.GIT_BASE_COMMIT}")
+                        ],
+                        quietPeriod: quiet)
   } catch(e) {
     rubyTasksFailed = true
-    warnError('Test Failures') {
+    buildObject = e
+    warnError('Downstream Failed') {
       error("Downstream job for '${rubyVersion}' failed")
     }
+  } finally {
+    rubyDownstreamJobs["${rubyVersion}"] = buildObject
   }
 }

data/.ci/packer_cache.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+source /usr/local/bin/bash_standard_lib.sh
+
+grep "-" .ci/.jenkins_ruby.yml | grep -v 'observability-ci' | cut -d'-' -f2- | \
+while read -r version;
+do
+    transformedName=${version/:/-}
+    transformedVersion=$(echo "${version}" | cut -d":" -f2)
+    imageName="apm-agent-ruby"
+    registryImageName="docker.elastic.co/observability-ci/${imageName}:${transformedName}"
+    (retry 2 docker pull "${registryImageName}")
+    docker tag "${registryImageName}" "${imageName}:${transformedVersion}"
+done

data/.github/ISSUE_TEMPLATE/Bug_report.md

@@ -4,26 +4,28 @@ about: Create a report to help us improve
 
 ---
 
-**Describe the bug**: ...
-
-**To Reproduce**
+## Describe the bug
 
+## Steps to reproduce
+<!--
 1. ...
 2. ...
 3. ...
 4. ...
+-->
 
-**Expected behavior**: ...
+## 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:
+## 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**
+## Additional context
 
 Add any other context about the problem here.
 

data/.github/ISSUE_TEMPLATE/Feature_request.md

@@ -4,14 +4,14 @@ 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 [...]
+## 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 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.
+## 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.
+## Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,60 @@
+<!--
+A few suggestions about filling out this PR
+
+1. Use a descriptive title for the PR.
+2. If this pull request is work in progress, create a draft PR instead of prefixing the title with WIP.
+3. Please label this PR at least one of the following labels, depending on the scope of your change:
+- feature request, which adds new behavior
+- bug fix
+- enhancement, which modifies existing behavior
+- breaking change
+4. Remove those recommended/optional sections if you don't need them. Only "What does this PR do", "Why is it important?" and "Checklist" are mandatory.
+5. Generally, we require that you test any code you are adding or modifying.
+Once your changes are ready to submit for review:
+6. Submit the pull request: Push your local changes to your forked copy of the repository and submit a pull request (https://help.github.com/articles/using-pull-requests).
+7. Please be patient. We might not be able to review your code as fast as we would like to, but we'll do our best to dedicate to it the attention it deserves. Your effort is much appreciated!
+-->
+
 ## What does this pull request do?
 
-<!-- Comment:
-Here you can explain the changes made on the PR.
+<!--
+Use this space to describe what the proposed code _does_, ie. what precisely will be done differently from this change.
 -->
 
 ## Why is it important?
 
-<!-- Comment:
-Here you can explains how this change will impact the funcionality of the agent
+<!--
+Optionally provide an explanation of why this is important.
+-->
+
+## Checklist
+<!--
+Add a checklist of things that are required to be reviewed in order to have the PR approved
+
+List here all the items you have verified BEFORE sending this PR. Please DO NOT remove any item, striking through those that do not apply. (Just in case, strikethrough uses two tildes. ~~Scratch this.~~)
 -->
 
+- [ ] I have signed the [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). 
+- [ ] My code follows the style guidelines of this project (See `.rubocop.yml`)
+- [ ] I have rebased my changes on top of the latest master branch
+<!--
+Update your local repository with the most recent code from the main repo, and rebase your branch on top of the latest master branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review.
+-->
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing [**unit** tests](https://github.com/elastic/apm-agent-ruby/blob/master/CONTRIBUTING.md#testing) pass locally with my changes
+<!--
+Run the test suite to make sure that nothing is broken. See https://github.com/elastic/apm-agent-ruby/blob/master/CONTRIBUTING.md#testing for details.
+-->
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have updated [CHANGELOG.asciidoc](CHANGELOG.asciidoc)
+- [ ] I have updated [supported-technologies.asciidoc](docs/supported-technologies.asciidoc)
+- [ ] Added an API method or config option? Document in which version this will be introduced
+
 ## Related issues
-closes #ISSUE
+<!--
+Link related issues below. Insert the issue link or reference after the word "Closes" if merging this should automatically close it.
+- Closes #ISSUE_ID
+- Relates #ISSUE_ID
+- Requires #ISSUE_ID
+- Superseds #ISSUE_ID
+-->

data/.gitignore

@@ -20,3 +20,6 @@ vendor/
 
 .idea/
 log/
+
+benchmark-*.error
+benchmark-*.raw

data/CHANGELOG.asciidoc

@@ -35,6 +35,26 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.5.0]]
+==== 3.5.0 (2020-02-12)
+
+[float]
+===== Added
+
+- Pass along tracestate headers and add prefixless Traceparent header {pull}694[#694]
+- Add sanitize_field_names to replace custom_key_filters {pull}708[#708]
+- Add `rows_affected` to database related spans (Sequel only for now) {pull}668[#668]
+
+[float]
+===== Changed
+
+- Rename disabled_instrumentations to disable_instrumentations {pull}695[#695]
+
+[float]
+===== Fixed
+
+- Fix thread race condition in metrics collection (JRuby) {pull}669[#669]
+
 [[release-notes-3.4.0]]
 ==== 3.4.0 (2020-01-10)
 
@@ -45,7 +65,7 @@ endif::[]
 - 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]
+- Add option `api_key` (experimental) to specify an Api key to use with the apm server {pull}655[#655]
 
 [float]
 ===== Changed

data/CONTRIBUTING.md

@@ -18,50 +18,6 @@ Talk about what you would like to do.
 It may be that somebody is already working on it,
 or that there are particular issues that you should know about before implementing the change.
 
-### Submitting your changes
-
-Generally, we require that you test any code you are adding or modifying.
-Once your changes are ready to submit for review:
-
-1. Sign the Contributor License Agreement
-
-    Please make sure you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
-    We are not asking you to assign copyright to us,
-    but to give us the right to distribute your code without restriction.
-    We ask this of all contributors in order to assure our users of the origin and continuing existence of the code.
-    You only need to sign the CLA once.
-
-2. Test your changes
-
-    Run the test suite to make sure that nothing is broken.
-    See [testing](#testing) for details.
-
-3. Rebase your changes
-
-    Update your local repository with the most recent code from the main repo,
-    and rebase your branch on top of the latest master branch.
-    We prefer your initial changes to be squashed into a single commit.
-    Later,
-    if we ask you to make changes,
-    add them as separate commits.
-    This makes them easier to review.
-    As a final step before merging we will either ask you to squash all commits yourself or we'll do it for you.
-
-4. Submit a pull request
-
-    Push your local changes to your forked copy of the repository and [submit a pull request](https://help.github.com/articles/using-pull-requests).
-    In the pull request,
-    choose a title which sums up the changes that you have made,
-    and in the body provide more details about what your changes do.
-    Also mention the number of the issue where discussion has taken place,
-    eg "Closes #123".
-
-5. Be patient
-
-    We might not be able to review your code as fast as we would like to,
-    but we'll do our best to dedicate it the attention it deserves.
-    Your effort is much appreciated!
-
 ### Workflow
 
 All feature development and most bug fixes hit the master branch first.

data/README.md

@@ -1,4 +1,5 @@
 # elastic-apm
+
 ## Elastic APM agent for Ruby
 
 [![Jenkins](https://apm-ci.elastic.co/buildStatus/icon?job=apm-agent-ruby/apm-agent-ruby-mbp/master)](https://apm-ci.elastic.co/job/apm-agent-ruby/job/apm-agent-ruby-mbp/job/master/) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm)
@@ -11,21 +12,69 @@ The official Rubygem for [Elastic][] [APM][].
 
 ## Documentation
 
-[Full documentation at elastic.co](https://www.elastic.co/guide/en/apm/agent/ruby/2.x/index.html).
+[Full documentation at elastic.co](https://www.elastic.co/guide/en/apm/agent/ruby/current/index.html).
 
 <ul>
-  <li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/introduction.html">Introduction</a></li>
-<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/getting-started-rails.html">Getting started with Rails</a></li>
-<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/getting-started-rack.html">Getting started with Rack</a></li>
-<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/configuration.html">Configuration</a></li>
-<li>
-<a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/advanced.html">Advanced Topics</a>
-<ul>
-<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/custom-instrumentation.html">Custom instrumentation</a></li>
-</ul>
-</li>
-<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/supported-technologies.html">Supported Technologies</a></li>
-<li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/api.html">Public API</a></li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/set-up.html">Set up the Agent</a>
+    <ul>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/getting-started-rails.html">Getting started with Rails</a>
+      </li>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/getting-started-rack.html">Getting started with Rack</a>
+      </li>
+    </ul>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/supported-technologies.html">Supported technologies</a>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/configuration.html">Configuration</a>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/advanced.html">Advanced Topics</a>
+    <ul>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/context.html">Adding additional context</a>
+      </li>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/custom-instrumentation.html">Custom instrumentation</a>
+      </li>
+    </ul>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/api.html">API reference</a>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/metrics.html">Metrics</a>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/opentracing.html">OpenTracing API</a>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/log-correlation.html">Log correlation</a>
+  </li>
+  <li>
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/debugging.html">Troubleshooting</a>
+  </li>
+  <li class="collapsible">
+    <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes.html">Release notes</a>
+    <ul>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes-3.x.html">Ruby Agent version 3.x</a>
+      </li>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes-2.x.html">Ruby Agent version 2.x</a>
+      </li>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes-1.x.html">Ruby Agent version 1.x</a>
+      </li>
+      <li>
+        <a href="https://www.elastic.co/guide/en/apm/agent/ruby/current/release-notes-0.x.html">Ruby Agent version 0.x</a>
+      </li>
+    </ul>
+  </li>
 </ul>
 
 ---

data/docs/api.asciidoc

@@ -446,7 +446,7 @@ JavaScript RUM agent with the value of this method allows analyzing the time
 spent in the browser vs in the backend services.
 
 To enable the JavaScript RUM agent, initilialize the RUM agent with the Ruby
-agent'a current transaction:
+agent's current transaction:
 
 [source,html]
 ----

data/docs/configuration.asciidoc

@@ -14,7 +14,6 @@ The recommended way to configure Elastic APM is to create a file
 
 [source,yaml]
 ----
----
 server_url: 'http://localhost:8200'
 secret_token: <%= ENV["VERY_SECRET_TOKEN"] %>
 ----
@@ -90,7 +89,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_CUSTOM_KEY_FILTERS="a,b" # => [/a/, /b/]`.
+eg `ELASTIC_APM_SANITIZE_FIELD_NAMES="a,b" # => [/a/, /b/]`.
 
 [float]
 [[config-config-file]]
@@ -147,6 +146,23 @@ ruby -r securerandom -e 'print SecureRandom.uuid'
 
 WARNING: Secret tokens only provide any real security if your APM server uses TLS.
 
+[float]
+[[config-api-key]]
+==== `api_key`
+
+[options="header"]
+|============
+| Environment           | `Config` key | Default | Example
+| `ELASTIC_APM_API_KEY` | `api_key`    | `nil`   | A base64-encoded string
+|============
+
+This base64-encoded string is used to ensure that only your agents can send data to your APM server.
+You must have created the api key using the APM server command line tool. Please see the APM server
+documentation for details on how to do that. Please note that this feature is experimental in the
+APM server in version 7.6.
+
+WARNING: Api keys only provide any real security if your APM server uses TLS.
+
 [float]
 [[config-active]]
 ==== `active`
@@ -271,7 +287,7 @@ NOTE: This feature requires APM Server v7.3 or later and that the APM Server is
 
 [float]
 [[config-custom-key-filters]]
-==== `custom_key_filters`
+==== `custom_key_filters` deprecated:[3.5.0,See <<config-sanitize-field-names>> instead.]
 [options="header"]
 |============
 | Environment                      | `Config` key         | Default | Example
@@ -286,6 +302,8 @@ Use this option to add your own custom header keys to the list of filtered keys.
 When setting this option via `ENV`, use a comma separated string.
 Eg. `ELASTIC_APM_CUSTOM_KEY_FILTERS="a,b" # => [/a/, /b/]`
 
+NOTE: This option is being removed. See <<config-sanitize-field-names>> instead.
+
 [float]
 [[config-default-tags]]
 ==== `default_tags`
@@ -328,6 +346,7 @@ that are set will override `global_labels`.
 
 A comma-separated list of dotted metrics names that should not be sent to the APM Server.
 You can use `*` to match multiple metrics.
+Matching is case-insensitive.
 
 [float]
 [[config-disable-send]]
@@ -351,12 +370,12 @@ Disables the agent's startup message announcing itself.
 
 [float]
 [[config-disabled-instrumentations]]
-==== `disabled_instrumentations`
+==== `disable_instrumentations`
 
 [options="header"]
 |============
-| Environment                             | `Config` key                | Default
-| `ELASTIC_APM_DISABLED_INSTRUMENTATIONS` | `disabled_instrumentations` | `['json']`
+| Environment                            | `Config` key               | Default
+| `ELASTIC_APM_DISABLE_INSTRUMENTATIONS` | `disable_instrumentations` | `['json']`
 |============
 
 Elastic APM automatically instruments select third party libraries.
@@ -591,6 +610,24 @@ There are also `ENV` version of these following the same pattern of putting `ELA
 
 See https://github.com/httprb/http/wiki/Proxy-Support[Http.rb's docs].
 
+[float]
+[[config-sanitize-field-names]]
+==== `sanitize_field_names`
+
+[options="header"]
+|============
+| Environment                        | `Config` key           | Default | Example
+| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `[]`    | `Auth*tion,abc*,*xyz`
+|============
+
+Sometimes it is necessary to sanitize the data sent to Elastic APM, e.g. remove sensitive data.
+
+Configure a list of wildcard patterns of field names which should be sanitized. These apply to HTTP headers and bodies (if you're capturing those.)
+
+Supports the wildcard `*`, which matches zero or more characters.
+Examples: `/foo/*/bar/*/baz*`, `*foo*`.
+Matching is case insensitive.
+
 [float]
 [[config-service-name]]
 ==== `service_name`

data/lib/elastic_apm/agent.rb

@@ -86,6 +86,7 @@ module ElasticAPM
     )
 
     def_delegator :@central_config, :config
+
     def start
       unless config.disable_start_message?
         config.logger.info format(

data/lib/elastic_apm/config.rb

@@ -32,12 +32,11 @@ module ElasticAPM
     option :current_user_id_method,            type: :string, default: 'id'
     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_metrics,                   type: :list,   default: [],      converter: WildcardPatternList.new
     option :disable_send,                      type: :bool,   default: false
     option :disable_start_message,             type: :bool,   default: false
-    option :disabled_instrumentations,         type: :list,   default: %w[json]
+    option :disable_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
@@ -58,6 +57,7 @@ module ElasticAPM
     option :proxy_password,                    type: :string
     option :proxy_port,                        type: :int
     option :proxy_username,                    type: :string
+    option :sanitize_field_names,              type: :list,   default: [],      converter: WildcardPatternList.new
     option :server_ca_cert,                    type: :string
     option :service_name,                      type: :string
     option :service_version,                   type: :string
@@ -69,10 +69,10 @@ module ElasticAPM
     option :stack_trace_limit,                 type: :int,    default: 999_999
     option :transaction_max_spans,             type: :int,    default: 500
     option :transaction_sample_rate,           type: :float,  default: 1.0
+    option :use_elastic_traceparent_header,    type: :bool,   default: true
+    option :use_experimental_sql_parser,       type: :bool,   default: false
     option :verify_server_cert,                type: :bool,   default: true
 
-    option :use_experimental_sql_parser,      type: :bool,   default: false
-
     # rubocop:enable Metrics/LineLength, Layout/ExtraSpacing
     def initialize(options = {})
       @options = load_schema
@@ -129,7 +129,7 @@ module ElasticAPM
     end
 
     def enabled_instrumentations
-      available_instrumentations - disabled_instrumentations
+      available_instrumentations - disable_instrumentations
     end
 
     def method_missing(name, *args)
@@ -194,6 +194,33 @@ module ElasticAPM
       super.split.first + '>'
     end
 
+    # Deprecations
+
+    def default_tags=(value)
+      warn '[DEPRECATED] The option default_tags has been renamed to ' \
+        'default_labels.'
+      self.default_labels = value
+    end
+
+    def custom_key_filters=(value)
+      unless value == self.class.schema[:custom_key_filters][:default]
+        warn '[DEPRECATED] The option custom_key_filters is being removed. ' \
+          'See sanitize_field_names for an alternative.'
+      end
+
+      set(:custom_key_filters, value)
+    end
+
+    def disabled_instrumentations
+      disable_instrumentations
+    end
+
+    def disabled_instrumentations=(value)
+      warn '[DEPRECATED] The option disabled_instrumentations has been ' \
+        'renamed to disable_instrumentations to align with other agents.'
+      self.disable_instrumentations = value
+    end
+
     private
 
     def load_config_file

data/lib/elastic_apm/config/wildcard_pattern_list.rb

@@ -14,6 +14,8 @@ module ElasticAPM
           !!@pattern.match(other)
         end
 
+        alias :match :match?
+
         private
 
         def convert(str)
@@ -22,7 +24,7 @@ module ElasticAPM
               arr << (char == '*' ? '.*' : Regexp.escape(char))
             end
 
-          Regexp.new('\A' + parts.join + '\Z')
+          Regexp.new('\A' + parts.join + '\Z', Regexp::IGNORECASE)
         end
       end
 

data/lib/elastic_apm/context/response.rb

@@ -21,7 +21,7 @@ module ElasticAPM
       attr_reader :headers
 
       def headers=(headers)
-        @headers = headers.each_with_object({}) do |(k, v), hsh|
+        @headers = headers&.each_with_object({}) do |(k, v), hsh|
           hsh[k] = v.to_s
         end
       end

data/lib/elastic_apm/metrics/metric.rb

@@ -37,13 +37,15 @@ module ElasticAPM
       end
 
       def collect
-        collected = value
+        @mutex.synchronize do
+          collected = @value
 
-        self.value = initial_value if reset_on_collect?
+          @value = initial_value if reset_on_collect?
 
-        return nil if reset_on_collect? && collected == 0
+          return nil if reset_on_collect? && collected == 0
 
-        collected
+          collected
+        end
       end
     end
 

data/lib/elastic_apm/middleware.rb

@@ -56,10 +56,9 @@ module ElasticAPM
     end
 
     def trace_context(env)
-      return unless (header = env['HTTP_ELASTIC_APM_TRACEPARENT'])
-      TraceContext.parse(header)
-    rescue TraceContext::InvalidTraceparentHeader
-      warn "Couldn't parse invalid traceparent header: #{header.inspect}"
+      TraceContext.parse(env: env)
+    rescue TraceContext::InvalidTraceparentHeader => e
+      warn e.message
       nil
     end
 

data/lib/elastic_apm/opentracing.rb

@@ -277,7 +277,8 @@ module ElasticAPM
       def inject(span_context, format, carrier)
         case format
         when ::OpenTracing::FORMAT_RACK
-          carrier['elastic-apm-traceparent'] = span_context.to_header
+          carrier['elastic-apm-traceparent'] =
+            span_context.traceparent.to_header
         else
           warn 'Only injection via HTTP headers and Rack is available'
         end

data/lib/elastic_apm/span/context/db.rb

@@ -5,14 +5,21 @@ module ElasticAPM
     class Context
       # @api private
       class Db
-        def initialize(instance: nil, statement: nil, type: nil, user: nil)
+        def initialize(
+          instance: nil,
+          statement: nil,
+          type: nil,
+          user: nil,
+          rows_affected: nil
+        )
           @instance = instance
           @statement = statement
           @type = type
           @user = user
+          @rows_affected = rows_affected
         end
 
-        attr_accessor :instance, :statement, :type, :user
+        attr_accessor :instance, :statement, :type, :user, :rows_affected
       end
     end
   end

data/lib/elastic_apm/spies/faraday.rb

@@ -63,7 +63,7 @@ module ElasticAPM
 
                 result =
                   run_request_without_apm(method, url, body, headers) do |req|
-                    req['Elastic-Apm-Traceparent'] = trace_context.to_header
+                    trace_context.apply_headers { |k, v| req[k] = v }
 
                     yield req if block_given?
                   end

data/lib/elastic_apm/spies/http.rb

@@ -36,7 +36,8 @@ module ElasticAPM
               context: context
             ) do |span|
               trace_context = span&.trace_context || transaction.trace_context
-              req['Elastic-Apm-Traceparent'] = trace_context.to_header
+              trace_context.apply_headers { |key, value| req[key] = value }
+
               result = perform_without_apm(req, options)
 
               if (http = span&.context&.http)

data/lib/elastic_apm/spies/net_http.rb

@@ -67,7 +67,8 @@ module ElasticAPM
               context: context
             ) do |span|
               trace_context = span&.trace_context || transaction.trace_context
-              req['Elastic-Apm-Traceparent'] = trace_context.to_header
+              trace_context.apply_headers { |key, value| req[key] = value }
+
               result = request_without_apm(req, body, &block)
 
               if (http = span&.context&.http)

data/lib/elastic_apm/spies/sequel.rb

@@ -37,14 +37,24 @@ module ElasticAPM
               destination: { name: subtype, resource: subtype, type: TYPE }
             )
 
-            ElasticAPM.with_span(
+            span = ElasticAPM.start_span(
               name,
               TYPE,
               subtype: subtype,
               action: ACTION,
-              context: context,
-              &block
+              context: context
             )
+            yield.tap do |result|
+              if name =~ /^(UPDATE|DELETE)/
+                if connection.respond_to?(:changes)
+                  span.context.db.rows_affected = connection.changes
+                elsif result.is_a?(Integer)
+                  span.context.db.rows_affected = result
+                end
+              end
+            end
+          ensure
+            ElasticAPM.end_span
           end
         end
       end

data/lib/elastic_apm/trace_context.rb

@@ -1,82 +1,78 @@
 # frozen_string_literal: true
 
+require 'elastic_apm/trace_context/tracestate'
+require 'elastic_apm/trace_context/traceparent'
+
 module ElasticAPM
   # @api private
   class TraceContext
-    class InvalidTraceparentHeader < StandardError; end
-
-    VERSION = '00'
-    HEX_REGEX = /[^[:xdigit:]]/.freeze
+    extend Forwardable
 
-    TRACE_ID_LENGTH = 16
-    ID_LENGTH = 8
+    class InvalidTraceparentHeader < StandardError; end
 
     def initialize(
-      version: VERSION,
-      trace_id: nil,
-      span_id: nil,
-      id: nil,
-      recorded: true
+      traceparent: nil,
+      tracestate: nil,
+      **legacy_traceparent_attrs
     )
-      @version = version
-      @trace_id = trace_id || hex(TRACE_ID_LENGTH)
-      # TODO: rename to parent_id with next major version bump
-      @parent_id = span_id
-      @id = id || hex(ID_LENGTH)
-      @recorded = recorded
+      @traceparent = traceparent || Traceparent.new(**legacy_traceparent_attrs)
+      @tracestate = tracestate
     end
 
-    attr_accessor :version, :id, :trace_id, :parent_id, :recorded
+    attr_accessor :traceparent, :tracestate
 
-    alias :recorded? :recorded
-    def self.parse(header)
-      raise InvalidTraceparentHeader unless header.length == 55
-      raise InvalidTraceparentHeader unless header[0..1] == VERSION
+    def_delegators :traceparent,
+      :version, :trace_id, :id, :parent_id, :ensure_parent_id, :recorded?
 
-      new.tap do |t|
-        t.version, t.trace_id, t.parent_id, t.flags =
-          header.split('-').tap do |values|
-            values[-1] = Util.hex_to_bits(values[-1])
-          end
+    class << self
+      def parse(legacy_header = nil, env: nil)
+        if !legacy_header && !env
+          raise ArgumentError, 'TraceContext expects either env: or single ' \
+            'argument header string'
+        end
 
-        raise InvalidTraceparentHeader if HEX_REGEX =~ t.trace_id
-        raise InvalidTraceparentHeader if HEX_REGEX =~ t.parent_id
-      end
-    end
+        return legacy_parse_from_header(legacy_header) if legacy_header
 
-    def flags=(flags)
-      @flags = flags
+        return unless (header = get_traceparent_header(env))
 
-      self.recorded = flags[7] == '1'
-    end
+        parent = TraceContext::Traceparent.parse(header)
 
-    def flags
-      format('0000000%d', recorded? ? 1 : 0)
-    end
+        state =
+          if (header = env['HTTP_TRACESTATE'])
+            TraceContext::Tracestate.parse(header)
+          end
 
-    def hex_flags
-      format('%02x', flags.to_i(2))
-    end
+        new(traceparent: parent, tracestate: state)
+      end
+
+      private
+
+      def legacy_parse_from_header(header)
+        parent = Traceparent.parse(header)
+        new(traceparent: parent)
+      end
 
-    def ensure_parent_id
-      @parent_id ||= hex(ID_LENGTH)
+      def get_traceparent_header(env)
+        env['HTTP_ELASTIC_APM_TRACEPARENT'] || env['HTTP_TRACEPARENT']
+      end
     end
 
     def child
       dup.tap do |tc|
-        tc.parent_id = tc.id
-        tc.id = hex(ID_LENGTH)
+        tc.traceparent = tc.traceparent.child
       end
     end
 
-    def to_header
-      format('%s-%s-%s-%s', version, trace_id, id, hex_flags)
-    end
+    def apply_headers
+      yield 'Traceparent', traceparent.to_header
+
+      if tracestate
+        yield 'Tracestate', tracestate.to_header
+      end
 
-    private
+      return unless ElasticAPM.agent.config.use_elastic_traceparent_header
 
-    def hex(len)
-      SecureRandom.hex(len)
+      yield 'Elastic-Apm-Traceparent', traceparent.to_header
     end
   end
 end

data/lib/elastic_apm/trace_context/traceparent.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  class TraceContext
+    # @api private
+    class Traceparent
+      VERSION = '00'
+      HEX_REGEX = /[^[:xdigit:]]/.freeze
+
+      TRACE_ID_LENGTH = 16
+      ID_LENGTH = 8
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(
+        version: VERSION,
+        trace_id: nil,
+        span_id: nil,
+        id: nil,
+        recorded: true,
+        tracestate: nil
+      )
+        @version = version
+        @trace_id = trace_id || hex(TRACE_ID_LENGTH)
+        # TODO: rename span_id kw arg to parent_id with next major version bump
+        @parent_id = span_id
+        @id = id || hex(ID_LENGTH)
+        @recorded = recorded
+        @tracestate = tracestate
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      attr_accessor :version, :id, :trace_id, :parent_id, :recorded, :tracestate
+
+      alias :recorded? :recorded
+
+      def self.parse(header)
+        raise_invalid(header) unless header.length == 55
+        raise_invalid(header) unless header[0..1] == VERSION
+
+        new.tap do |t|
+          t.version, t.trace_id, t.parent_id, t.flags =
+            header.split('-').tap do |values|
+              values[-1] = Util.hex_to_bits(values[-1])
+            end
+
+          raise_invalid(header) if HEX_REGEX =~ t.trace_id
+          raise_invalid(header) if HEX_REGEX =~ t.parent_id
+        end
+      end
+
+      class << self
+        private
+
+        def raise_invalid(header)
+          raise InvalidTraceparentHeader,
+            "Couldn't parse invalid traceparent header: #{header.inspect}"
+        end
+      end
+
+      def flags=(flags)
+        @flags = flags
+
+        self.recorded = flags[7] == '1'
+      end
+
+      def flags
+        format('0000000%d', recorded? ? 1 : 0)
+      end
+
+      def hex_flags
+        format('%02x', flags.to_i(2))
+      end
+
+      def ensure_parent_id
+        @parent_id ||= hex(ID_LENGTH)
+      end
+
+      def child
+        dup.tap do |copy|
+          copy.parent_id = id
+          copy.id = hex(ID_LENGTH)
+        end
+      end
+
+      def to_header
+        format('%s-%s-%s-%s', version, trace_id, id, hex_flags)
+      end
+
+      private
+
+      def hex(len)
+        SecureRandom.hex(len)
+      end
+    end
+  end
+end

data/lib/elastic_apm/trace_context/tracestate.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  class TraceContext
+    # @api private
+    class Tracestate
+      def initialize(values = [])
+        @values = values
+      end
+
+      attr_accessor :values
+
+      def self.parse(header)
+        # HTTP allows multiple headers with the same name, eg. multiple
+        # Set-Cookie headers per response.
+        # Rack handles this by joining the headers under the same key, separated
+        # by newlines, see https://www.rubydoc.info/github/rack/rack/file/SPEC
+        new(String(header).split("\n"))
+      end
+
+      def to_header
+        values.join(',')
+      end
+    end
+  end
+end

data/lib/elastic_apm/transport/filters/secrets_filter.rb

@@ -25,7 +25,10 @@ module ElasticAPM
 
         def initialize(config)
           @config = config
-          @key_filters = KEY_FILTERS + config.custom_key_filters
+          @key_filters =
+            KEY_FILTERS +
+            config.custom_key_filters +
+            config.sanitize_field_names
         end
 
         def call(payload)
@@ -60,11 +63,11 @@ module ElasticAPM
         end
 
         def filter_key?(key)
-          @key_filters.any? { |regex| key.match regex }
+          @key_filters.any? { |regex| regex.match(key) }
         end
 
         def filter_value?(value)
-          VALUE_FILTERS.any? { |regex| value.match regex }
+          VALUE_FILTERS.any? { |regex| regex.match(value) }
         end
       end
     end

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

@@ -58,7 +58,8 @@ module ElasticAPM
               instance: db.instance,
               statement: Util.truncate(db.statement, max_length: 10_000),
               type: db.type,
-              user: db.user
+              user: db.user,
+              rows_affected: db.rows_affected
             }
           end
 

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -58,6 +58,7 @@ files:
 - ".ci/jobs/apm-agent-ruby.yml"
 - ".ci/jobs/defaults.yml"
 - ".ci/linting.groovy"
+- ".ci/packer_cache.sh"
 - ".ci/prepare-git-context.sh"
 - ".github/ISSUE_TEMPLATE/Bug_report.md"
 - ".github/ISSUE_TEMPLATE/Feature_request.md"
@@ -197,6 +198,8 @@ files:
 - lib/elastic_apm/stacktrace_builder.rb
 - lib/elastic_apm/subscriber.rb
 - lib/elastic_apm/trace_context.rb
+- lib/elastic_apm/trace_context/traceparent.rb
+- lib/elastic_apm/trace_context/tracestate.rb
 - lib/elastic_apm/transaction.rb
 - lib/elastic_apm/transport/base.rb
 - lib/elastic_apm/transport/connection.rb