elastic-apm 2.8.1 → 2.11.0

data/.ci/downstreamTests.groovy

@@ -0,0 +1,188 @@
+#!/usr/bin/env groovy
+@Library('apm@current') _
+
+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.
+*/
+@Field def rubyTasksGen
+
+pipeline {
+  agent { label 'linux && immutable' }
+  environment {
+    REPO="git@github.com:elastic/apm-agent-ruby.git"
+    BASE_DIR="src/github.com/elastic/apm-agent-ruby"
+    PIPELINE_LOG_LEVEL='INFO'
+    NOTIFY_TO = credentials('notify-to')
+    JOB_GCS_BUCKET = credentials('gcs-bucket')
+    JOB_GIT_CREDENTIALS = "f6c7695a-671e-4f4f-a331-acdce44ff9ba"
+    DOCKER_REGISTRY = 'docker.elastic.co'
+    DOCKER_SECRET = 'secret/apm-team/ci/docker-registry/prod'
+    CODECOV_SECRET = 'secret/apm-team/ci/apm-agent-ruby-codecov'
+  }
+  options {
+    timeout(time: 2, unit: 'HOURS')
+    buildDiscarder(logRotator(numToKeepStr: '300', artifactNumToKeepStr: '20', daysToKeepStr: '30'))
+    timestamps()
+    ansiColor('xterm')
+    disableResume()
+    durabilityHint('PERFORMANCE_OPTIMIZED')
+    rateLimitBuilds(throttle: [count: 60, durationName: 'hour', userBoost: true])
+    quietPeriod(10)
+  }
+  parameters {
+    string(name: 'RUBY_VERSION', defaultValue: "ruby:2.6", description: "Ruby version to test")
+    string(name: 'BRANCH_SPECIFIER', defaultValue: "master", description: "Git branch/tag to use")
+  }
+  stages {
+    /**
+    Checkout the code and stash it, to use it on other stages.
+    */
+    stage('Checkout') {
+      agent { label 'immutable' }
+      options { skipDefaultCheckout() }
+      steps {
+        deleteDir()
+        gitCheckout(basedir: "${BASE_DIR}",
+          branch: "${params.BRANCH_SPECIFIER}",
+          repo: "${REPO}",
+          credentialsId: "${JOB_GIT_CREDENTIALS}")
+        stash allowEmpty: true, name: 'source', useDefaultExcludes: false
+      }
+    }
+    stage('Test') {
+      agent { label 'linux && immutable' }
+      options { skipDefaultCheckout() }
+      steps {
+        runTests('.ci/.jenkins_framework.yml')
+      }
+    }
+    stage('Master Test') {
+      agent { label 'linux && immutable' }
+      options { skipDefaultCheckout() }
+      steps {
+        catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE', message: "The tests for the master framework have failed. Let's warn instead.") {
+          runTests('.ci/.jenkins_master_framework.yml')
+        }
+      }
+    }
+  }
+  post {
+    cleanup {
+      script{
+        if(rubyTasksGen?.results){
+          writeJSON(file: 'results.json', json: toJSON(rubyTasksGen.results), pretty: 2)
+          def mapResults = ["Ruby": rubyTasksGen.results]
+          def processor = new ResultsProcessor()
+          processor.processResults(mapResults)
+          archiveArtifacts allowEmptyArchive: true, artifacts: 'results.json,results.html', defaultExcludes: false
+          catchError(buildResult: 'SUCCESS') {
+            def datafile = readFile(file: "results.json")
+            def json = getVaultSecret(secret: 'secret/apm-team/ci/jenkins-stats-cloud')
+            sendDataToElasticsearch(es: json.data.url, data: datafile, restCall: '/jenkins-builds-ruby-test-results/_doc/')
+          }
+        }
+      }
+      notifyBuildResult()
+    }
+  }
+}
+
+/**
+Parallel task generator for the integration tests.
+*/
+class RubyParallelTaskGenerator extends DefaultParallelTaskGenerator {
+
+  public RubyParallelTaskGenerator(Map params){
+    super(params)
+  }
+
+  /**
+  build a clousure that launch and agent and execute the corresponding test script,
+  then store the results.
+  */
+  public Closure generateStep(x, y){
+    return {
+      steps.sleep steps.randomNumber(min:10, max: 30)
+      steps.node('linux && immutable'){
+        // Label is transformed to avoid using the internal docker registry in the x coordinate
+        // TODO: def label = "${tag}:${x?.drop(x?.lastIndexOf('/')+1)}#${y}"
+        def label = "${tag}:${x}#${y}"
+        try {
+          steps.runScript(label: label, ruby: x, framework: y)
+          saveResult(x, y, 1)
+        } catch(e){
+          saveResult(x, y, 0)
+          steps.error("${label} tests failed : ${e.toString()}\n")
+        } finally {
+          steps.junit(allowEmptyResults: true,
+            keepLongStdio: true,
+            testResults: "**/spec/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}")
+          }
+        }
+      }
+    }
+  }
+}
+
+/**
+  Run tests for a Ruby version and framework version.
+*/
+def runScript(Map params = [:]){
+  def label = params.label
+  def ruby = params.ruby
+  def framework = params.framework
+  log(level: 'INFO', text: "${label}")
+  env.HOME = "${env.WORKSPACE}"
+  env.PATH = "${env.PATH}:${env.WORKSPACE}/bin"
+  deleteDir()
+  unstash 'source'
+  dir("${BASE_DIR}"){
+    retry(2){
+      sleep randomNumber(min:10, max: 30)
+      dockerLogin(secret: "${DOCKER_SECRET}", registry: "${DOCKER_REGISTRY}")
+      sh("./spec/scripts/spec.sh ${ruby} ${framework}")
+    }
+  }
+}
+
+/**
+* Whether the given ruby version and framework are in charge of sending the
+* codecov results. It does require the workspace.
+*/
+def isCodecovEnabled(ruby, framework){
+  dir(BASE_DIR){
+    def codecovVersions = readYaml(file: '.ci/.jenkins_codecov.yml')
+    return codecovVersions['ENABLED'].any { it.trim() == "${ruby?.trim()}#${framework?.trim()}" }
+  }
+}
+
+/**
+  Run all the tests for the given ruby version and file with the frameworks to test
+*/
+def runTests(frameworkFile) {
+  deleteDir()
+  unstash "source"
+  dir("${BASE_DIR}"){
+    script {
+      rubyTasksGen = new RubyParallelTaskGenerator(
+        xVersions: [ "${params.RUBY_VERSION}" ],
+        xKey: 'RUBY_VERSION',
+        yKey: 'FRAMEWORK',
+        yFile: frameworkFile,
+        exclusionFile: '.ci/.jenkins_exclude.yml',
+        tag: 'Ruby',
+        name: 'Ruby',
+        steps: this
+      )
+      def mapPatallelTasks = rubyTasksGen.generateParallelTests()
+      parallel(mapPatallelTasks)
+    }
+  }
+}

