elastic-apm 3.5.0 → 3.6.0

data/.ci/docker/jruby/8-jdk/Dockerfile

@@ -0,0 +1,40 @@
+FROM openjdk:8-jdk
+
+RUN apt-get update \
+    && apt-get install -y libc6-dev --no-install-recommends \
+    && rm -rf /var/lib/apt/lists/*
+
+ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
+
+RUN mkdir -p /opt/jruby \
+    && curl -fSL https://repo1.maven.org/maven2/org/jruby/jruby-dist/${JRUBY_VERSION}/jruby-dist-${JRUBY_VERSION}-bin.tar.gz -o /tmp/jruby.tar.gz \
+    && echo "$JRUBY_SHA256 */tmp/jruby.tar.gz" | sha256sum -c - \
+    && tar -zx --strip-components=1 -f /tmp/jruby.tar.gz -C /opt/jruby \
+    && update-alternatives --install /usr/local/bin/ruby ruby /opt/jruby/bin/jruby 1
+
+# set the jruby binaries in the path
+ENV PATH /opt/jruby/bin:$PATH
+
+# skip installing gem documentation
+RUN mkdir -p /opt/jruby/etc \
+    && { \
+        echo 'install: --no-document'; \
+        echo 'update: --no-document'; \
+    } >> /opt/jruby/etc/gemrc
+
+# install bundler, gem requires bash to work
+RUN gem install bundler rake net-telnet xmlrpc tzinfo-data
+
+# install things globally, for great justice
+# and don't create ".bundle" in all our apps
+ENV GEM_HOME /usr/local/bundle
+ENV BUNDLE_PATH="$GEM_HOME" \
+    BUNDLE_BIN="$GEM_HOME/bin" \
+    BUNDLE_SILENCE_ROOT_WARNING=1 \
+    BUNDLE_APP_CONFIG="$GEM_HOME"
+ENV PATH $BUNDLE_BIN:$PATH
+RUN mkdir -p "$GEM_HOME" "$BUNDLE_BIN" \
+    && chmod 777 "$GEM_HOME" "$BUNDLE_BIN"
+
+CMD [ "irb" ]

data/.ci/docker/jruby/README.md

@@ -0,0 +1,31 @@
+# JRuby docker images
+
+Builds jruby docker images.
+
+## Build
+
+To build the images run
+
+```bash
+  ./run.sh --action build
+```
+
+You can set your own docker registry with the flag `--registry x.y.z/org`
+
+You can exclude what images can be built with the flag `--exclude jdk-7`
+
+## Test
+
+To test the images run
+
+```bash
+  ./run.sh --action test
+```
+
+## Push
+
+To push the images run
+
+```bash
+  ./run.sh --action push
+```

data/.ci/docker/jruby/run.sh

@@ -0,0 +1,73 @@
+#!/usr/bin/env bash
+
+while (( "$#" )); do
+  case "$1" in
+    -r|--registry)
+      REGISTRY=$2
+      shift 2
+      ;;
+    -e|--exclude)
+      EXCLUDE=$2
+      shift 2
+      ;;
+    -a|--action)
+      ACTION=$2
+      shift 2
+      ;;
+    --) # end argument parsing
+      shift
+      break
+      ;;
+    -*|--*=) # unsupported flags
+      echo "Error: Unsupported flag $1" >&2
+      exit 1
+      ;;
+    *) # preserve positional arguments
+      shift
+      ;;
+  esac
+done
+
+
+if [ -n "$EXCLUDE" ] ; then
+  search=$(find . -path ./$EXCLUDE -prune -o -name 'Dockerfile' -print)
+else
+  search=$(find . -name 'Dockerfile' -print)
+fi
+
+function report {
+  if [ $1 -eq 0 ] ; then
+    printf '\tImage %-60s %-10s\n' "${2}" "GENERATED"
+  else
+    printf '\tImage %-60s %-10s\n' "${2}" "FAILED"
+  fi
+}
+
+echo "${ACTION} docker images"
+for i in ${search}; do
+  jdk_image=$(basename `dirname "$i"`)
+  jdk_version=$(echo "$jdk_image" | cut -d'-' -f1)
+  jruby=$(grep "JRUBY_VERSION" $i | cut -d" " -f 3)
+  if [ "${jdk_image}" == "onbuild" ] ; then
+    short=$(grep "FROM" "$i" | cut -d":" -f 2 | cut -d'-' -f1)
+    jdk_version=
+  else
+    short=$(echo "$jruby" | cut -d'.' -f1-2)
+  fi
+
+  if [ -n "${REGISTRY}" ] ; then
+    name="${REGISTRY}/jruby:${short}-${jdk_image}"
+  else
+    name="jruby:${short}-${jdk_image}"
+  fi
+
+  if [ "${ACTION}" == "build" ] ; then
+    docker build --tag "${name}" -< $i >> output.log 2>&1
+    report $? "${name}"
+  elif [ "${ACTION}" == "push" ] ; then
+    docker push "${name}" >> output.log 2>&1
+    report $? "${name}"
+  else
+    ./test.sh "${name}" $jdk_version
+  fi
+done

data/.ci/docker/jruby/test.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+image=${1?image is required}
+version=${2}
+
+printf '\tTest %-30s %s\n' ${image}
+
+if [ -n "$version" ] ; then
+  test_name="Test java -version '$version'"
+  docker run -t --rm $image java -version | grep -q "openjdk version \"$version\|1.$version" && printf '\t\t%-40s %s\n' "${test_name}" "PASSED" || printf '\t\t%-40s %s\n' "${test_name}" "FAILED"
+fi
+
+test_name="Test Hello World"
+docker run -t --rm $image jruby -e "puts 'Hello World" | grep -q 'Hello World' && printf '\t\t%-40s %s\n' "${test_name}" "PASSED" || printf '\t\t%-40s %s\n' "${test_name}" "FAILED"

data/.gitignore

@@ -22,4 +22,6 @@ vendor/
 log/
 
 benchmark-*.error
-benchmark-*.raw
+benchmark-*.raw
+
+.ci/docker/jruby/output.log

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,12 @@ Style/SpecialGlobalVars:
 Style/MissingRespondToMissing:
   Enabled: false
 
-Style/BracesAroundHashParameters:
-  Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+

data/CHANGELOG.asciidoc

@@ -35,6 +35,22 @@ endif::[]
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[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)
 

data/CONTRIBUTING.md

@@ -41,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

@@ -21,26 +21,22 @@ gem 'aws-sdk-sqs', require: nil
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
+gem 'graphql', require: nil
+gem 'grpc' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.7'
 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 '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 +55,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 +69,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/Rakefile

@@ -2,11 +2,16 @@
 
 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
+    `echo hi && false && git checkout 3.x &&
+    git rebase master &&
+    git push origin 3.x &&
+    git checkout master`
+  end
 end
 
 require 'rspec/core/rake_task'

data/docker-compose.yml

@@ -27,6 +27,11 @@ services:
     depends_on:
       - mongodb
 
+  ruby_rspec:
+    image: apm-agent-ruby:${RUBY_VERSION}
+    environment:
+      MONGODB_URL: 'mongodb:27017'
+
 volumes:
   vendor:
   mongodata:

data/docs/api.asciidoc

@@ -42,6 +42,18 @@ If you're not using Rails, see <<getting-started-rack,Getting started with Rack>
 Stop the currently running agent. Use this inside `at_exit` in your
 <<getting-started-rack,Rack app>> to gracefully shut down.
 
+[float]
+[[api-agent-restart]]
+==== `ElasticAPM.restart`
+
+If the agent is already running, this method will stop and start the agent.
+
+If the agent is not already running, this method will start the agent.
+
+A config can be passed to the method that will be used to start the agent. If the agent
+is already running and no config is passed to the `#restart` method, the running agent's
+config will be used.
+
 [float]
 [[api-agent-running]]
 ==== `ElasticAPM.running?`
@@ -425,13 +437,13 @@ end
 
 [float]
 [[api-transaction-sampled_]]
-==== #sampled?
+==== `#sampled?`
 
 Whether the transaction is _sampled_ eg. it includes stacktraces for its spans.
 
 [float]
 [[api-transaction-ensure_parent_id]]
-==== #ensure_parent_id
+==== `#ensure_parent_id`
 
 If the transaction does not have a parent-ID yet, calling this method generates
 a new ID, sets it as the parent-ID of this transaction, and returns it as a

