elastic-apm 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b8d2dcb34f97fa80f6dd200bbb5d6a02a0219d054a0f2ca0df5a186ff530c8a
-  data.tar.gz: 4ad68c7e8c7fcac5d82c7b621090091dd9816e90584115b0482523b7ca458942
+  metadata.gz: e3fb435d6ad1fd7a4e60cadedf93d9058da43310444e2fe4751d340a8a0eb7ed
+  data.tar.gz: 7e4a452a0ef34cd1d91bb5b9e1e74cd4c14a2d66ed4fe85ee5317682077c193b
 SHA512:
-  metadata.gz: f1203dad667452f7080e67d7509f8046b327989c88da82e7019ecac3488c6a990d974e631a2ebd284c0e7b0896c8d533912bb8228bf728f7244c4a6da10edbd6
-  data.tar.gz: be5499f9a2bbb5803879d8fde02c8aa6b4b6c7585b150cb9f7baebd7d52b86df79db664aaa3b9e330458e2f29c60dc53b4f0a96ffeb999a8615215a7b8de2289
+  metadata.gz: ad0a3ea9273288644640513a82db7baf1ed5c89f5ff4c1e57246d08d6baa8796d854263170afa887edbc5ab1ce2d73a5d73b8e6d367c58f56efd4d830e4c9be4
+  data.tar.gz: 0410ba02cd8c06b473fcb428900a5ed4d1eeae16134f187cde4525139edd669e75122cbe7b98d0a98a1639df4863d07d429dd6a3b27696604385e4703edaacb4

data/CHANGELOG.md

@@ -4,7 +4,23 @@ 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).
 
