elastic-apm 2.8.1 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11b66b86db45e066da0c6055bd5cb58894a5ba0eca8fb9d891b5b918fcd8d7c0
-  data.tar.gz: 87bfdbcc9b57f128f032d8e617dfe4540fcf8afeea91f80621d5e1a6b476d47e
+  metadata.gz: 45fe1b55dccff365970dd59f2a4f58d9cb76141fd3651e7ce9c166b796bfce0a
+  data.tar.gz: 66a2df97b05471613e7d1b5eecdb739ccbf94514b15730cb065153c7128503da
 SHA512:
-  metadata.gz: a514f4463ee2294d1e825fd9ba0b42a764d8380e9ea4ba90254acf92ebd7ffec8d4f2a329a77307732e7206a22009c3cb91218650e499235d8ca2cae3cf1d8ae
-  data.tar.gz: 93e558bab35f323f77116031333ce065fa00b101871ea80e913b082612552857dadc9074c6c4219bf97010eddc6b9abc996fa2dac68454aed1dcb91048c9bd6c
+  metadata.gz: e542f184535be90fee811ceee0fd404f65b59575b0e90a8dc8023807ec5b535f9d1c084b7654f5c59fed9d5521a2cbf5f2bd70dac8691db009be1dd24b07be5f
+  data.tar.gz: 7d87ebdbbfc32727017f6f0fa8451640ac3fef289366bc3a077899d874bb346a3b94dbadafe96596f2b1a8163c42d79b1b41ce940c6e1fd8fb358fc96767ca84

data/.ci/.jenkins_codecov.yml

@@ -0,0 +1,5 @@
+---
+# Tuple of ruby version and frameworks which are in charge to send data to codecov.
+# # is the separator between the ruby version and the framework.
+ENABLED:
+  - ruby:2.6#rails-6.0

data/.ci/.jenkins_exclude.yml

@@ -0,0 +1,63 @@
+exclude:
+  # Tests fail, but we don't care
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: rails-4.2
+  - RUBY_VERSION: jruby:9.1
+    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
+    FRAMEWORK: rails-4.2
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: rails-4.2
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
+    FRAMEWORK: rails-4.2
+
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: rails-6.0
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: rails-6.0
+  - RUBY_VERSION: jruby:9.1
+    FRAMEWORK: rails-6.0
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
+    FRAMEWORK: rails-6.0
+
+  # Only test master on newest ruby
+  - RUBY_VERSION: ruby:2.5
+    FRAMEWORK: rails-master
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: rails-master
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: rails-master
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: rails-master
+  - RUBY_VERSION: jruby:9.1
+    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
+    FRAMEWORK: rails-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: rails-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
+    FRAMEWORK: rails-master
+
+  - RUBY_VERSION: ruby:2.5
+    FRAMEWORK: sinatra-master
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: sinatra-master
+  - RUBY_VERSION: ruby:2.3
+    FRAMEWORK: sinatra-master
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: sinatra-master
+  - RUBY_VERSION: jruby:9.1
+    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
+    FRAMEWORK: sinatra-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: sinatra-master
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.1-7-jdk
+    FRAMEWORK: sinatra-master
+

data/.ci/.jenkins_framework.yml

@@ -0,0 +1,9 @@
+FRAMEWORK:
+  - rails-6.0
+  - rails-5.2
+  - rails-5.1
+  - rails-5.0
+  - rails-4.2
+
+  - sinatra-2.0
+  - sinatra-1.4

data/.ci/.jenkins_master_framework.yml

@@ -0,0 +1,3 @@
+FRAMEWORK:
+  - rails-master
+  - sinatra-master

data/.ci/.jenkins_ruby.yml

@@ -0,0 +1,11 @@
+RUBY_VERSION:
+  - ruby:2.6
+  - ruby:2.5
+  - ruby:2.4
+  - ruby:2.3
+  - jruby:9.2
+  - jruby:9.1
+  - 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
+  - docker.elastic.co/observability-ci/jruby:9.1-7-jdk

data/.ci/Jenkinsfile