data/docs/configuration.asciidoc

@@ -765,20 +765,14 @@ context information, tags, or spans.
 
 [float]
 [[config-use-experimental-sql-parser]]
-==== `use_experimental_sql_parser`
+==== `use_legacy_sql_parser`
 |============
-| Environment                               | `Config` key                  | Default
-| `ELASTIC_APM_USE_EXPERIMENTAL_SQL_PARSER` | `use_experimental_sql_parser` | `false`
+| Environment                         | `Config` key            | Default
+| `ELASTIC_APM_USE_LEGACY_SQL_PARSER` | `use_legacy_sql_parser` | `false`
 |============
 
-Use a newer, more precise but still experimental approach to generating summaries of
-your app's SQL statements.
-Without this, your SQL statements will still be summarized albeit less accurately.
-
-The summaries become the spans' names -- what it says in the waterfall view in Kibana.
-
-NOTE: This should work just fine but is still deamed experimental. That means it is
-subject to change. Please let us know if you come across any issues.
+Use the older, less precise approach to generating summaries of your app's SQL statements.
+Try this if you're experiencing trouble using the new default.
 
 [float]
 [[config-verify-server-cert]]

data/docs/graphql.asciidoc

@@ -0,0 +1,23 @@
+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::[]
+
+[[graphql]]
+== GraphQL (experimental)
+
+The agent comes with support for GraphQL based APIs.
+
+This slightly alters how transactions are named when they relate to GraphQL
+queries, so they are easier to tell apart and debug.
+
+To enable GraphQL support, add the included Tracer to your schema:
+
+[source,ruby]
+----
+class MySchema < GraphQL::Schema
+  # ...
+
+  tracer ElasticAPM::GraphQL # <-- include this
+end
+----

data/docs/index.asciidoc

@@ -25,9 +25,13 @@ include::./metrics.asciidoc[]
 
 include::./opentracing.asciidoc[]
 
+include::./graphql.asciidoc[]
+
 include::./log-correlation.asciidoc[]
 
 include::./debugging.asciidoc[]
 
+include::./upgrading.asciidoc[]
+
 include::./release-notes.asciidoc[]
 

data/docs/supported-technologies.asciidoc

@@ -85,4 +85,54 @@ We automatically instrument background processing using:
 - DelayedJob
 - Sidekiq
 - Shoryuken
-- Sneakers (v2.12.0+) (Experimental, see {pull}676[#676])
+- Sneakers (v2.12.0+) (Experimental, see https://github.com/elastic/apm-agent-ruby/pull/676[#676])
+- Resque (v2.0.0+)
+
+[float]
+[[supported-technologies-resque]]
+=== Resque
+
+To make the agent work with Resque, you need to require `elastic_apm/resque` before you boot your Resque worker process.
+
+For example in your `Rakefile`:
+
+[source,ruby]
+----
+require 'resque'
+require 'elastic_apm'
+require 'elastic_apm/resque'
+----
+
+When you start Resque, you should see a series of messages like the following in the Resque logs:
+
+[source,ruby]
+----
+I, [XXX #81227]  INFO -- : Starting worker main
+D, [XXX #81227] DEBUG -- : Registered signals
+I, [XXX #81227]  INFO -- : Running before_first_fork hooks
+D, [XXX #81227] DEBUG -- : Starting ElasticAPM agent
+----
+
+[float]
+[[supported-technologies-grpc]]
+=== gRPC
+
+We automatically instrument gRPC using the `grpc` gem. Note that this is experimental, as the `grpc` gem's
+support for `Interceptors` is experimental as of version 1.27.0.
+
+To instrument a client, add the `ElasticAPM::GRPC::ClientInterceptor` as an `interceptor` at Stub creation.
+
+[source,ruby]
+----
+Helloworld::Greeter::Stub.new(
+  'localhost:50051',
+  interceptors: [ElasticAPM::GRPC::ClientInterceptor.new]
+)
+----
+
+To instrument a server, add the `ElasticAPM::GRPC::ServerInterceptor`.
+
+[source,ruby]
+----
+GRPC::RpcServer.new(interceptors: [ElasticAPM::GRPC::ServerInterceptor.new])
+----