elastic-apm 2.8.1 → 2.11.0

data/lib/elastic_apm/transport/connection/proxy_pipe.rb

@@ -9,8 +9,15 @@ module ElasticAPM
       # @api private
       class ProxyPipe
         def initialize(enc = nil, compress: true)
-          @read, wr = IO.pipe(enc)
+          rd, wr = IO.pipe(enc)
+
+          @read = rd
           @write = Write.new(wr, compress: compress)
+
+          # Http.rb<4 calls rewind on the request bodies, but IO::Pipe raises
+          # ~mikker
+          return if HTTP::VERSION.to_i >= 4
+          def rd.rewind; end
         end
 
         attr_reader :read, :write

data/lib/elastic_apm/transport/filters/secrets_filter.rb

@@ -14,7 +14,8 @@ module ElasticAPM
           /secret/i,
           /token/i,
           /api[-._]?key/i,
-          /session[-._]?id/i
+          /session[-._]?id/i,
+          /(set[-_])?cookie/i
         ].freeze
 
         VALUE_FILTERS = [
@@ -30,6 +31,7 @@ module ElasticAPM
         def call(payload)
           strip_from! payload.dig(:transaction, :context, :request, :headers)
           strip_from! payload.dig(:transaction, :context, :request, :env)
+          strip_from! payload.dig(:transaction, :context, :request, :cookies)
           strip_from! payload.dig(:transaction, :context, :response, :headers)
           strip_from! payload.dig(:error, :context, :request, :headers)
           strip_from! payload.dig(:error, :context, :response, :headers)

data/lib/elastic_apm/transport/serializers/error_serializer.rb

@@ -14,7 +14,7 @@ module ElasticAPM
           base = {
             id: error.id,
             transaction_id: error.transaction_id,
-            transaction: error.transaction,
+            transaction: build_transaction(error.transaction),
             trace_id: error.trace_id,
             parent_id: error.parent_id,
 
@@ -48,7 +48,8 @@ module ElasticAPM
             code: keyword_field(exception.code),
             attributes: exception.attributes,
             stacktrace: exception.stacktrace.to_a,
-            handled: exception.handled
+            handled: exception.handled,
+            cause: exception.cause && [build_exception(exception.cause)]
           }
         end
 
@@ -61,6 +62,15 @@ module ElasticAPM
             stacktrace: log.stacktrace.to_a
           }
         end
+
+        def build_transaction(transaction)
+          return unless transaction
+
+          {
+            sampled: transaction[:sampled],
+            type: keyword_field(transaction[:type])
+          }
+        end
       end
     end
   end

data/lib/elastic_apm/transport/serializers/metadata_serializer.rb

@@ -10,7 +10,8 @@ module ElasticAPM
             metadata: {
               service: build_service(metadata.service),
               process: build_process(metadata.process),
-              system: build_system(metadata.system)
+              system: build_system(metadata.system),
+              labels: build_labels(metadata.labels)
             }
           }
         end
@@ -59,6 +60,10 @@ module ElasticAPM
             kubernetes: keyword_object(system.kubernetes)
           }
         end
+
+        def build_labels(labels)
+          keyword_object(labels)
+        end
       end
     end
   end

data/lib/elastic_apm/transport/serializers/span_serializer.rb

@@ -13,7 +13,7 @@ module ElasticAPM
 
         attr_reader :context_serializer
 
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def build(span)
           {
             span: {
@@ -21,7 +21,7 @@ module ElasticAPM
               transaction_id: span.transaction_id,
               parent_id: span.parent_id,
               name: keyword_field(span.name),
-              type: keyword_field(span.type),
+              type: join_type(span),
               duration: ms(span.duration),
               context: context_serializer.build(span.context),
               stacktrace: span.stacktrace.to_a,
@@ -30,7 +30,7 @@ module ElasticAPM
             }
           }
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
 
         # @api private
         class ContextSerializer < Serializer
@@ -66,6 +66,14 @@ module ElasticAPM
             }
           end
         end
+
+        private
+
+        def join_type(span)
+          combined = [span.type, span.subtype, span.action]
+          combined.compact!
+          combined.join '.'
+        end
       end
     end
   end

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '2.8.1'
+  VERSION = '2.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.11.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -45,15 +45,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ci/.jenkins_codecov.yml"
+- ".ci/.jenkins_exclude.yml"
+- ".ci/.jenkins_framework.yml"
+- ".ci/.jenkins_master_framework.yml"
+- ".ci/.jenkins_ruby.yml"
+- ".ci/Jenkinsfile"
+- ".ci/bin/check_paths_for_matches.py"
+- ".ci/downstreamTests.groovy"
+- ".ci/jobs/apm-agent-ruby-downstream.yml"
+- ".ci/jobs/apm-agent-ruby-linting-mbp.yml"
+- ".ci/jobs/apm-agent-ruby-mbp.yml"
+- ".ci/jobs/apm-agent-ruby.yml"
+- ".ci/jobs/defaults.yml"
+- ".ci/linting.groovy"
+- ".ci/prepare-git-context.sh"
 - ".gitignore"
 - ".hound.yml"
+- ".pre-commit-config.yaml"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Jenkinsfile
 - LICENSE
 - README.md
 - Rakefile
