elastic-apm 3.7.0 → 3.8.0

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

@@ -17,75 +17,31 @@
 
 # frozen_string_literal: true
 
+require 'elastic_apm/transport/filters/hash_sanitizer'
+
 module ElasticAPM
   module Transport
     module Filters
       # @api private
       class SecretsFilter
-        FILTERED = '[FILTERED]'
-
-        KEY_FILTERS = [
-          /passw(or)?d/i,
-          /auth/i,
-          /^pw$/,
-          /secret/i,
-          /token/i,
-          /api[-._]?key/i,
-          /session[-._]?id/i,
-          /(set[-_])?cookie/i
-        ].freeze
-
-        VALUE_FILTERS = [
-          # (probably) credit card number
-          /^\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}$/
-        ].freeze
-
         def initialize(config)
           @config = config
-          @key_filters =
-            KEY_FILTERS +
-            config.custom_key_filters +
-            config.sanitize_field_names
+          @sanitizer = HashSanitizer.new
+          @sanitizer.key_filters += config.custom_key_filters +
+                                     config.sanitize_field_names
         end
 
         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)
-          strip_from! payload.dig(:transaction, :context, :request, :body)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :headers)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :env)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :cookies)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :response, :headers)
+          @sanitizer.strip_from! payload.dig(:error, :context, :request, :headers)
+          @sanitizer.strip_from! payload.dig(:error, :context, :response, :headers)
+          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :body)
 
           payload
         end
-
-        def strip_from!(obj)
-          return unless obj&.is_a?(Hash)
-
-          obj.each do |k, v|
-            if filter_key?(k)
-              next obj[k] = FILTERED
-            end
-
-            case v
-            when Hash
-              strip_from!(v)
-            when String
-              if filter_value?(v)
-                obj[k] = FILTERED
-              end
-            end
-          end
-        end
-
-        def filter_key?(key)
-          @key_filters.any? { |regex| regex.match(key) }
-        end
-
-        def filter_value?(value)
-          VALUE_FILTERS.any? { |regex| regex.match(value) }
-        end
       end
     end
   end

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

@@ -36,27 +36,34 @@ module ElasticAPM
         private
 
         def build_service(service)
-          {
-            name: keyword_field(service.name),
-            environment: keyword_field(service.environment),
-            version: keyword_field(service.version),
-            agent: {
-              name: keyword_field(service.agent.name),
-              version: keyword_field(service.agent.version)
-            },
-            framework: {
-              name: keyword_field(service.framework.name),
-              version: keyword_field(service.framework.version)
-            },
-            language: {
-              name: keyword_field(service.language.name),
-              version: keyword_field(service.language.version)
-            },
-            runtime: {
-              name: keyword_field(service.runtime.name),
-              version: keyword_field(service.runtime.version)
+          base =
+            {
+              name: keyword_field(service.name),
+              environment: keyword_field(service.environment),
+              version: keyword_field(service.version),
+              agent: {
+                name: keyword_field(service.agent.name),
+                version: keyword_field(service.agent.version)
+              },
+              framework: {
+                name: keyword_field(service.framework.name),
+                version: keyword_field(service.framework.version)
+              },
+              language: {
+                name: keyword_field(service.language.name),
+                version: keyword_field(service.language.version)
+              },
+              runtime: {
+                name: keyword_field(service.runtime.name),
+                version: keyword_field(service.runtime.version)
+              }
             }
-          }
+
+          if node_name = service.node_name
+            base[:node] = { name: keyword_field(node_name) }
+          end
+
+          base
         end
 
         def build_process(process)

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '3.7.0'
+  VERSION = '3.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -59,7 +59,6 @@ files:
 - ".ci/docker/jruby/README.md"
 - ".ci/docker/jruby/run.sh"
 - ".ci/docker/jruby/test.sh"
-- ".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"
@@ -220,6 +219,7 @@ files:
 - lib/elastic_apm/transport/connection/http.rb
 - lib/elastic_apm/transport/connection/proxy_pipe.rb
 - lib/elastic_apm/transport/filters.rb
+- lib/elastic_apm/transport/filters/hash_sanitizer.rb
 - lib/elastic_apm/transport/filters/secrets_filter.rb
 - lib/elastic_apm/transport/headers.rb
 - lib/elastic_apm/transport/serializers.rb

data/.ci/downstreamTests.groovy

@@ -1,192 +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 { 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")
-    string(name: 'MERGE_TARGET', defaultValue: "master", description: "Git branch/tag where to merge this code")
-  }
-  stages {
-    /**
-    Checkout the code and stash it, to use it on other stages.
-    */
-    stage('Checkout') {
-      options { skipDefaultCheckout() }
-      when {
-        beforeAgent true
-        not {
-          tag pattern: 'v\\d+.*', comparator: "REGEXP"
-        }
-      }
-      steps {
-        deleteDir()
-        gitCheckout(basedir: "${BASE_DIR}",
-          branch: "${params.BRANCH_SPECIFIER}",
-          repo: "${REPO}",
-          credentialsId: "${JOB_GIT_CREDENTIALS}",
-          mergeTarget: "${params.MERGE_TARGET}")
-        stash allowEmpty: true, name: 'source', useDefaultExcludes: false
-      }
-    }
-    stage('Checkout tag') {
-      options { skipDefaultCheckout() }
-      when {
-        beforeAgent true
-        tag pattern: 'v\\d+.*', comparator: "REGEXP"
-      }
-      steps {
-        deleteDir()
-        gitCheckout(basedir: "${BASE_DIR}")
-        stash allowEmpty: true, name: 'source', useDefaultExcludes: false
-      }
-    }
-    stage('Test') {
-      options { skipDefaultCheckout() }
-      steps {
-        runTests('.ci/.jenkins_framework.yml')
-      }
-    }
-    stage('Master Test') {
-      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(prComment: false)
-    }
-  }
-}
-
-/**
-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/junit-reports/**/ruby-agent-junit.xml")
-        }
-      }
-    }
-  }
-}
-/**
-  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}")
-      script{
-        archiveArtifacts(artifacts: "coverage/matrix_results/", defaultExcludes: false)
-      }
-    }
-  }
-}
-
-/**
-  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 mapParallelTasks = rubyTasksGen.generateParallelTests()
-      parallel(mapParallelTasks)
-    }
-  }
-}