elastic-apm 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 123006390aa4ec1e409d45dfb91547a6f724c65e054b68278c93d2658dbc39fc
-  data.tar.gz: 38961a4b6606f592cf32ed7298d302beaa19673c4409f9561dbba5f468fad5da
+  metadata.gz: d6058bb61034dc14b1b22a3a5f45a592721b968d314bb5f63ca171c600bbb1bc
+  data.tar.gz: fffcd9160ec251a5ad51aae149dbfc3f50cf16b3fc866385f24f83f555b8b804
 SHA512:
-  metadata.gz: 956689269daf15587d89a0f578fd7ddff3f05536f8fd98a758978a8d50d8cfabd0ddd6908c9d7ba8c76418f6df9542f0d7d1278f95cd809d5026320e696bd45b
-  data.tar.gz: 9f866f05c3e0d8b43ffcdc31f54665db68a239abf5915b2913dca74154f7a1f91c50b3dbacb7eeee97a90a64584973c796b105c37ae442fa5d21ae47cbabf73d
+  metadata.gz: f7a8bd72f34f7158619c124e4eff24c9b5d57e68c3b5761b1a6305e632f3aff549be7ed37924775d8ad61119f99a87081567969c0e386641b8789662ff3f54ca
+  data.tar.gz: a8ce8dc0c3a3def4e08ca68b33d73c288bb6ca1fe6a6ff5fd0bbfe5e03f695848855c91b024e28e2ad0872895afa5659c8ff07f06b16277ea9755c0598d711b9

data/.ci/.jenkins_exclude.yml

@@ -4,6 +4,8 @@ exclude:
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: jruby:9.1
     FRAMEWORK: rails-4.2
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: rails-4.2
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-12-jdk
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
@@ -33,6 +35,8 @@ exclude:
     FRAMEWORK: rails-master
   - RUBY_VERSION: jruby:9.1
     FRAMEWORK: rails-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: rails-master
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-12-jdk
     FRAMEWORK: rails-master
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
@@ -52,6 +56,8 @@ exclude:
     FRAMEWORK: sinatra-master
   - RUBY_VERSION: jruby:9.1
     FRAMEWORK: sinatra-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: sinatra-master
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-12-jdk
     FRAMEWORK: sinatra-master
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
@@ -61,3 +67,44 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
     FRAMEWORK: sinatra-master
 
+  - RUBY_VERSION: ruby:2.5
+    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
+    FRAMEWORK: grape-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: grape-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-12-jdk
+    FRAMEWORK: grape-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
+    FRAMEWORK: grape-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: grape-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
+    FRAMEWORK: grape-master
+
+  - RUBY_VERSION: ruby:2.5
+    FRAMEWORK: grape-1.2,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
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: grape-1.2,sinatra-2.0,rails-6.0
+  - RUBY_VERSION: jruby:9.1
+    FRAMEWORK: grape-1.2,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
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-12-jdk
+    FRAMEWORK: grape-1.2,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
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: grape-1.2,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

data/.ci/.jenkins_framework.yml

@@ -7,3 +7,7 @@ FRAMEWORK:
 
   - sinatra-2.0
   - sinatra-1.4
+
+  - grape-1.2
+
+  - grape-1.2,sinatra-2.0,rails-6.0

data/.ci/.jenkins_master_framework.yml

@@ -1,3 +1,4 @@
 FRAMEWORK:
   - rails-master
   - sinatra-master
+  - grape-master

data/.ci/.jenkins_ruby.yml

@@ -5,6 +5,7 @@ RUBY_VERSION:
   - ruby:2.3
   - jruby:9.2
   - jruby:9.1
+  - docker.elastic.co/observability-ci/jruby:9.2-13-jdk
   - docker.elastic.co/observability-ci/jruby:9.2-12-jdk
   - docker.elastic.co/observability-ci/jruby:9.2-11-jdk
   - docker.elastic.co/observability-ci/jruby:9.2-8-jdk

data/.ci/downstreamTests.groovy