@@ -0,0 +1,268 @@
+#!/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 = 'apm-agent-ruby'
+    BASE_DIR = "src/github.com/elastic/${env.REPO}"
+    PIPELINE_LOG_LEVEL='DEBUG'
+    NOTIFY_TO = credentials('notify-to')
+    JOB_GCS_BUCKET = credentials('gcs-bucket')
+    CODECOV_SECRET = 'secret/apm-team/ci/apm-agent-ruby-codecov'
+    DOCKER_REGISTRY = 'docker.elastic.co'
+    DOCKER_SECRET = 'secret/apm-team/ci/docker-registry/prod'
+    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'
+  }
+  options {
+    timeout(time: 2, unit: 'HOURS')
+    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+)?tests(?:\\W+please)?.*')
+  }
+  parameters {
+    booleanParam(name: 'Run_As_Master_Branch', defaultValue: false, description: 'Allow to run any steps on a PR, some steps normally only run on master branch.')
+    booleanParam(name: 'bench_ci', defaultValue: true, description: 'Enable run benchmarks.')
+  }
+  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}", githubNotifyFirstTimeContributor: true)
+        stash allowEmpty: true, name: 'source', useDefaultExcludes: false
+      }
+    }
+    stage('Sanity checks') {
+      agent { label 'linux && immutable && docker' }
+      when {
+        beforeAgent true
+        anyOf {
+          not { changeRequest() }
+          expression { return params.Run_As_Master_Branch }
+        }
+      }
+      options { skipDefaultCheckout() }
+      environment {
+        HOME = "${env.WORKSPACE}"
+        PATH = "${env.WORKSPACE}/bin:${env.PATH}"
+      }
+      steps {
+        withGithubNotify(context: 'Sanity checks') {
+          deleteDir()
+          unstash 'source'
+          dir(BASE_DIR) {
+            catchError(buildResult: 'SUCCESS', stageResult: 'UNSTABLE', message: 'Sanity checks failed but keep running the build') {
+              preCommit(commit: "${GIT_BASE_COMMIT}", junit: true)
+            }
+          }
+        }
+      }
+    }
+    /**
+    Execute unit tests.
+    */
+    stage('Test') {
+      agent { label 'linux && immutable' }
+      options { skipDefaultCheckout() }
+      steps {
+        withGithubNotify(context: 'Tests', tab: 'tests') {
+          deleteDir()
+          unstash "source"
+          dir("${BASE_DIR}"){
+            script {
+              def ruby = readYaml(file: '.ci/.jenkins_ruby.yml')
+              def testTasks = [:]
+              ruby['RUBY_VERSION'].each{ rubyVersion ->
+                testTasks[rubyVersion] = { runJob(rubyVersion) }
+              }
+              parallel(testTasks)
+              }
+            }
+          }
+        }
+      }
+      stage('Benchmarks') {
+        options { skipDefaultCheckout() }
+        when {
+          beforeAgent true
+          allOf {
+            anyOf {
+              branch 'master'
+              branch "\\d+\\.\\d+"
+              branch "v\\d?"
+              tag "v\\d+\\.\\d+\\.\\d+*"
+              expression { return params.Run_As_Master_Branch }
+            }
+            expression { return params.bench_ci }
+          }
+        }
+        stages {
+          stage('Clean Workspace') {
+            agent { label 'metal' }
+            steps {
+              echo "Cleaning Workspace"
+            }
+            post {
+              always {
+                cleanWs()
+              }
+            }
+          }
+          /**
+            Run the benchmarks and store the results on ES.
+            The result JSON files are also archive into Jenkins.
+          */
+          stage('Run Benchmarks') {
+            agent { label 'linux && immutable' }
+            steps {
+              withGithubNotify(context: 'Run Benchmarks') {
+                deleteDir()
+                unstash 'source'
+                dir("${BASE_DIR}"){
+                  script {
+                    def versions = readYaml(file: ".ci/.jenkins_ruby.yml")
+                    def benchmarkTask = [:]
+                    versions['RUBY_VERSION'].each{ v ->
+                      benchmarkTask[v] = runBenchmark(v)
+                    }
+                    parallel(benchmarkTask)
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+      stage('Integration Tests') {
+        agent none
+        when {
+          beforeAgent true
+          allOf {
+            anyOf {
+              environment name: 'GIT_BUILD_CAUSE', value: 'pr'
+              expression { return !params.Run_As_Master_Branch }
+            }
+          }
+        }
+        steps {
+          log(level: 'INFO', text: 'Launching Async ITs')
+          build(job: env.ITS_PIPELINE, propagate: false, wait: false,
+                parameters: [string(name: 'AGENT_INTEGRATION_TEST', value: 'Ruby'),
+                             string(name: 'BUILD_OPTS', value: "--ruby-agent-version ${env.GIT_BASE_COMMIT} --ruby-agent-version-state ${env.GIT_BUILD_CAUSE} --ruby-agent-repo ${env.CHANGE_FORK?.trim() ?: 'elastic'}/${env.REPO}"),
+                             string(name: 'GITHUB_CHECK_NAME', value: env.GITHUB_CHECK_ITS_NAME),
+                             string(name: 'GITHUB_CHECK_REPO', value: env.REPO),
+                             string(name: 'GITHUB_CHECK_SHA1', value: env.GIT_BASE_COMMIT)]
+          )
+          githubNotify(context: "${env.GITHUB_CHECK_ITS_NAME}", description: "${env.GITHUB_CHECK_ITS_NAME} ...", status: 'PENDING', targetUrl: "${env.JENKINS_URL}search/?q=${env.ITS_PIPELINE.replaceAll('/','+')}")
+        }
+      }
+      stage('Release') {
+        options { skipDefaultCheckout() }
+        environment {
+          RUBY_DOCKER_TAG = 'ruby:2.6'
+        }
+        when {
+          beforeAgent true
+          anyOf {
+            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'
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+    post {
+      cleanup {
+        notifyBuildResult()
+      }
+    }
+  }
+
+/**
+  Run benchmarks for a Ruby version, then report the results to the Elasticsearch server.
+*/
+def runBenchmark(version){
+  return {
+    node('metal'){
+      // Transform the versions like:
+      //  - docker.elastic.co/observability-ci/jruby:9.2-12-jdk to jruby-9.2-12-jdk
+      //  - jruby:9.1 to jruby-9.1
+      def transformedVersion = version.replaceAll('.*/', '').replaceAll(':', '-')
+      env.HOME = "${env.WORKSPACE}/${transformedVersion}"
+      dir("${transformedVersion}"){
+        deleteDir()
+        unstash 'source'
+        dir("${BASE_DIR}"){
+          retry(2){
+            sleep randomNumber(min:10, max: 30)
+            dockerLogin(secret: "${DOCKER_SECRET}", registry: "${DOCKER_REGISTRY}")
+          }
+          try{
+            sh "./spec/scripts/benchmarks.sh ${version}"
+          } catch(e){
+            throw e
+          } finally {
+            archiveArtifacts(
+              allowEmptyArchive: true,
+              artifacts: "**/benchmark-${transformedVersion}.raw,**/benchmark-${transformedVersion}.error",
+              onlyIfSuccessful: false)
+            sendBenchmarks(file: "benchmark-${transformedVersion}.bulk",
+              index: "benchmark-ruby", archive: true)
+          }
+        }
+      }
+    }
+  }
+}
+
+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
+  )
+}

data/.ci/bin/check_paths_for_matches.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+"""
+Small wrapper script for jenkins to see if a regex pattern matches any of the
+paths generated by diffing between two commits.
+"""
+import argparse
+import os
+import re
+import subprocess
+import sys
+
+debug = "DEBUG" in os.environ
+
+
+def check_paths_for_matches(pattern, git_commit, git_previous_commit):
+    """Check if any paths between GIT_PREVIOUS_COMMIT and GIT_COMMIT match our pattern.
+
+    For merge commits only actual path changes are included rather than changes
+    from all parents. If GIT_PREVIOUS_COMMIT is not populated, use just the
+    paths that GIT_COMMIT represents. If GIT_PREVIOUS_COMMIT is not populated
+    and GIT_COMMIT is a merge commit, use all path changes from each parent. If
+    GIT_PREVIOUS_COMMIT is the same as GIT_COMMIT, that should generate no path
+    changes.
+    """
+    # Handle case where GIT_PREVIOUS_COMMIT isn't set (e.g. the first build),
+    if not git_previous_commit:
+        command = [
+            "git",
+            "diff-tree",
+            "-m",
+            "--no-commit-id",
+            "--name-only",
+            "-r",
+            git_commit,
+        ]
+    else:
+        command = ["git", "diff", "--name-only", git_previous_commit, git_commit]
+
+    # Run the command and populate paths.
+    completed_process = subprocess.run(
+        command, check=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
+    )
+    paths = completed_process.stdout.decode().strip().split("\n")
+
+    # Look for any matches of pattern -> path.
+    possible_matches = [(path, pattern.match(path)) for path in paths]
+    if any([match for path, match in possible_matches]):
+        if debug:
+            print("matching change(s) found for {}".format(git_commit))
+            for path, match in possible_matches:
+                if match:
+                    print(path)
+        sys.stdout.write("match")
+        sys.stdout.flush()
+        exit(0)
+    else:
+        if debug:
+            print("no matching change(s) found for {}".format(git_commit))
+        exit(1)
+
+
+if __name__ == "__main__":
+    # Change our working directory so we're in $WORKSPACE.
+    os.chdir(os.path.dirname(os.path.abspath(__file__)))
+
+    # Define and parse arguments.
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--pattern", help="A regular expression pattern.")
+    parser.add_argument(
+        "--git-commit", help="The contents of the GIT_COMMIT environmental variable."
+    )
+    parser.add_argument(
+        "--git-previous-commit",
+        nargs="?",
+        help="The contents of the GIT_PREVIOUS_COMMIT environmental variable.",
+    )
+    args = parser.parse_args()
+
+    compiled_pattern = re.compile(args.pattern)
+    check_paths_for_matches(compiled_pattern, args.git_commit, args.git_previous_commit)