elastic-apm 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37a03e42bbce98f7206216314854dbe171c6964bf757fc9e25f2d990af922d38
-  data.tar.gz: c4be66c848b4345e8594a178b8fc2738f585bbcc772a81943734a6f1ad1c8b45
+  metadata.gz: 2395fecd3ead993ac77f072d0b552e0814d2eb09ae985ba3d0b22e7168a9f005
+  data.tar.gz: 20e07d3f8444b83bc424de8b7772547c41eba90ac8561d406599cfb36854ebd9
 SHA512:
-  metadata.gz: 81b744b6d0ff9aa3fa1f38b105a9aab42b98da5f15f173e3542882b81b860e3b02139090125f36c429032deba1e638d263469e3bdbf16f060eabf8da7edfcc25
-  data.tar.gz: 3070245854f3547326143d7e494f6cee9851985b5d8f2b56d07b914461cdb8f9ebb255d0466054e923b65dc77b21eb142beb477b00b4f6b14d4773eefb24ca42
+  metadata.gz: 341eff39abd1c021aaa61967a56482ada41ac9d94f6dda54a2b480cbaff2844768ffaea7c54c8e2781211cf8209a2b8309631a3360b63bad15c7554fa9705ca6
+  data.tar.gz: 4158a60e93bd55f6cd28274e734943e1f5984c4ce963be7ad65be8fa508419f92227e18e12cc46c6813793f4b8baf490bdd52eb240e1a6c6f567057fe254a7ee

data/.gitignore

@@ -15,3 +15,4 @@ Gemfile.lock
 spec/elastic_apm.log
 spec/ruby-agent-junit.xml
 .gem
+*.bulk

data/CHANGELOG.md

@@ -4,6 +4,21 @@ 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).
 
+## 2.8.0 (2019-05-20)
+
+### Added
+
+- The option `stack_trace_limit` ([#424](https://github.com/elastic/apm-agent-ruby/pull/424))
+
+### Changed
+
+- Use standardized User-Agent ([#419](https://github.com/elastic/apm-agent-ruby/pull/419))
+
+### Fixed
+
+- `error.culprit` is properly truncated to 1024 characters ([#418](https://github.com/elastic/apm-agent-ruby/pull/418))
+- Force convert `transaction.context.response.status_code` to integer ([#423](https://github.com/elastic/apm-agent-ruby/pull/423))
+
 ## 2.7.0 (2019-05-07)
 
 ### Added

data/CONTRIBUTING.md

@@ -74,10 +74,10 @@ should "Squash and merge".
 
 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`.
+To test other platform, use the Docker setup and scripts like `spec.sh RUBY_DOCKER_IMAGE FRAMEWORK`.
 
 ```sh
-$ spec/scripts/spec.sh ruby-2.6 rails-5.2
+$ spec/scripts/spec.sh ruby:2.6 rails-5.2
 ```
 
 ### Releasing

data/Jenkinsfile

@@ -18,6 +18,8 @@ pipeline {
     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')
@@ -185,11 +187,11 @@ pipeline {
 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.
@@ -198,13 +200,15 @@ class RubyParallelTaskGenerator extends DefaultParallelTaskGenerator {
     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)
-          error("${label} tests failed : ${e.toString()}\n")
+          steps.error("${label} tests failed : ${e.toString()}\n")
         } finally {
           steps.junit(allowEmptyResults: false,
             keepLongStdio: true,
@@ -232,6 +236,7 @@ def runScript(Map params = [:]){
   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}")
     }
   }
@@ -243,17 +248,25 @@ def runScript(Map params = [:]){
 def runBenchmark(version){
   return {
     node('metal'){
-      env.HOME = "${env.WORKSPACE}/${version}"
-      dir("${version}"){
+      // 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 {
-            sendBenchmarks(file: "benchmark-${version}.bulk",
+            sendBenchmarks(file: "benchmark-${transformedVersion}.bulk",
               index: "benchmark-ruby", archive: true)
           }
         }

data/README.md

@@ -11,7 +11,7 @@ The official Rubygem for [Elastic][] [APM][].
 
 ## Documentation
 
-[Full documentation at Elasti.co](https://www.elastic.co/guide/en/apm/agent/ruby/2.x/index.html).
+[Full documentation at elastic.co](https://www.elastic.co/guide/en/apm/agent/ruby/2.x/index.html).
 
 <ul>
   <li><a href="https://www.elastic.co/guide/en/apm/agent/ruby/2.x/introduction.html">Introduction</a></li>

data/docs/api.asciidoc

@@ -111,7 +111,7 @@ ElasticAPM.with_transaction 'Do things' do |transaction|
 end
 ----
 
-Arguments: 
+Arguments:
 
   * `name`: A name for your transaction. Transactions are grouped by name. **Required**.
   * `type`: A `type` for your transaction eg. `db.postgresql.sql`.
@@ -234,6 +234,7 @@ Arguments:
 Returns `[ElasticAPM::Error]`.
 
 [float]
+[[api-context]]
 === Context
 
 [float]
@@ -395,7 +396,3 @@ See the {apm-rum-ref}[JavaScript RUM agent documentation] for more information.
 
 - `name`: String
 - `type`: String
-
-[float]
-[[api-context]]
-=== Context

data/lib/elastic_apm/config.rb

@@ -49,6 +49,7 @@ module ElasticAPM
       source_lines_span_app_frames: 5,
       source_lines_span_library_frames: 0,
       span_frames_min_duration: '5ms',
+      stack_trace_limit: 999_999,
       transaction_max_spans: 500,
       transaction_sample_rate: 1.0,
       verify_server_cert: true,
@@ -103,6 +104,7 @@ module ElasticAPM
       'ELASTIC_APM_SOURCE_LINES_SPAN_LIBRARY_FRAMES' =>
         [:int, 'source_lines_span_library_frames'],
       'ELASTIC_APM_SPAN_FRAMES_MIN_DURATION' => 'span_frames_min_duration',
+      'ELASTIC_APM_STACK_TRACE_LIMIT' => [:int, 'stack_trace_limit'],
       'ELASTIC_APM_TRANSACTION_MAX_SPANS' => [:int, 'transaction_max_spans'],
       'ELASTIC_APM_TRANSACTION_SAMPLE_RATE' =>
         [:float, 'transaction_sample_rate'],
@@ -180,6 +182,7 @@ module ElasticAPM
     attr_accessor :source_lines_error_library_frames
     attr_accessor :source_lines_span_app_frames
     attr_accessor :source_lines_span_library_frames
+    attr_accessor :stack_trace_limit
     attr_accessor :transaction_max_spans
     attr_accessor :transaction_sample_rate
     attr_accessor :verify_server_cert

data/lib/elastic_apm/railtie.rb

@@ -51,7 +51,7 @@ module ElasticAPM
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def should_skip?(_config)
-      if Rails.const_defined? :Console
+      if Rails.const_defined? 'Rails::Console'
         return 'Rails console'
       end
 

data/lib/elastic_apm/stacktrace_builder.rb

@@ -21,7 +21,7 @@ module ElasticAPM
 
     def build(backtrace, type:)
       Stacktrace.new.tap do |s|
-        s.frames = backtrace.map do |line|
+        s.frames = backtrace[0...config.stack_trace_limit].map do |line|
           @cache[[line, type]]
         end
       end

data/lib/elastic_apm/transport/connection.rb

@@ -33,9 +33,9 @@ module ElasticAPM
 
       def initialize(config, metadata)
         @config = config
+        @headers = build_headers(metadata)
         @metadata = JSON.fast_generate(metadata)
         @url = config.server_url + '/intake/v2/events'
-        @headers = build_headers
         @ssl_context = build_ssl_context
         @mutex = Mutex.new
       end
@@ -108,16 +108,28 @@ module ElasticAPM
           end
       end
 
-      def build_headers
+      def build_headers(metadata)
         (
           @config.http_compression? ? GZIP_HEADERS : HEADERS
         ).dup.tap do |headers|
+          headers['User-Agent'] = build_user_agent(metadata)
+
           if (token = @config.secret_token)
             headers['Authorization'] = "Bearer #{token}"
           end
         end
       end
 
+      def build_user_agent(metadata)
+        runtime = metadata.dig(:metadata, :service, :runtime)
+
+        [
+          "elastic-apm-ruby/#{VERSION}",
+          HTTP::Request::USER_AGENT,
+          [runtime[:name], runtime[:version]].join('/')
+        ].join(' ')
+      end
+
       def build_ssl_context
         return unless @config.use_ssl? && @config.server_ca_cert
 

data/lib/elastic_apm/transport/filters.rb

@@ -6,6 +6,8 @@ module ElasticAPM
   module Transport
     # @api private
     module Filters
+      SKIP = :skip
+
       def self.new(config)
         Container.new(config)
       end
@@ -27,7 +29,7 @@ module ElasticAPM
         def apply!(payload)
           @filters.reduce(payload) do |result, (_key, filter)|
             result = filter.call(result)
-            break if result.nil?
+            break SKIP if result.nil?
             result
           end
         end

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

@@ -40,7 +40,7 @@ module ElasticAPM
           return unless response
 
           {
-            status_code: response.status_code,
+            status_code: response.status_code.to_i,
             headers: response.headers,
             headers_sent: response.headers_sent,
             finished: response.finished

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

@@ -18,7 +18,7 @@ module ElasticAPM
             trace_id: error.trace_id,
             parent_id: error.parent_id,
 
-            culprit: error.culprit,
+            culprit: keyword_field(error.culprit),
             timestamp: error.timestamp
           }
 

data/lib/elastic_apm/transport/worker.rb

@@ -58,7 +58,10 @@ module ElasticAPM
 
       def serialize_and_filter(resource)
         serialized = serializers.serialize(resource)
-        @filters.apply!(serialized)
+
+        # if a filter returns nil, it means skip the event
+        return nil if @filters.apply!(serialized) == Filters::SKIP
+
         JSON.fast_generate(serialized)
       rescue Exception
         error format('Failed converting event to JSON: %s', resource.inspect)

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby