elastic-apm 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6058bb61034dc14b1b22a3a5f45a592721b968d314bb5f63ca171c600bbb1bc
-  data.tar.gz: fffcd9160ec251a5ad51aae149dbfc3f50cf16b3fc866385f24f83f555b8b804
+  metadata.gz: aaf3f0eada3b3bfe036dc55802688666e3df0ee48848b45dd73aa6861e625dc6
+  data.tar.gz: feb50b6f3d2da29af6591f31a62ea95189ab64868fb5403e3d85ceec548868d8
 SHA512:
-  metadata.gz: f7a8bd72f34f7158619c124e4eff24c9b5d57e68c3b5761b1a6305e632f3aff549be7ed37924775d8ad61119f99a87081567969c0e386641b8789662ff3f54ca
-  data.tar.gz: a8ce8dc0c3a3def4e08ca68b33d73c288bb6ca1fe6a6ff5fd0bbfe5e03f695848855c91b024e28e2ad0872895afa5659c8ff07f06b16277ea9755c0598d711b9
+  metadata.gz: b7bcd197586b7782f25fa814ec0430c33f7b21abaa6b79c81fe93ee07654df1448eea4257f8c29b6f6dce1b7778c0b88f6e825a1338bdba591fd4934b9bcaa09
+  data.tar.gz: 181bf8aa045473ef55cb794199638722e1bd7f142e558077928a94e03ca75812d21633c6781e734d7029b12e9b4d54232498f604a6be26f70daaffcd1e91f03e

data/.ci/.jenkins_exclude.yml

@@ -1,5 +1,6 @@
 exclude:
-  # Tests fail, but we don't care
+  - RUBY_VERSION: ruby:2.7-rc
+    FRAMEWORK: rails-4.2
   - RUBY_VERSION: jruby:9.2
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: jruby:9.1
@@ -25,6 +26,8 @@ exclude:
     FRAMEWORK: rails-6.0
 
   # Only test master on newest ruby
+  - RUBY_VERSION: ruby:2.7-rc
+    FRAMEWORK: rails-master
   - RUBY_VERSION: ruby:2.5
     FRAMEWORK: rails-master
   - RUBY_VERSION: ruby:2.4
@@ -67,6 +70,8 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
     FRAMEWORK: sinatra-master
 
+  - RUBY_VERSION: ruby:2.7-rc
+    FRAMEWORK: grape-master
   - RUBY_VERSION: ruby:2.5
     FRAMEWORK: grape-master
   - RUBY_VERSION: ruby:2.4
@@ -88,6 +93,8 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
     FRAMEWORK: grape-master
 
+  - RUBY_VERSION: ruby:2.7-rc
+    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
   - RUBY_VERSION: ruby:2.4

data/.ci/.jenkins_ruby.yml

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

data/.ci/Jenkinsfile

@@ -5,10 +5,9 @@ import co.elastic.matrix.*
 import groovy.transform.Field
 
 /**
-This is the parallel tasks generator,
-it is need as field to store the results of the tests.
+ This is required to store the results of the tests.
 */