@@ -117,7 +117,7 @@ class RubyParallelTaskGenerator extends DefaultParallelTaskGenerator {
         } finally {
           steps.junit(allowEmptyResults: true,
             keepLongStdio: true,
-            testResults: "**/spec/ruby-agent-junit.xml")
+            testResults: "**/spec/junit-reports/**/ruby-agent-junit.xml")
           if (steps.isCodecovEnabled(x, y)) {
             steps.codecov(repo: "${steps.env.REPO}", basedir: "${steps.env.BASE_DIR}",
                           secret: "${steps.env.CODECOV_SECRET}")

data/.gitignore

@@ -13,6 +13,7 @@
 Gemfile.lock
 /html_docs/
 spec/elastic_apm.log
-spec/ruby-agent-junit.xml
+spec/junit-reports
 .gem
 *.bulk
+vendor/

data/.rspec

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

data/CHANGELOG.asciidoc

@@ -28,6 +28,30 @@ endif::[]
 - Fix {pull}2526[#2526]
 ////
 
+[[release-notes-3.x]]
+=== Ruby Agent version 3.x
+
+[[release-notes-3.2.0]]
+==== 3.2.0 (2019-11-19)
+
+[float]
+===== Added
+
+- Add Grape support. {pull}562[#562]
+- Add Breakdown Metrics {pull}526[#526]
+
+[float]
+===== Changes
+
+- Set remote_addr to immediate socket {pull}615[#615]
+
+[float]
+===== Fixed
+
+- Fixed pulling config from Kibana {pull}594[#594]
+- Fixed a bug where the agent would alter the original cookies hash {pull}616[#616]
+
+
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 

data/Dockerfile

@@ -0,0 +1,43 @@
+ARG RUBY_IMAGE
+FROM ${RUBY_IMAGE}
+
+ARG USER_ID_GROUP
+ARG FRAMEWORKS
+ARG VENDOR_PATH
+ARG BUNDLER_VERSION
+
+# For tzdata
+# ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq \
+      && apt-get install -qq -y --no-install-recommends \
+        build-essential libpq-dev git \
+      && rm -rf /var/lib/apt/lists/*
+
+# Configure bundler and PATH
+ENV LANG=C.UTF-8
+
+ENV GEM_HOME=$VENDOR_PATH
+ENV BUNDLE_PATH=$GEM_HOME \
+  BUNDLE_JOBS=4 BUNDLE_RETRY=3
+ENV BUNDLE_APP_CONFIG=$BUNDLE_PATH \
+  BUNDLE_BIN=$BUNDLE_PATH/bin
+ENV PATH=/app/bin:$BUNDLE_BIN:$PATH
+
+ENV FRAMEWORKS $FRAMEWORKS
+
+RUN mkdir -p $VENDOR_PATH \
+      && chown -R $USER_ID_GROUP $VENDOR_PATH
+
+USER $USER_ID_GROUP
+
+# Upgrade RubyGems and install required Bundler version
+RUN gem update --system && \
+      gem install bundler:$BUNDLER_VERSION
+
+# Use unpatched, system version for more speed over less security
+RUN gem install nokogiri -- --use-system-libraries
+# Rake is required to build http-parser on some jruby images
+RUN gem install rake
+
+WORKDIR /app

data/Gemfile

@@ -4,15 +4,17 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gemspec
-
+# Tools
+gem 'bootsnap', require: false
+gem 'pry'
 gem 'rack-test'
-gem 'rspec'
+gem 'rspec', '~> 3'
 gem 'rspec-its'
 gem 'rubocop', require: nil
 gem 'timecop'
 gem 'webmock'
 
+# Integrations
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
@@ -28,30 +30,47 @@ gem 'yard', require: nil
 gem 'yarjuf'
 
 if RUBY_PLATFORM == 'java'
+  gem 'activerecord-jdbcsqlite3-adapter'
   gem 'jdbc-sqlite3'
 else
   gem 'sqlite3'
 end
 
-framework, *version = ENV.fetch('FRAMEWORK', 'rails').split('-')
-version = version.join('-')
+## Install Framework
+GITHUB_REPOS = {
+  'grape' => 'ruby-grape/grape',
+  'rails' => 'rails/rails',
+  'sinatra' => 'sinatra/sinatra'
+}.freeze
 
-case version
-when 'master'
-  gem framework, github: "#{framework}/#{framework}"
-when /.+/
-  gem framework, "~> #{version}.0"
-else
-  gem framework
+#                new               || legacy           || default
+env_frameworks = ENV['FRAMEWORKS'] || ENV['FRAMEWORK'] || ''
+parsed_frameworks = env_frameworks.split(',')
+frameworks_versions = parsed_frameworks.inject({}) do |frameworks, str|
+  framework, *version = str.split('-')
+  frameworks.merge(framework => version.join('-'))
 end
 
-gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+frameworks_versions.each do |framework, version|
+  case version
+  when 'master'
+    gem framework, github: GITHUB_REPOS.fetch[framework]
+  when /.+/
+    gem framework, "~> #{version}.0"
+  else
+    gem framework
+  end
+end
 
-unless version =~ /^(master|6)/
-  gem 'delayed_job', require: nil
+if frameworks_versions.key?('rails')
+  unless frameworks_versions['rails'] =~ /^(master|6)/
+    gem 'delayed_job', require: nil
+  end
 end
 
 group :bench do
   gem 'ruby-prof', require: nil, platforms: %i[ruby]
   gem 'stackprof', require: nil, platforms: %i[ruby]
 end
+
+gemspec

data/README.md

@@ -1,5 +1,5 @@
 # elastic-apm
-## Elastic APM agent for ♦️Ruby
+## 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) [![codecov](https://codecov.io/gh/elastic/apm-agent-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/apm-agent-ruby)
 
@@ -35,6 +35,35 @@ The official Rubygem for [Elastic][] [APM][].
 If you find a bug, please [report an issue](https://github.com/elastic/apm-agent-ruby/issues).
 For any other assistance, please open or add to a topic on the [APM discuss forum](https://discuss.elastic.co/c/apm).
 
+## Development
+
+A Docker based setup is provided for development.
+
+To run all specs in the official `ruby:latest` image:
+
+```sh
+$ bin/dev
+```
+
+To pick a specific Ruby version, specify it with the `-i` flag:
+
+```sh
+$ bin/dev -i jruby:9.2 
+```
+
+If the first argument is a path starting with `spec/`, the passed specs will be run. Otherwise any arguments passed will be run as a command inside the container:
+
+```sh
+$ bin/dev -i jruby:9.2 spec/integration/rails_spec.rb   # ✅
+$ bin/dev -i some_custom_image bash                     # ✅
+```
+
+To see all options:
+
+```sh
+$ bin/dev -h
+```
+
 ## License
 
 Apache 2.0

data/bin/dev

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: bin/dev [options] [command]'
+
+  opts.on(
+    '-iIMAGE', '--image=IMAGE',
+    'Specify Docker image (eg. ruby:latest)'
+  ) { |val| options[:image] = val }
+
+  opts.on(
+    '-fFRAMEWORKS', '--frameworks=FRAMEWORKS',
+    'Specify frameworks to test (eg. rails:master,sinatra)'
+  ) { |val| options[:frameworks] = val }
+
+  opts.on(
+    '-s', '--skip-build',
+    'Skip building image'
+  ) { |val| options[:skip_build] = val }
+end.parse!
+
+USER_ID_GROUP = %w[u g].map { |f| `id -#{f}`.chomp }.join(':')
+
+RUBY_IMAGE = options.fetch(:image, 'ruby:latest')
+FRAMEWORKS = options.fetch(:frameworks, 'rails,sinatra,grape')
+
+IMAGE_PATH_SAFE = RUBY_IMAGE.gsub(':', '_')
+IMAGE_NAME = "apm-agent-ruby:#{IMAGE_PATH_SAFE}"
+VENDOR_PATH = "/vendor/#{IMAGE_PATH_SAFE}"
+
+def run(cmd)
+  "IMAGE_NAME=#{IMAGE_NAME} #{cmd}".tap do |str|
+    puts str
+    system str
+  end
+end
+
+unless options[:skip_build]
+  run 'docker-compose build ' \
+    " --build-arg RUBY_IMAGE=#{RUBY_IMAGE}" \
+    " --build-arg USER_ID_GROUP=#{USER_ID_GROUP}" \
+    " --build-arg FRAMEWORKS=#{FRAMEWORKS}" \
+    " --build-arg VENDOR_PATH=#{VENDOR_PATH}"
+  exit $?.exitstatus unless $?.success?
+end
+
+run 'docker-compose run' \
+  " -u #{USER_ID_GROUP}" \
+  ' --rm' \
+  " specs #{ARGV.join}"

data/bin/run-tests

@@ -0,0 +1,27 @@
+#!/bin/bash
+set -e
+
+runRspec(){
+  local case=${1:-""}
+  local bn=${case}
+
+  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}
+}
+specific_spec=$1
+
+if [[ $specific_spec = '' ]]; then
+  echo 'Running all specs, including integration'
+
+  runRspec
+  for i in $(find spec/integration -name '*_spec.rb')
+  do
+    runRspec "$i"
+  done
+else
+  echo "Running only $specific_spec"
+
+  runRspec $1
+fi

data/docker-compose.yml

@@ -0,0 +1,32 @@
+---
+version: '3.4'
+
+services:
+  mongodb:
+    image: mongo:latest
+    volumes: ['mongodata:/data/db']
+    ports: ['27017:27017']
+
+  specs:
+    build:
+      context: .
+      args:
+        BUNDLER_VERSION: '2.0.2'
+    image: '$IMAGE_NAME'
+    environment:
+      HOME: '/tmp'
+      MONGODB_URL: 'mongodb:27017'
+    entrypoint:
+      'spec/entrypoint.sh'
+    tty: true
+    volumes:
+      - .:/app:cached
+      - ./vendor:/vendor
+    tmpfs:
+      - /tmp:exec,mode=1777
+    depends_on:
+      - mongodb
+
+volumes:
+  vendor:
+  mongodata: