elastic-apm 3.4.0 → 3.9.0

data/.gitignore

@@ -20,3 +20,8 @@ vendor/
 
 .idea/
 log/
+
+benchmark-*.error
+benchmark-*.raw
+
+.ci/docker/jruby/output.log

data/.rspec

@@ -1,3 +1,2 @@
 --color
---require spec_helper
 --exclude-pattern spec/integration/**/*_spec.rb

data/.rubocop.yml

@@ -4,6 +4,8 @@ AllCops:
     - 'elastic-apm.gemspec'
     - 'vendor/**/*'
     - 'bench/*'
+    - 'spec/support/helloworld_pb.rb'
+    - 'spec/support/helloworld_services_pb.rb'
 
 require:
   - rubocop-performance
@@ -96,5 +98,15 @@ Style/SpecialGlobalVars:
 Style/MissingRespondToMissing:
   Enabled: false
 
-Style/BracesAroundHashParameters:
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
   Enabled: false
+

data/CHANGELOG.asciidoc

@@ -35,6 +35,99 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.9.0]]
+==== 3.9.0 (2020-08-04)
+
+[float]
+===== Added
+
+- Support for DynamoDB {pull}827[#827]
+
+[float]
+===== Fixed
+
+- Fix Rails Engine views' paths being reported as absolute {pull}839[#839]
+- Fix an issue when using Elasticsearch spy without a running agent {pull}830[#830]
+
+[[release-notes-3.8.0]]
+==== 3.8.0 (2020-06-18)
+
+[float]
+===== Added
+
+- Add the option `capture_elasticsearch_queries` {pull}789[#789]
+- Add option to skip patching Kernal#require {pull}812[#812]
+- Add option `service_node_name` {pull}820[#820]
+
+[float]
+===== Fixed
+
+- Allow underscores in hostnames in Net::HTTP spy {pull}804[#804]
+- Don't change log level on logger object via remote config {pull}809[#809]
+- Update and fix the Opentracing bridge {pull}791[#791]
+
+[[release-notes-3.7.0]]
+==== 3.7.0 (2020-05-14)
+
+[float]
+===== Changed
+
+- Make config values dynamic so they can be changed via the remote config {pull}747[#747]
+- Log the updated options from central config in addition to cumulative modifications {pull}758[#758]
+
+[float]
+===== Fixed
+
+- Ensure that the log level is updated for the config's logger when value is changed {pull}755[#755]
+- Set config `false` values to `false`, not `nil` {pull}761[#761]
+- Ensure that the previously running agent's config is used in `ElasticAPM.restart` {pull}763[#763]
+- Handle the Resque spy's payload class value being a String or Class and update docs {pull}768[#768]
+- Add finalizer on ProxyPipe::Write so Zlib::GzipWriter is properly closed {pull}787[#787]
+
+[float]
+===== Added
+
+- Add enabled config option, replacing active {pull}669[#669]
+- Add recording config option {pull}765[#765]
+- Add support for `SuckerPunch` {pull}775[#775]
+- Support forking: Detect forking and restart agent tasks and background threads {pull}783[#783]
+
+[[release-notes-3.6.0]]
+==== 3.6.0 (2020-03-10)
+
+[float]
+===== Added
+
+- Support for gRPC using the `grpc` gem (Experimental) {pull}669[#669]
+- GraphQL support (experimental) {pull}721[#721]
+- Add `span.context.destination.address` and `span.context.destination.port` when available. {pull}722[#722]
+- Add support for Resque. {pull}729[#729]
+
+[float]
+===== Changed
+
+- The new SQL parser is used by default {pull}730[#730]
+
+[[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 +138,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.
@@ -85,10 +41,12 @@ $ spec/scripts/spec.sh ruby:2.6 rails-5.2
 To release a new version:
 
 1. Update `VERSION` in `lib/elastic_apm/version.rb` according to the changes (major, minor, patch).
-2. Update `CHANGELOG.md` to reflect the new version – change _Unreleased_ section to _Version (release date)_.
-3. Make a new commit with the changes above, with a message in the style of `vX.X.X`.
-4. Run `rake release`. This will...
+1. Update `CHANGELOG.md` to reflect the new version – change _Unreleased_ section to _Version (release date)_.
+1. For Majors: Add a new row to the EOL table in `docs/upgrading.asciidoc`. The EOL date is the release date plus 18 months. 
+1. Make a new commit with the changes above, with a message in the style of `vX.X.X`.
+1. Run `rake release`. This will...
     1. Tag the current commit as new version.
     2. Push the tag to GitHub.
     3. Build the gem and upload to Rubygems (local user needs to be signed in and authorized.)
-    4. Update `2.x` branch to be at released commit and push it to GitHub.
+1. Run `rake release:update_branch`. This will...
+    1. Update `3.x` branch to be at released commit and push it to GitHub.

data/Gemfile

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
@@ -17,30 +34,29 @@ gem 'timecop'
 gem 'webmock'
 
 # Integrations
+gem 'aws-sdk-dynamodb', require: nil
 gem 'aws-sdk-sqs', require: nil
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
+gem 'graphql', require: nil
+gem 'google-protobuf', '< 3.12' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
+gem 'grpc' if !defined?(JRUBY_VERSION)
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
 gem 'rake', require: nil
+gem 'resque', require: nil
 gem 'sequel', require: nil
 gem 'shoryuken', require: nil
 gem 'sidekiq', require: nil
-gem 'sneakers', '~> 2.12', require: nil
 gem 'simplecov', require: false
 gem 'simplecov-cobertura', require: false
+gem 'sneakers', '~> 2.12', require: nil
+gem 'sucker_punch', '~> 2.0', require: nil
 gem 'yard', require: nil
 gem 'yarjuf'
 
-if RUBY_PLATFORM == 'java'
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'jdbc-sqlite3'
-else
-  gem 'sqlite3'
-end
-
 ## Install Framework
 GITHUB_REPOS = {
   'grape' => 'ruby-grape/grape',
@@ -59,7 +75,7 @@ end
 frameworks_versions.each do |framework, version|
   case version
   when 'master'
-    gem framework, github: GITHUB_REPOS.fetch[framework]
+    gem framework, github: GITHUB_REPOS.fetch(framework)
   when /.+/
     gem framework, "~> #{version}.0"
   else
@@ -73,6 +89,15 @@ if frameworks_versions.key?('rails')
   end
 end
 
+if RUBY_PLATFORM == 'java'
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jdbc-sqlite3'
+elsif frameworks_versions['rails'] =~ /^(4|5)/
+  gem 'sqlite3', '~> 1.3.6'
+else
+  gem 'sqlite3' # rubocop:disable Bundler/DuplicatedGem
+end
+
 group :bench do
   gem 'ruby-prof', require: nil, platforms: %i[ruby]
   gem 'stackprof', require: nil, platforms: %i[ruby]

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/Rakefile

@@ -1,12 +1,34 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 
-Rake::Task[:release].enhance do
-  `git checkout 3.x &&
-  git rebase master &&
-  git push origin 3.x &&
-  git checkout master`
+desc """Post release action:
+Update `3.x` branch to be at released commit and push it to GitHub.
+"""
+namespace :release do
+  task :update_branch do
+    `git checkout 3.x &&
+    git rebase master &&
+    git push origin 3.x &&
+    git checkout master`
+  end
 end
 
 require 'rspec/core/rake_task'
@@ -17,3 +39,13 @@ YARD::Rake::YardocTask.new
 task docs: :yard
 
 task default: :spec
+
+namespace :coverage do
+    desc "Collates all result sets generated by the different test runners"
+    task :report do
+      require 'simplecov'
+      require 'simplecov-cobertura'
+      SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+      SimpleCov.collate Dir["coverage/matrix_results/**/.resultset.json"]
+    end
+  end

data/bin/run-tests

@@ -8,7 +8,10 @@ runRspec(){
   if [ -n "${case}" ]; then
     bn="$(basename ${case} _spec.rb)/"
   fi
-  bundle exec rspec -f progress -f JUnit -o spec/junit-reports/${bn}ruby-agent-junit.xml ${case}
+  bundle exec rspec \
+    -f progress \
+    -r yarjuf -f JUnit -o spec/junit-reports/${bn}ruby-agent-junit.xml \
+    ${case}
 }
 specific_spec=$1