-@Field def rubyTasksGen
+@Field def rubyTasksFailed = false
 
 pipeline {
   agent { label 'linux && immutable' }
@@ -24,6 +23,7 @@ pipeline {
     GITHUB_CHECK_ITS_NAME = 'Integration Tests'
     ITS_PIPELINE = 'apm-integration-tests-selector-mbp/master'
     RELEASE_SECRET = 'secret/apm-team/ci/apm-agent-ruby-rubygems-release'
+    OPBEANS_REPO = 'opbeans-ruby'
   }
   options {
     timeout(time: 2, unit: 'HOURS')
@@ -49,6 +49,7 @@ pipeline {
     stage('Checkout') {
       options { skipDefaultCheckout() }
       steps {
+        pipelineManager([ cancelPreviousRunningBuilds: [ when: 'PR' ] ])
         deleteDir()
         gitCheckout(basedir: "${BASE_DIR}", githubNotifyFirstTimeContributor: true)
         stash allowEmpty: true, name: 'source', useDefaultExcludes: false
@@ -155,15 +156,21 @@ pipeline {
           }
         }
       }
+      stage('Populate Test failures') {
+        when {
+          expression { return rubyTasksFailed }
+        }
+        steps {
+          error('There were some failures when running the "Test" stage')
+        }
+      }
       stage('Integration Tests') {
         agent none
         when {
           beforeAgent true
-          allOf {
-            anyOf {
-              environment name: 'GIT_BUILD_CAUSE', value: 'pr'
-              expression { return !params.Run_As_Master_Branch }
-            }
+          anyOf {
+            changeRequest()
+            expression { return !params.Run_As_Master_Branch }
           }
         }
         steps {
@@ -186,23 +193,25 @@ pipeline {
         }
         when {
           beforeAgent true
-          anyOf {
-            tag pattern: 'v\\d+.*', comparator: 'REGEXP'
-          }
+          tag pattern: 'v\\d+.*', comparator: 'REGEXP'
         }
-        steps {
-          withGithubNotify(context: 'Release') {
-            deleteDir()
-            unstash 'source'
-            script {
-              dir(BASE_DIR){
-                docker.image("${env.RUBY_DOCKER_TAG}").inside('-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']) {
-                        sh '.ci/prepare-git-context.sh'
-                        sh 'gem install rake yard rspec'
-                        sh 'rake release'
+        stages {
+          stage('Release') {
+            steps {
+              withGithubNotify(context: 'Release') {
+                deleteDir()
+                unstash 'source'
+                script {
+                  dir(BASE_DIR){
+                    docker.image("${env.RUBY_DOCKER_TAG}").inside('-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']) {
+                            sh '.ci/prepare-git-context.sh'
+                            sh 'gem install rake yard rspec'
+                            sh 'rake release'
+                          }
+                        }
                       }
                     }
                   }
@@ -210,6 +219,23 @@ pipeline {
               }
             }
           }
+          stage('Opbeans') {
+            environment {
+              REPO_NAME = "${OPBEANS_REPO}"
+            }
+            steps {
+              deleteDir()
+              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'
+                // The opbeans pipeline will trigger a release for the master branch
+                gitPush()
+                // The opbeans pipeline will trigger a release for the release tag
+                gitCreateTag(tag: "${env.BRANCH_NAME}")
+              }
+            }
+          }
         }
       }
     }
@@ -258,11 +284,18 @@ def runBenchmark(version){
 }
 
 def runJob(rubyVersion){
-  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
-  )
+  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
+    )
+  } catch(e) {
+    rubyTasksFailed = true
+    warnError('Test Failures') {
+      error("Downstream job for '${rubyVersion}' failed")
+    }
+  }
 }

data/.github/workflows/main.yml

@@ -0,0 +1,14 @@
+name: Lint
+
+on: [push]
+
+jobs:
+  build:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Rubocop checks
+      uses: mikker/rubocop-action@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.pre-commit-config.yaml

@@ -8,15 +8,11 @@ repos:
     -   id: check-merge-conflict
     -   id: check-yaml
     -   id: check-xml
-    -   id: end-of-file-fixer
 
 -   repo: git@github.com:elastic/apm-pipeline-library
     rev: current
     hooks:
     -   id: check-bash-syntax
-    -   id: check-abstract-classes-and-trait
-    -   id: check-jsonslurper-class
     -   id: check-jenkins-pipelines
-    -   id: check-unicode-non-breaking-spaces
-    -   id: remove-unicode-non-breaking-spaces
     -   id: check-jjbb
+    -   id: check-unicode-non-breaking-spaces

data/.rubocop.yml

@@ -5,49 +5,67 @@ AllCops:
     - 'vendor/**/*'
     - 'bench/*'
 
-Layout/AlignArguments:
+require:
+  - rubocop-performance
+
+# Layout/
+
+Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
-Layout/IndentFirstParameter:
+Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
-Layout/AlignHash:
-  Exclude:
-    - 'Gemfile'
-
-Layout/EmptyLinesAroundArguments:
+Layout/FirstParameterIndentation:
   Enabled: false
 
+# Lint/
+
 Lint/RescueException:
   Enabled: false
 
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
-Lint/NonLocalExitFromIterator:
+# Metrics /
+
+Metrics/AbcSize:
   Enabled: false
 
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*.rb'
+Metrics/ClassLength:
+  Enabled: false
 
 Metrics/ModuleLength:
-  Exclude:
-    - 'spec/**/*.rb'
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+# Naming/
 
 Naming/PredicateName:
   Enabled: false
 
 Naming/FileName:
-  Exclude:
-    - 'lib/elastic-apm.rb'
+  Exclude: ['lib/elastic-apm.rb']
 
 Naming/AccessorMethodName:
   Enabled: false
 
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+# Style/
+
 Style/Alias:
   Enabled: false
 
@@ -57,9 +75,6 @@ Style/IfUnlessModifier:
 Style/FormatStringToken:
   Enabled: false
 
-Style/SafeNavigation:
-  Enabled: false
-
 Style/DoubleNegation:
   Enabled: false
 
@@ -72,15 +87,6 @@ Style/NumericPredicate:
 Style/PerlBackrefs:
   Enabled: false
 
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-
-Naming/MemoizedInstanceVariableName:
-  Enabled: false
-
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
 Style/SpecialGlobalVars:
   Enabled: false
 

data/CHANGELOG.asciidoc

@@ -26,11 +26,31 @@ endif::[]
 [float]
 ===== Fixed
 - Fix {pull}2526[#2526]
+
+[float]
+[[unreleased]]
+==== Unreleased
 ////
 
 [[release-notes-3.x]]
 === Ruby Agent version 3.x
 
+[[release-notes-3.3.0]]
+==== 3.2.0 (2019-12-05)
+
+[float]
+===== Added
+
+- Add option `disable_metrics` {pull}625[#625]
+
+[float]
+===== Fixed
+
+- Make Filters thread-safe {pull}624[#624]
+- Omit passwords in outgoing urls {pull}629[#629]
+- Add missing mutex to Counter metrics {pull}636[#636]
+- Correct span context collection name for Mongo getMore commands {pull}637[#637]
+
 [[release-notes-3.2.0]]
 ==== 3.2.0 (2019-11-19)
 
@@ -51,10 +71,6 @@ endif::[]
 - 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
-
 [[release-notes-3.1.0]]
 ==== 3.1.0 (2019-10-21)
 

data/Gemfile

@@ -11,6 +11,7 @@ gem 'rack-test'
 gem 'rspec', '~> 3'
 gem 'rspec-its'
 gem 'rubocop', require: nil
+gem 'rubocop-performance', require: nil
 gem 'timecop'
 gem 'webmock'
 

data/README.md

@@ -1,7 +1,7 @@
 # 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) [![codecov](https://codecov.io/gh/elastic/apm-agent-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/apm-agent-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)
 
 The official Rubygem for [Elastic][] [APM][].
 
@@ -48,7 +48,7 @@ $ bin/dev
 To pick a specific Ruby version, specify it with the `-i` flag:
 
 ```sh
-$ bin/dev -i jruby:9.2 
+$ 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:

data/bin/dev

@@ -28,7 +28,7 @@ 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_PATH_SAFE = RUBY_IMAGE.tr(':', '_')
 IMAGE_NAME = "apm-agent-ruby:#{IMAGE_PATH_SAFE}"
 VENDOR_PATH = "/vendor/#{IMAGE_PATH_SAFE}"
 

data/bin/run-tests

@@ -18,6 +18,9 @@ if [[ $specific_spec = '' ]]; then
   runRspec
   for i in $(find spec/integration -name '*_spec.rb')
   do
+    echo "========================================"
+    echo $i
+    echo "========================================"
     runRspec "$i"
   done
 else

data/docs/api.asciidoc

@@ -276,35 +276,6 @@ Returns `[String]` ID of the generated `[ElasticAPM::Error]` object.
 [[api-context]]
 === Context
 
-[float]
-[[api-agent-set-tag]]
-==== `ElasticAPM.set_tag`
-
-Add a tag to the current transaction.
-Tags are basic key-value pairs that are indexed in your Elasticsearch database
-and therefore searchable. The value will always be converted to a String.
-
-TIP: Before using custom tags, ensure you understand the different types of
-{apm-overview-ref-v}/metadata.html[metadata] that are available.
-
-[source,ruby]
-----
-before_action do
-  ElasticAPM.set_tag(:company_id, current_user.company.id)
-end
-----
-
-Arguments:
-
-  * `key`: A string key. Note that `.`, `*` or `"` will be converted to `_`.
-  * `value`: A string value.
-
-Returns the set `value`.
-
-WARNING: Be aware that tags are indexed in Elasticsearch. Using too many unique keys will result in *https://www.elastic.co/blog/found-crash-elasticsearch#mapping-explosion[Mapping explosion]*.
-
-NOTE: This method has been deprecated in favor of `set_label`, which does not convert values to Strings.
-
 [float]
 [[api-agent-set-label]]
 ==== `ElasticAPM.set_label`