data/.ci/jobs/apm-agent-ruby-downstream.yml

@@ -0,0 +1,37 @@
+---
+- job:
+    name: apm-agent-ruby/apm-agent-ruby-downstream
+    display-name: APM Agent Ruby Downstream
+    description: APM Agent Ruby Downstream .
+    script-path: .ci/downstreamTests.groovy
+    scm:
+    - github:
+        branch-discovery: no-pr
+        discover-pr-forks-strategy: merge-current
+        discover-pr-forks-trust: permission
+        discover-pr-origin: merge-current
+        discover-tags: true
+        notification-context: 'apm-ci/downstream'
+        property-strategies:
+          all-branches:
+          - suppress-scm-triggering: true
+        repo: apm-agent-ruby
+        repo-owner: elastic
+        credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
+        ssh-checkout:
+          credentials: f6c7695a-671e-4f4f-a331-acdce44ff9ba
+        clean:
+          after: true
+          before: true
+        prune: true
+        shallow-clone: true
+        depth: 3
+        do-not-fetch-tags: true
+        submodule:
+          disable: false
+          recursive: true
+          parent-credentials: true
+          timeout: 100
+        timeout: '15'
+        use-author: true
+        wipe-workspace: 'True'

data/.ci/jobs/apm-agent-ruby-linting-mbp.yml

@@ -0,0 +1,38 @@
+---
+- job:
+    name: apm-agent-ruby/apm-agent-ruby-linting-mbp
+    display-name: APM Agent Ruby Linting
+    description: APM Agent Ruby Linting
+    script-path: .ci/linting.groovy
+    scm:
+    - github:
+        branch-discovery: no-pr
+        discover-pr-forks-strategy: merge-current
+        discover-pr-forks-trust: permission
+        discover-pr-origin: merge-current
+        discover-tags: false
+        notification-context: 'apm-ci/linting'
+        head-filter-regex: '^PR-.*$'
+        repo: apm-agent-ruby
+        repo-owner: elastic
+        credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
+        ssh-checkout:
+          credentials: f6c7695a-671e-4f4f-a331-acdce44ff9ba
+        build-strategies:
+        - change-request:
+            ignore-target-only-changes: false
+        clean:
+          after: true
+          before: true
+        prune: true
+        shallow-clone: true
+        depth: 3
+        do-not-fetch-tags: true
+        submodule:
+          disable: false
+          recursive: true
+          parent-credentials: true
+          timeout: 100
+        timeout: '15'
+        use-author: true
+        wipe-workspace: 'True'

data/.ci/jobs/apm-agent-ruby-mbp.yml

@@ -0,0 +1,41 @@
+---
+- job:
+    name: apm-agent-ruby/apm-agent-ruby-mbp
+    display-name: APM Agent Ruby
+    description: APM Agent Ruby
+    script-path: .ci/Jenkinsfile
+    scm:
+    - github:
+        branch-discovery: no-pr
+        discover-pr-forks-strategy: merge-current
+        discover-pr-forks-trust: permission
+        discover-pr-origin: merge-current
+        discover-tags: true
+        notification-context: 'apm-ci'
+        repo: apm-agent-ruby
+        repo-owner: elastic
+        credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
+        ssh-checkout:
+          credentials: f6c7695a-671e-4f4f-a331-acdce44ff9ba
+        build-strategies:
+        - tags:
+            ignore-tags-older-than: -1
+            ignore-tags-newer-than: -1
+        - regular-branches: true
+        - change-request:
+            ignore-target-only-changes: false
+        clean:
+          after: true
+          before: true
+        prune: true
+        shallow-clone: true
+        depth: 3
+        do-not-fetch-tags: true
+        submodule:
+          disable: false
+          recursive: true
+          parent-credentials: true
+          timeout: 100
+        timeout: '15'
+        use-author: true
+        wipe-workspace: 'True'

data/.ci/jobs/apm-agent-ruby.yml

@@ -0,0 +1,4 @@
+---
+- job:
+    name: apm-agent-ruby
+    project-type: folder

data/.ci/jobs/defaults.yml

@@ -0,0 +1,24 @@
+---
+
+##### GLOBAL METADATA
+
+- meta:
+    cluster: apm-ci
+
+##### JOB DEFAULTS
+
+- job:
+    view: APM-CI
+    project-type: multibranch
+    logrotate:
+      daysToKeep: 30
+      numToKeep: 300
+    number-to-keep: '100'
+    days-to-keep: '30'
+    concurrent: true
+    node: linux
+    periodic-folder-trigger: 1d
+    prune-dead-branches: true
+    publishers:
+    - email:
+        recipients: infra-root+build@elastic.co

data/.ci/linting.groovy

@@ -0,0 +1,32 @@
+#!/usr/bin/env groovy
+@Library('apm@current') _
+
+pipeline {
+  agent { label 'docker && linux && immutable' }
+  options {
+    buildDiscarder(logRotator(numToKeepStr: '20', artifactNumToKeepStr: '20', daysToKeepStr: '30'))
+    timestamps()
+    ansiColor('xterm')
+    disableResume()
+    durabilityHint('PERFORMANCE_OPTIMIZED')
+    rateLimitBuilds(throttle: [count: 60, durationName: 'hour', userBoost: true])
+    quietPeriod(10)
+  }
+  triggers {
+    issueCommentTrigger('(?i).*(?:jenkins\\W+)?run\\W+(?:the\\W+)?linters(?:\\W+please)?.*')
+  }
+  stages {
+    stage('Sanity checks') {
+      environment {
+        HOME = "${env.WORKSPACE}"
+        PATH = "${env.WORKSPACE}/bin:${env.PATH}"
+      }
+      steps {
+        script {
+          def sha = getGitCommitSha()
+          preCommit(commit: "${sha}", junit: true)
+        }
+      }
+    }
+  }
+}

data/.ci/prepare-git-context.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -exo pipefail
+
+# Enable git+ssh. Env variables are created on the fly with the gitCheckout
+git config remote.origin.url "git@github.com:${ORG_NAME}/${REPO_NAME}.git"
+
+# Enable to fetch branches when cloning with a detached and shallow clone
+git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
+
+# Force the git user details when pushing using the last commit details
+USER_MAIL=$(git log -1 --pretty=format:'%ae')
+USER_NAME=$(git log -1 --pretty=format:'%an')
+git config --global user.email "${USER_MAIL}"
+git config --global user.name "${USER_NAME}"
+
+# Checkout the branch as it's detached based by default.
+# See https://issues.jenkins-ci.org/browse/JENKINS-33171
+git fetch --all
+git checkout "${BRANCH_NAME}"
+
+# Ensure the master branch points to the original commit to avoid commit injection
+# when running the release pipeline.
+git reset --hard "${GIT_COMMIT}"

data/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+-   repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    -   id: check-case-conflict
+    -   id: check-executables-have-shebangs
+    -   id: check-json
+    -   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

data/.rspec

@@ -1,3 +1,2 @@
 --color
 --require spec_helper
---format documentation

data/.rubocop.yml

@@ -66,9 +66,6 @@ Style/DoubleNegation:
 Style/EmptyMethod:
   Enabled: false
 
-Rails/Delegate:
-  Enabled: false
-
 Style/NumericPredicate:
   Enabled: false
 
@@ -83,3 +80,6 @@ Naming/MemoizedInstanceVariableName:
 
 Style/SpecialGlobalVars:
   Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,63 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 2.11.0 (2019-09-23)
+
+### Added
+
+- Add `Rails` module with `#start` method to run Rails setup explicitly ([#522](https://github.com/elastic/apm-agent-ruby/pull/522))
+- Support for log/trace correlation ([#527](https://github.com/elastic/apm-agent-ruby/pull/527))
+
+### Changed
+
+- Split dot-separated `span.type` into `.type`, `.subtype` and `.action` (auto-upgrades dot style) ([#531](https://github.com/elastic/apm-agent-ruby/pull/531))
+
+## 2.10.1
+
+### Fixed
+
+- Fixed loading options from a config file specified by `ELASTIC_APM_CONFIG_FILE` ([#518](https://github.com/elastic/apm-agent-ruby/pull/518))
+- Fixed an issue with CentralConfig polling not starting ([#525](https://github.com/elastic/apm-agent-ruby/pull/525))
+
+### Added
+
+- Support for chained exceptions ([#488](https://github.com/elastic/apm-agent-ruby/pull/488))
+
+## 2.10.0
+
+### Added
+
+- Add Ruby specific metrics ([#437](https://github.com/elastic/apm-agent-ruby/pull/437))
+- Support for APM Agent Configuration via Kibana ([#464](https://github.com/elastic/apm-agent-ruby/pull/464))
+- Change span name format and add command to context's db.statement for `MongoSpy` ([#488](https://github.com/elastic/apm-agent-ruby/pull/490))
+
+### Changed
+
+- `ElasticAPM.report` and `ElasticAPM.report_message` return the string ID of the generated `Error` objects ([#507](https://github.com/elastic/apm-agent-ruby/pull/507))
+
+## 2.9.1 (2019-06-28)
+
+### Fixed
+
+- Use system CA certificate if none is specified ([#460](https://github.com/elastic/apm-agent-ruby/pull/460))
+
+## 2.9.0 (2019-06-25)
+
+### Security
+
+- **NB:** If you are using a custom CA cert via `server_ca_cert`, versions of the agent prior to 2.9.0 may not have validated the certificate of APM Server correctly.
+
+### Added
+
+- Add `transaction.type` to errors ([#434](https://github.com/elastic/apm-agent-ruby/pull/434))
+- Add cookies to `request.cookies` ([#448](https://github.com/elastic/apm-agent-ruby/pull/448))
+
+### Fixed
+
+- Fix support for older versions of Http.rb ([#438](https://github.com/elastic/apm-agent-ruby/pull/434))
+- Strip `Cookie` and `Set-Cookie` from headers ([#448](https://github.com/elastic/apm-agent-ruby/pull/448))
+- Fix disabling SSL verification ([#449](https://github.com/elastic/apm-agent-ruby/pull/449))
+
 ## 2.8.1 (2019-05-29)
 
 ### Fixed
@@ -59,7 +116,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 Both APIs are backwards compatible with fallbacks and deprecation warnings, scheduled for removal in next major release.
 
-### Added 
+### Added
 
 - Configuration options to use an HTTP proxy ([#352](https://github.com/elastic/apm-agent-ruby/pull/352))
 
@@ -120,7 +177,7 @@ Both APIs are backwards compatible with fallbacks and deprecation warnings, sche
 ### Added
 
 - Support for [OpenTracing](https://opentracing.io) ([#273](https://github.com/elastic/apm-agent-ruby/pull/273))
-- Add capture_* options ([#279](https://github.com/elastic/apm-agent-ruby/pull/279))
+- Add capture\_\* options ([#279](https://github.com/elastic/apm-agent-ruby/pull/279))
 - Evaluate the config file as ERB ([#288](https://github.com/elastic/apm-agent-ruby/pull/288))
 
 ### Changed