-## Changed (2019-01-31)
+## 2.4.0 (2019-02-27)
+
+### Added
+
+- Added option to specify a custom server CA certificate ([#315](https://github.com/elastic/apm-agent-ruby/pull/315))
+
+### Changed
+
+- **NB:** Default value of option `capture_body` flipped to `false` to align with other agents. Set `capture_body: true` in your configuration to get them back. ([#324](https://github.com/elastic/apm-agent-ruby/pull/324))
+
+### Fixed
+
+- Reading CPU stats from `/proc/stat` on RHEL ([#312](https://github.com/elastic/apm-agent-ruby/pull/312))
+- Change TraceContext to differentiate between `id` and `parent_id` ([#326](https://github.com/elastic/apm-agent-ruby/pull/326))
+- `capture_body` will now force encode text bodies to utf-8 when possible ([#332](https://github.com/elastic/apm-agent-ruby/pull/332))
+
+## 2.3.1 (2019-01-31)
 
 ### Added
 

data/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing to the APM Agent
+
+The APM Agent is open source and we love to receive contributions from our community — you!
+
+There are many ways to contribute,
+from writing tutorials or blog posts,
+improving the documentation,
+submitting bug reports and feature requests or writing code.
+
+You can get in touch with us through [Discuss](https://discuss.elastic.co/c/apm),
+feedback and ideas are always welcome.
+
+## Code contributions
+
+If you have a bugfix or new feature that you would like to contribute,
+please find or open an issue about it first.
+Talk about what you would like to do.
+It may be that somebody is already working on it,
+or that there are particular issues that you should know about before implementing the change.
+
+### Submitting your changes
+
+Generally, we require that you test any code you are adding or modifying.
+Once your changes are ready to submit for review:
+
+1. Sign the Contributor License Agreement
+
+    Please make sure you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/).
+    We are not asking you to assign copyright to us,
+    but to give us the right to distribute your code without restriction.
+    We ask this of all contributors in order to assure our users of the origin and continuing existence of the code.
+    You only need to sign the CLA once.
+
+2. Test your changes
+
+    Run the test suite to make sure that nothing is broken.
+    See [testing](#testing) for details.
+
+3. Rebase your changes
+
+    Update your local repository with the most recent code from the main repo,
+    and rebase your branch on top of the latest master branch.
+    We prefer your initial changes to be squashed into a single commit.
+    Later,
+    if we ask you to make changes,
+    add them as separate commits.
+    This makes them easier to review.
+    As a final step before merging we will either ask you to squash all commits yourself or we'll do it for you.
+
+4. Submit a pull request
+
+    Push your local changes to your forked copy of the repository and [submit a pull request](https://help.github.com/articles/using-pull-requests).
+    In the pull request,
+    choose a title which sums up the changes that you have made,
+    and in the body provide more details about what your changes do.
+    Also mention the number of the issue where discussion has taken place,
+    eg "Closes #123".
+
+5. Be patient
+
+    We might not be able to review your code as fast as we would like to,
+    but we'll do our best to dedicate it the attention it deserves.
+    Your effort is much appreciated!
+
+### Workflow
+
+All feature development and most bug fixes hit the master branch first.
+Pull requests should be reviewed by someone with commit access.
+Once approved, the author of the pull request,
+or reviewer if the author does not have commit access,
+should "Squash and merge".
+
+### Testing
+
+To do a full test run, use either `bundle exec rspec` or `rake spec`. Individual specs should also run as expected. The Mongo test needs a Mongo instance running, but will start one itself if Docker is installed.
+
+To test other platform, use the Docker setup and scripts like `spec.sh RUBY FRAMEWORK`.
+
+```sh
+$ spec/scripts/spec.sh ruby-2.6 rails-5.2
+```
+
+### Releasing
+
+To release a new version:
+
+1. Update `VERSION` in `lib/elastic_apm/version.rb` according to the changes (major, minor, patch).
+2. Update `CHANGELOG.md` to reflect the new version -- change _Unreleased_ section to _Version (release date)_.
+3. Run `rake release`. This will...
+    1. Tag the current commit as new version.
+    2. Push the tag to GitHub.
+    3. Build the gem and upload to Rubygems (local user needs to be signed in and authorized.)
+    4. Update `2.x` branch to be at released commit and push it to GitHub.

data/Gemfile

@@ -22,6 +22,8 @@ gem 'opentracing', require: nil
 gem 'rake', require: nil
 gem 'sequel', require: nil
 gem 'sidekiq', require: nil
+gem 'simplecov', require: false, group: :test
+gem 'simplecov-cobertura', require: false, group: :test
 gem 'yard', require: nil
 gem 'yarjuf'
 
@@ -43,7 +45,7 @@ else
   gem framework
 end
 
-unless version == 'master'
+unless version =~ /^(master|6)/
   gem 'delayed_job', require: nil
 end
 

data/Jenkinsfile

@@ -0,0 +1,264 @@
+#!/usr/bin/env groovy
+@Library('apm@v1.0.7') _
+
+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')
+  }
+  options {
+    timeout(time: 2, unit: 'HOURS')
+    buildDiscarder(logRotator(numToKeepStr: '20', artifactNumToKeepStr: '20', daysToKeepStr: '30'))
+    timestamps()
+    ansiColor('xterm')
+    disableResume()
+    durabilityHint('PERFORMANCE_OPTIMIZED')
+  }
+  triggers {
+    issueCommentTrigger('.*(?: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 'flyweight' }
+      options { skipDefaultCheckout() }
+      steps {
+        deleteDir()
+        gitCheckout(basedir: "${BASE_DIR}")
+        stash allowEmpty: true, name: 'source', useDefaultExcludes: false
+      }
+    }
+    /**
+    Execute unit tests.
+    */
+    stage('Test') {
+      agent { label 'flyweight' }
+      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 {
+              not {
+                changeRequest()
+              }
+              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 {
+              not {
+                changeRequest()
+              }
+              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.node('linux && immutable'){
+        def label = "${tag}:${x}#${y}"
+        try {
+          steps.runScript(label: label, ruby: x, framework: y)
+          saveResult(x, y, 1)
+        } catch(e){
+          saveResult(x, y, 0)
+          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}")
+        }
+      }
+    }
+  }
+}
+
+/**
+  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)
+      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'){
+      env.HOME = "${env.WORKSPACE}/${version}"
+      dir("${version}"){
+        deleteDir()
+        unstash 'source'
+        dir("${BASE_DIR}"){
+          try{
+            sh "./spec/scripts/benchmarks.sh ${version}"
+          } catch(e){
+            throw e
+          } finally {
+            sendBenchmarks(file: "benchmark-${version}.bulk",
+              index: "benchmark-ruby", archive: true)
+          }
+        }
+      }
+    }
+  }
+}

data/README.md

@@ -1,7 +1,7 @@
 # elastic-apm
 ## Elastic APM agent for ♦️Ruby
 
-[![Jenkins](https://img.shields.io/jenkins/s/https/apm-ci.elastic.co/job/elastic+apm-agent-ruby+master.svg)](https://apm-ci.elastic.co/job/elastic+apm-agent-ruby+master/) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm)
+[![Jenkins](https://img.shields.io/jenkins/s/https/apm-ci.elastic.co/job/elastic+apm-agent-ruby+master.svg)](https://apm-ci.elastic.co/job/elastic+apm-agent-ruby+master/) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm) [![codecov](https://codecov.io/gh/elastic/apm-agent-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/elastic/apm-agent-ruby)
 
 The official Rubygem for [Elastic][] [APM][].
 

data/bench/report.rb

@@ -5,33 +5,10 @@ Encoding.default_external = 'utf-8'
 
 require 'time'
 require 'bundler/setup'
-require 'faraday'
 require 'json'
 
-ELASTICSEARCH_URL = ENV.fetch('CLOUD_ADDR') { '' }.chomp
-if ELASTICSEARCH_URL == ''
-  puts 'ELASTICSEARCH_URL missing, exiting ...'
-  exit 1
-else
-  # DEBUG
-  # puts ELASTICSEARCH_URL.gsub(/:[^\/]+(.*)@/) do |m|
-  #   ":#{Array.new(m.length - 2).map { '*' }.join}@"
-  # end
-end
-
-CONN = Faraday.new(url: ELASTICSEARCH_URL) do |f|
-  # f.response :logger
-  f.adapter Faraday.default_adapter
-end
-
-healthcheck = CONN.get('/microbenchmark*/_search')
-if healthcheck.status != 200
-  puts healthcheck.body.to_s
-  exit 1
-end
-
 input = STDIN.read.split("\n")
-puts input
+STDERR.puts input
 
 titles = input.grep(/^===/).map { |t| t.gsub(/^=== /, '') }
 counts = input.grep(/^Count: /).map { |a| a.gsub(/^Count: /, '').to_i }
@@ -60,14 +37,10 @@ payloads = titles.zip(averages, counts).map do |(title, avg, count)|
   }
 end.compact
 
-puts '=== Reporting to ES'
-puts payloads.inspect
+STDERR.puts '=== Reporting to ES'
+STDERR.puts payloads.inspect
 
 payloads.each do |payload|
-  result = CONN.post('/benchmark-ruby/_doc') do |req|
-    req.headers['Content-Type'] = 'application/json'
-    req.body = payload.to_json
-  end
-
-  puts result.body unless (200...300).include?(result.status)
+  puts '{ "index" : { "_index" : "benchmark-ruby", "_type" : "_doc" } }'
+  puts payload.to_json
 end

data/docs/configuration.asciidoc

@@ -129,7 +129,7 @@ WARNING: Secret tokens only provide any real security if your APM server use TLS
 
 Maximum amount of objects kept in queue, before sending to APM Server.
 
-If you hit this limit you either have to increase the agent's 
+If you hit this limit you either have to increase the agent's
 <<config-pool-size,worker pool size>> or it could mean the agent has trouble
 connecting to APM Server. The <<config-log-path,logs>> should tell you what
 went wrong.
@@ -512,6 +512,18 @@ Set it to `0` to disable stack trace collection for all spans.
 
 It has to be provided in *<<config-format-duration, duration format>>*.
 
+[float]
+[[config-ssl-ca-cert]]
+==== `server_ca_cert`
+
+[options="header"]
+|============
+| Environment                  | `Config` key     | Default | Example
+| `ELASTIC_APM_SERVER_CA_CERT` | `server_ca_cert` | `nil`   | `'/path/to/ca.pem'`
+|============
+
+The path to a custom CA certificate for connecting to APM Server.
+
 [float]
 [[config-transaction-max-spans]]
 ==== `transaction_max_spans`

data/docs/custom-instrumentation.asciidoc

@@ -21,7 +21,7 @@ method.
 [source,ruby]
 ----
 class Thing
-  include SpanHelpers
+  include ElasticAPM::SpanHelpers
 
   def do_the_work
     # ...

data/docs/supported-technologies.asciidoc

@@ -53,11 +53,11 @@ See <<getting-started-rack>>.
 
 We automatically instrument database actions using:
 
-- ActiveRecord
-- Elasticsearch
-- Mongo
-- Redis
-- Sequel
+- ActiveRecord (v4.2+)
+- Elasticsearch (v0.9+)
+- Mongo (v2.1+)
+- Redis (v3.1+)
+- Sequel (v4.35+)
 
 [float]
 [[supported-technologies-http]]
@@ -67,4 +67,5 @@ We automatically instrument and add support for distributed tracing to external
 requests using these libraries:
 
 - `net/http`
-- Http.rb
+- Http.rb (v0.6+)
+- Faraday (v0.2.1+)

data/lib/elastic_apm/config.rb

@@ -22,7 +22,7 @@ module ElasticAPM
       api_buffer_size: 256,
       api_request_size: '750kb',
       api_request_time: '10s',
-      capture_body: true,
+      capture_body: false,
       capture_headers: true,
       capture_env: true,
       current_user_email_method: :email,
@@ -81,6 +81,7 @@ module ElasticAPM
       'ELASTIC_APM_LOG_PATH' => 'log_path',
       'ELASTIC_APM_METRICS_INTERVAL' => [:int, 'metrics_interval'],
       'ELASTIC_APM_POOL_SIZE' => [:int, 'pool_size'],
+      'ELASTIC_APM_SERVER_CA_CERT' => 'server_ca_cert',
       'ELASTIC_APM_SERVICE_NAME' => 'service_name',
       'ELASTIC_APM_SERVICE_VERSION' => 'service_version',
       'ELASTIC_APM_SOURCE_LINES_ERROR_APP_FRAMES' =>
@@ -156,6 +157,7 @@ module ElasticAPM
     attr_accessor :logger
     attr_accessor :metrics_interval
     attr_accessor :pool_size
+    attr_accessor :server_ca_cert
     attr_accessor :service_name
     attr_accessor :service_version
     attr_accessor :source_lines_error_app_frames

data/lib/elastic_apm/context_builder.rb

@@ -3,6 +3,9 @@
 module ElasticAPM
   # @api private
   class ContextBuilder
+    MAX_BODY_LENGTH = 2048
+    SKIPPED = '[SKIPPED]'
+
     def initialize(config)
       @config = config
     end
@@ -29,7 +32,7 @@ module ElasticAPM
       request.method = req.request_method
       request.url = Context::Request::Url.new(req)
 
-      request.body = get_body(req) if config.capture_body?
+      request.body = config.capture_body? ? get_body(req) : SKIPPED
 
       headers, env = get_headers_and_env(rack_env)
       request.headers = headers if config.capture_headers?
@@ -40,11 +43,16 @@ module ElasticAPM
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def get_body(req)
-      return req.POST if req.form_data?
-
-      body = req.body.read
-      req.body.rewind
-      body
+      case req.media_type
+      when 'application/x-www-form-urlencoded'
+        req.POST
+      when 'multipart/form-data'
+        req.POST
+      else
+        body = req.body.read
+        req.body.rewind
+        body.byteslice(0, MAX_BODY_LENGTH).force_encoding('utf-8')
+      end
     end
 
     def rails_req?(env)

data/lib/elastic_apm/deprecations.rb

@@ -4,14 +4,17 @@ module ElasticAPM
   # @api private
   module Deprecations
     def deprecate(name, replacement = nil)
+      alias_name = "#{name.to_s.chomp('=')}__deprecated_"
+      alias_name += '=' if name.to_s.end_with?('=')
+
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        alias :"#{name}__deprecated" :"#{name}"
+        alias :"#{alias_name}" :"#{name}"
 
         def #{name}(*args, &block)
           warn "[ElasticAPM] [DEPRECATED] `#{name}' is being removed. " \
-            "#{replacement && "See `#{replacement}'."}" \
-            "\nCalled from \#{caller.first}"
-          #{name}__deprecated(*args, &block)
+               "#{replacement && "See `#{replacement}'."}" \
+               "\nCalled from \#{caller.first}"
+          send("#{alias_name}", *args, &block)
         end
       RUBY
     end

data/lib/elastic_apm/instrumenter.rb

@@ -152,13 +152,12 @@ module ElasticAPM
       parent = current_span || transaction
 
       span = Span.new(
-        name,
-        type,
+        name: name,
         transaction_id: transaction.id,
-        parent_id: parent.id,
+        trace_context: trace_context || parent.trace_context.child,
+        type: type,
         context: context,
-        stacktrace_builder: stacktrace_builder,
-        trace_context: trace_context || parent.trace_context.child
+        stacktrace_builder: stacktrace_builder
       )
 
       if backtrace && config.span_frames_min_duration?

data/lib/elastic_apm/metrics/cpu_mem.rb

@@ -124,6 +124,19 @@ module ElasticAPM
         class ProcStat
           attr_reader :total, :usage
 
+          CPU_FIELDS = %i[
+            user
+            nice
+            system
+            idle
+            iowait
+            irq
+            softirq
+            steal
+            guest
+            guest_nice
+          ].freeze
+
           # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
           def read!
             stat =
@@ -133,20 +146,22 @@ module ElasticAPM
                 .split
                 .map(&:to_i)[1..-1]
 
-            user, nice, system, idle, iowait, irq, softirq, steal,
-              _guest, _guest_nice = stat
+            values =
+              CPU_FIELDS.each_with_index.each_with_object({}) do |(key, i), v|
+                v[key] = stat[i] || 0
+              end
 
             @total =
-              user +
-              nice +
-              system +
-              idle +
-              iowait +
-              irq +
-              softirq +
-              steal
-
-            @usage = @total - (idle + iowait)
+              values[:user] +
+              values[:nice] +
+              values[:system] +
+              values[:idle] +
+              values[:iowait] +
+              values[:irq] +
+              values[:softirq] +
+              values[:steal]
+
+            @usage = @total - (values[:idle] + values[:iowait])
 
             self
           end

data/lib/elastic_apm/opentracing.rb

@@ -93,28 +93,20 @@ module ElasticAPM
 
     # @api private
     class SpanContext
-      def initialize(id:, trace_id:, baggage: nil)
+      def initialize(trace_context:, baggage: nil)
         if baggage
           ElasticAPM.agent.config.logger.warn(
             'Baggage is not supported by ElasticAPM'
           )
         end
 
-        @id = id
-        @trace_id = trace_id
-        @trace_context =
-          ElasticAPM::TraceContext.new(trace_id: trace_id, span_id: id)
+        @trace_context = trace_context
       end
 
-      attr_accessor :id, :trace_id, :trace_context
+      attr_accessor :trace_context
 
       def self.from_trace_context(trace_context)
-        new(
-          trace_id: trace_context.trace_id,
-          id: trace_context.span_id
-        ).tap do |span_context|
-          span_context.trace_context = trace_context
-        end
+        new(trace_context: trace_context)
       end
     end
 

data/lib/elastic_apm/span.rb

@@ -1,48 +1,42 @@
 # frozen_string_literal: true
 
 require 'securerandom'
+require 'forwardable'
 
 require 'elastic_apm/span/context'
 
 module ElasticAPM
   # @api private
   class Span
+    extend Forwardable
+
+    def_delegators :@trace_context, :trace_id, :parent_id, :id
+
     DEFAULT_TYPE = 'custom'
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(
-      name,
-      type = nil,
-      transaction_id: nil,
-      parent_id: nil,
+      name:,
+      transaction_id:,
+      trace_context:,
+      type: nil,
       context: nil,
-      stacktrace_builder: nil,
-      trace_context: nil
+      stacktrace_builder: nil
     )
       @name = name
       @type = type || DEFAULT_TYPE
 
       @transaction_id = transaction_id
-
-      @parent_id = parent_id
-      @trace_context = trace_context || TraceContext.for_span
+      @trace_context = trace_context
 
       @context = context || Span::Context.new
       @stacktrace_builder = stacktrace_builder
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :type, :original_backtrace, :parent_id, :trace_context
+    attr_accessor :name, :type, :original_backtrace, :trace_context
     attr_reader :context, :stacktrace, :duration, :timestamp, :transaction_id
 
-    def id
-      trace_context&.span_id
-    end
-
-    def trace_id
-      trace_context&.trace_id
-    end
-
     # life cycle
 
     def start(timestamp = Util.micros)

data/lib/elastic_apm/trace_context.rb

@@ -3,56 +3,47 @@
 module ElasticAPM
   # @api private
   class TraceContext
+    extend Deprecations
     class InvalidTraceparentHeader < StandardError; end
 
     VERSION = '00'
     HEX_REGEX = /[^[:xdigit:]]/.freeze
 
+    TRACE_ID_LENGTH = 16
+    ID_LENGTH = 8
+
     def initialize(
       version: VERSION,
       trace_id: nil,
       span_id: nil,
+      id: nil,
       recorded: true
     )
       @version = version
-      @trace_id = trace_id
-      @span_id = span_id
+      @trace_id = trace_id || hex(TRACE_ID_LENGTH)
+      # TODO: rename to parent_id with next major version bump
+      @parent_id = span_id
+      @id = id || hex(ID_LENGTH)
       @recorded = recorded
     end
 
-    attr_accessor :version, :trace_id, :span_id, :recorded
+    attr_accessor :version, :id, :trace_id, :parent_id, :recorded
 
     alias :recorded? :recorded
 
-    def self.for_transaction(sampled: true)
-      new.tap do |t|
-        t.trace_id = SecureRandom.hex(16)
-        t.span_id = SecureRandom.hex(8)
-        t.recorded = sampled
-      end
-    end
-
-    def self.for_span
-      new.tap do |t|
-        t.trace_id = SecureRandom.hex(16)
-        t.span_id = SecureRandom.hex(8)
-        t.recorded = true
-      end
-    end
-
     # rubocop:disable Metrics/AbcSize
     def self.parse(header)
       raise InvalidTraceparentHeader unless header.length == 55
       raise InvalidTraceparentHeader unless header[0..1] == VERSION
 
       new.tap do |t|
-        t.version, t.trace_id, t.span_id, t.flags =
+        t.version, t.trace_id, t.parent_id, t.flags =
           header.split('-').tap do |values|
             values[-1] = Util.hex_to_bits(values[-1])
           end
 
         raise InvalidTraceparentHeader if HEX_REGEX =~ t.trace_id
-        raise InvalidTraceparentHeader if HEX_REGEX =~ t.span_id
+        raise InvalidTraceparentHeader if HEX_REGEX =~ t.parent_id
       end
     end
     # rubocop:enable Metrics/AbcSize
@@ -71,12 +62,38 @@ module ElasticAPM
       format('%02x', flags.to_i(2))
     end
 
+    def ensure_parent_id
+      @parent_id ||= hex(ID_LENGTH)
+    end
+
     def child
-      dup.tap { |tc| tc.span_id = SecureRandom.hex(8) }
+      dup.tap do |tc|
+        tc.parent_id = tc.id
+        tc.id = hex(ID_LENGTH)
+      end
     end
 
     def to_header
-      format('%s-%s-%s-%s', version, trace_id, span_id, hex_flags)
+      format('%s-%s-%s-%s', version, trace_id, id, hex_flags)
+    end
+
+    # @deprecated Use parent_id instead
+    def span_id
+      @parent_id
+    end
+
+    # @deprecated Use parent_id instead
+    def span_id=(span_id)
+      @parent_id = span_id
+    end
+
+    deprecate :span_id, :parent_id
+    deprecate :span_id=, :parent_id=
+
+    private
+
+    def hex(len)
+      SecureRandom.hex(len)
     end
   end
 end

data/lib/elastic_apm/transaction.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
 require 'securerandom'
+require 'forwardable'
 
 module ElasticAPM
   # @api private
   class Transaction
     extend Deprecations
+    extend Forwardable
+
+    def_delegators :@trace_context,
+      :trace_id, :parent_id, :id, :ensure_parent_id
 
     DEFAULT_TYPE = 'custom'
 
-    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:disable Metrics/ParameterLists
     def initialize(
       name = nil,
       type = nil,
@@ -26,28 +31,19 @@ module ElasticAPM
       @context = context || Context.new # TODO: Lazy generate this?
       Util.reverse_merge!(@context.tags, tags) if tags
 
-      if trace_context
-        @parent_id = trace_context.span_id
-        @trace_context = trace_context
-      else
-        @trace_context = TraceContext.for_transaction(sampled: sampled)
-      end
+      @trace_context = trace_context || TraceContext.new(recorded: sampled)
 
       @started_spans = 0
       @dropped_spans = 0
 
       @notifications = [] # for AS::Notifications
     end
-    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+    # rubocop:enable Metrics/ParameterLists
 
     attr_accessor :name, :type, :result
 
     attr_reader :context, :duration, :started_spans, :dropped_spans,
-      :timestamp, :trace_context, :notifications, :parent_id
-
-    def id
-      trace_context.span_id
-    end
+      :timestamp, :trace_context, :notifications
 
     def sampled?
       @sampled
@@ -63,10 +59,6 @@ module ElasticAPM
 
     deprecate :done?, :stopped?
 
-    def trace_id
-      trace_context&.trace_id
-    end
-
     # life cycle
 
     def start(timestamp = Util.micros)
@@ -86,11 +78,6 @@ module ElasticAPM
       self
     end
 
-    def ensure_parent_id
-      @parent_id ||= SecureRandom.hex(8)
-      @parent_id
-    end
-
     # spans
 
     def inc_started_spans!

data/lib/elastic_apm/transport/connection.rb

@@ -28,6 +28,7 @@ module ElasticAPM
       }.freeze
       GZIP_HEADERS = HEADERS.merge('Content-Encoding' => 'gzip').freeze
 
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def initialize(config, metadata)
         @config = config
         @metadata = metadata.to_json
@@ -41,10 +42,16 @@ module ElasticAPM
           headers['Authorization'] = "Bearer #{token}"
         end
 
+        if config.use_ssl? && config.server_ca_cert
+          @ssl_context = OpenSSL::SSL::SSLContext.new
+          @ssl_context.ca_file = config.server_ca_cert
+        end
+
         @client = HTTP.headers(headers).persistent(@url)
 
         @mutex = Mutex.new
       end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
       def write(str)
         return if @config.disable_send
@@ -109,7 +116,12 @@ module ElasticAPM
         @conn_thread = Thread.new do
           begin
             @connected = true
-            resp = @client.post(@url, body: @rd).flush
+
+            resp = @client.post(
+              @url,
+              body: @rd,
+              ssl_context: @ssl_context
+            ).flush
           rescue Exception => e
             @connection_error = e
           ensure

data/lib/elastic_apm/transport/filters.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'elastic_apm/transport/filters/request_body_filter'
 require 'elastic_apm/transport/filters/secrets_filter'
 
 module ElasticAPM
@@ -14,10 +13,7 @@ module ElasticAPM
       # @api private
       class Container
         def initialize(config)
-          @filters = {
-            request_body: RequestBodyFilter.new(config),
-            secrets: SecretsFilter.new(config)
-          }
+          @filters = { secrets: SecretsFilter.new(config) }
         end
 
         def add(key, filter)

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

@@ -28,21 +28,21 @@ module ElasticAPM
         end
 
         def call(payload)
-          strip_from payload[:transaction], :context, :request, :headers
-          strip_from payload[:transaction], :context, :response, :headers
-          strip_from payload[:error], :context, :request, :headers
-          strip_from payload[:error], :context, :response, :headers
+          strip_from! payload.dig(:transaction, :context, :request, :headers)
+          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)
 
           payload
         end
 
-        def strip_from(event, *path)
-          return unless event
-          return unless (headers = event.dig(*path))
+        def strip_from!(obj)
+          return unless obj && obj.is_a?(Hash)
 
-          headers.each do |k, v|
+          obj.each do |k, v|
             if filter_key?(k) || filter_value?(v)
-              headers[k] = FILTERED
+              obj[k] = FILTERED
             end
           end
         end

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -51,7 +51,9 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- Jenkinsfile
 - LICENSE
 - README.md
 - Rakefile
@@ -145,7 +147,6 @@ files:
 - lib/elastic_apm/transport/base.rb
 - lib/elastic_apm/transport/connection.rb
 - lib/elastic_apm/transport/filters.rb
-- lib/elastic_apm/transport/filters/request_body_filter.rb
 - lib/elastic_apm/transport/filters/secrets_filter.rb
 - lib/elastic_apm/transport/serializers.rb
 - lib/elastic_apm/transport/serializers/context_serializer.rb
@@ -181,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: The official Elastic APM agent for Ruby

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module ElasticAPM
-  module Transport
-    module Filters
-      # @api private
-      class RequestBodyFilter
-        FILTERED = '[FILTERED]'
-
-        def initialize(config)
-          @config = config
-        end
-
-        def call(payload)
-          strip_body_from payload[:transaction]
-          strip_body_from payload[:error]
-
-          payload
-        end
-
-        private
-
-        def strip_body_from(payload)
-          return unless payload
-          return unless (request = payload.dig(:context, :request))
-          request[:body] = FILTERED
-        end
-      end
-    end
-  end
-end