@@ -78,6 +93,7 @@ files:
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc
 - docs/introduction.asciidoc
+- docs/log-correlation.asciidoc
 - docs/metrics.asciidoc
 - docs/opentracing.asciidoc
 - docs/release-notes.asciidoc
@@ -86,9 +102,13 @@ files:
 - lib/elastic-apm.rb
 - lib/elastic_apm.rb
 - lib/elastic_apm/agent.rb
+- lib/elastic_apm/central_config.rb
+- lib/elastic_apm/central_config/cache_control.rb
 - lib/elastic_apm/config.rb
+- lib/elastic_apm/config/bytes.rb
 - lib/elastic_apm/config/duration.rb
-- lib/elastic_apm/config/size.rb
+- lib/elastic_apm/config/options.rb
+- lib/elastic_apm/config/regexp_list.rb
 - lib/elastic_apm/context.rb
 - lib/elastic_apm/context/request.rb
 - lib/elastic_apm/context/request/socket.rb
@@ -111,6 +131,7 @@ files:
 - lib/elastic_apm/metadata/system_info/container_info.rb
 - lib/elastic_apm/metrics.rb
 - lib/elastic_apm/metrics/cpu_mem.rb
+- lib/elastic_apm/metrics/vm.rb
 - lib/elastic_apm/metricset.rb
 - lib/elastic_apm/middleware.rb
 - lib/elastic_apm/naively_hashable.rb
@@ -120,6 +141,7 @@ files:
 - lib/elastic_apm/normalizers/action_view.rb
 - lib/elastic_apm/normalizers/active_record.rb
 - lib/elastic_apm/opentracing.rb
+- lib/elastic_apm/rails.rb
 - lib/elastic_apm/railtie.rb
 - lib/elastic_apm/span.rb
 - lib/elastic_apm/span/context.rb

data/Jenkinsfile

@@ -1,280 +0,0 @@
-#!/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 any
-  environment {
-    BASE_DIR="src/github.com/elastic/apm-agent-ruby"
-    PIPELINE_LOG_LEVEL='INFO'
-    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'
-  }
-  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: 'doc_ci', defaultValue: true, description: 'Enable build docs.')
-    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 'master || immutable' }
-      options { skipDefaultCheckout() }
-      steps {
-        deleteDir()
-        gitCheckout(basedir: "${BASE_DIR}")
-        stash allowEmpty: true, name: 'source', useDefaultExcludes: false
-      }
-    }
-    /**
-    Execute unit tests.
-    */
-    stage('Test') {
-      agent { label 'linux && immutable' }
-      options { skipDefaultCheckout() }
-      steps {
-        deleteDir()
-        unstash "source"
-        dir("${BASE_DIR}"){
-          script {
-            rubyTasksGen = new RubyParallelTaskGenerator(
-              xKey: 'RUBY_VERSION',
-              yKey: 'FRAMEWORK',
-              xFile: "./spec/.jenkins_ruby.yml",
-              yFile: "./spec/.jenkins_framework.yml",
-              exclusionFile: "./spec/.jenkins_exclude.yml",
-              tag: "Ruby",
-              name: "Ruby",
-              steps: this
-              )
-              def mapPatallelTasks = rubyTasksGen.generateParallelTests()
-              parallel(mapPatallelTasks)
-            }
-          }
-        }
-      }
-      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 {
-              deleteDir()
-              unstash 'source'
-              dir("${BASE_DIR}"){
-                script {
-                  def versions = readYaml(file: "./spec/.jenkins_ruby.yml")
-                  def benchmarkTask = [:]
-                  versions['RUBY_VERSION'].each{ v ->
-                    benchmarkTask[v] = runBenchmark(v)
-                  }
-                  parallel(benchmarkTask)
-                }
-              }
-            }
-          }
-        }
-      }
-      /**
-      Build the documentation.
-      */
-      stage('Documentation') {
-        agent { label 'linux && immutable' }
-        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.doc_ci }
-          }
-        }
-        steps {
-          deleteDir()
-          unstash 'source'
-          buildDocs(docsDir: "${BASE_DIR}/docs", archive: true)
-        }
-      }
-    }
-    post {
-      always{
-        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
-          }
-        }
-      }
-      success {
-        echoColor(text: '[SUCCESS]', colorfg: 'green', colorbg: 'default')
-      }
-      aborted {
-        echoColor(text: '[ABORTED]', colorfg: 'magenta', colorbg: 'default')
-      }
-      failure {
-        echoColor(text: '[FAILURE]', colorfg: 'red', colorbg: 'default')
-        step([$class: 'Mailer', notifyEveryUnstableBuild: true, recipients: "${NOTIFY_TO}", sendToIndividuals: false])
-      }
-      unstable {
-        echoColor(text: '[UNSTABLE]', colorfg: 'yellow', colorbg: 'default')
-      }
-    }
-  }
-
-/**
-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: false,
-            keepLongStdio: true,
-            testResults: "**/spec/ruby-agent-junit.xml")
-          steps.codecov(repo: 'apm-agent-ruby', 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}")
-    }
-  }
-}
-
-/**
-  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)
-          }
-        }
-      }
-    }
-  }
-}