elastic-apm 3.7.0 → 3.11.0

data/lib/elastic_apm/transport/serializers.rb

@@ -45,18 +45,20 @@ module ElasticAPM
         def keyword_object(hash)
           return unless hash
 
-          hash.tap do |h|
-            h.each { |k, v| hash[k] = keyword_field(v) }
+          hash.each do |k, v|
+            hash[k] =
+              case v
+              when Hash then keyword_object(v)
+              else keyword_field(v)
+              end
           end
         end
 
         def mixed_object(hash)
           return unless hash
 
-          hash.tap do |h|
-            h.each do |k, v|
-              hash[k] = v.is_a?(String) ? keyword_field(v) : v
-            end
+          hash.each do |k, v|
+            hash[k] = v.is_a?(String) ? keyword_field(v) : v
           end
         end
       end

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

@@ -23,40 +23,52 @@ module ElasticAPM
       # @api private
       class MetadataSerializer < Serializer
         def build(metadata)
-          {
-            metadata: {
+          base =
+            {
               service: build_service(metadata.service),
               process: build_process(metadata.process),
               system: build_system(metadata.system),
               labels: build_labels(metadata.labels)
             }
-          }
+
+          if (metadata.cloud.provider)
+            base[:cloud] = build_cloud(metadata.cloud)
+          end
+
+          { metadata: base }
         end
 
         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)
@@ -76,6 +88,27 @@ module ElasticAPM
           }
         end
 
+        def build_cloud(cloud)
+          {
+            provider: cloud.provider,
+            account: {
+              id: keyword_field(cloud.account_id),
+              name: keyword_field(cloud.account_name),
+            },
+            availability_zone: keyword_field(cloud.availability_zone),
+            instance: {
+              id: keyword_field(cloud.instance_id),
+              name: keyword_field(cloud.instance_name),
+            },
+            machine: { type: keyword_field(cloud.machine_type) },
+            project: {
+              id: keyword_field(cloud.project_id),
+              name: keyword_field(cloud.project_name),
+            },
+            region: keyword_field(cloud.region)
+          }
+        end
+
         def build_labels(labels)
           keyword_object(labels)
         end

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

@@ -42,7 +42,8 @@ module ElasticAPM
               context: context_serializer.build(span.context),
               stacktrace: span.stacktrace.to_a,
               timestamp: span.timestamp,
-              trace_id: span.trace_id
+              trace_id: span.trace_id,
+              sample_rate: span.sample_rate
             }
           }
         end

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

@@ -38,6 +38,7 @@ module ElasticAPM
               duration: ms(transaction.duration),
               timestamp: transaction.timestamp,
               sampled: transaction.sampled?,
+              sample_rate: transaction.sample_rate,
               context: context_serializer.build(transaction.context),
               span_count: {
                 started: transaction.started_spans,

data/lib/elastic_apm/transport/user_agent.rb

@@ -32,14 +32,14 @@ module ElasticAPM
       private
 
       def build(config)
-        metadata = Metadata.new(config)
+        service = Metadata::ServiceInfo.new(config)
 
         [
           "elastic-apm-ruby/#{VERSION}",
           HTTP::Request::USER_AGENT,
           [
-            metadata.service.runtime.name,
-            metadata.service.runtime.version
+            service.runtime.name,
+            service.runtime.version
           ].join('/')
         ].join(' ')
       end

data/lib/elastic_apm/transport/worker.rb

@@ -53,6 +53,7 @@ module ElasticAPM
       end
 
       attr_reader :queue, :filters, :name, :connection, :serializers
+
       def work_forever
         while (msg = queue.pop)
           case msg
@@ -77,6 +78,10 @@ module ElasticAPM
       private
 
       def serialize_and_filter(resource)
+        if resource.respond_to?(:prepare_for_serialization!)
+          resource.prepare_for_serialization!
+        end
+
         serialized = serializers.serialize(resource)
 
         # if a filter returns nil, it means skip the event

data/lib/elastic_apm/util.rb

@@ -46,6 +46,8 @@ module ElasticAPM
 
     def self.truncate(value, max_length: 1024)
       return unless value
+
+      value = String(value)
       return value if value.length <= max_length
 
       value[0...(max_length - 1)] + '…'

data/lib/elastic_apm/util/precision_validator.rb

@@ -0,0 +1,46 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Util
+    # @api private
+    # Rounds half away from zero.
+    # If `minimum` is provided, and the value rounds to 0 (but was not zero to
+    # begin with), use the minimum instead.
+    module PrecisionValidator
+      extend self
+
+      def validate(value, precision: 0, minimum: nil)
+        float = Float(value)
+        return nil unless (0.0..1.0).cover?(float)
+        return float if float == 0
+
+        multiplier = Float(10**precision)
+        rounded = (float * multiplier + 0.5).floor / multiplier
+        if rounded == 0 && minimum
+          minimum
+        else
+          rounded
+        end
+      rescue ArgumentError
+        nil
+      end
+    end
+  end
+end

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '3.7.0'
+  VERSION = '3.11.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.11.0
 platform: ruby
 authors:
 - Mikkel Malmberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - mikkel@elastic.co
 executables: []
@@ -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"
@@ -129,6 +128,7 @@ files:
 - lib/elastic_apm/config/duration.rb
 - lib/elastic_apm/config/options.rb
 - lib/elastic_apm/config/regexp_list.rb
+- lib/elastic_apm/config/round_float.rb
 - lib/elastic_apm/config/wildcard_pattern_list.rb
 - lib/elastic_apm/context.rb
 - lib/elastic_apm/context/request.rb
@@ -149,6 +149,7 @@ files:
 - lib/elastic_apm/internal_error.rb
 - lib/elastic_apm/logging.rb
 - lib/elastic_apm/metadata.rb
+- lib/elastic_apm/metadata/cloud_info.rb
 - lib/elastic_apm/metadata/process_info.rb
 - lib/elastic_apm/metadata/service_info.rb
 - lib/elastic_apm/metadata/system_info.rb
@@ -186,6 +187,7 @@ files:
 - lib/elastic_apm/spies.rb
 - lib/elastic_apm/spies/action_dispatch.rb
 - lib/elastic_apm/spies/delayed_job.rb
+- lib/elastic_apm/spies/dynamo_db.rb
 - lib/elastic_apm/spies/elasticsearch.rb
 - lib/elastic_apm/spies/faraday.rb
 - lib/elastic_apm/spies/http.rb
@@ -220,6 +222,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
@@ -234,6 +237,7 @@ files:
 - lib/elastic_apm/util.rb
 - lib/elastic_apm/util/inflector.rb
 - lib/elastic_apm/util/lru_cache.rb
+- lib/elastic_apm/util/precision_validator.rb
 - lib/elastic_apm/util/throttle.rb
 - lib/elastic_apm/version.rb
 homepage: https://github.com/elastic/apm-agent-ruby
@@ -241,7 +245,7 @@ licenses:
 - Apache-2.0
 metadata:
   source_code_uri: https://github.com/elastic/apm-agent-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -256,8 +260,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: The official Elastic APM agent for Ruby
 test_files: []

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)
-    }
-  }
-}