elastic-apm 4.5.1 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 176cc8d035203774027d36d50769b763761354f3b9627f024ce90e07cd9069e3
-  data.tar.gz: 19a6d7ed6796133c1b79b2e762718f4be7068e4e5876e13e9e898894fc112900
+  metadata.gz: edae30dc148307b137e402a81ffed731cbe738ca7924f31c9440a9a6ea9a8eb4
+  data.tar.gz: ef860d2d783fd9351b0eea3106e96eafbadef339fa72a4b5979fbc38d4e3d46a
 SHA512:
-  metadata.gz: e2c34d43d849374706b481eabda64190ae0469e6770f068166eae20d42f7b12a54213820fac8a78e9343cca785f68378e9d4212a3fa6235966f6bb2a8517ca2d
-  data.tar.gz: c19991391535b0ab3087bcdb3bf3d7354a160570fa08a80c313391ab739c9996872e1b68f7ec164223bec2f2f70e643daa6c2ca69adb9549a1255abac5c1f794
+  metadata.gz: 8e1543b7f39d5ba73eb30e34777ba07a8ae940ddd1aee2d84afc445642319304bd26036a9eb5b5e6d4d9c11bbc0323c7c17aa2bd18101bbfcfed1cdcf6bdc635
+  data.tar.gz: 971963f1d06a398c2af8f988e4386004b7fb176e67d6d8c35b9be8a781b8561fd8236395d89f51ef87e3cad4375f9c91c4105e550dc7f7b1e7b1142e1d0f7c17

data/.ci/.jenkins_exclude.yml

@@ -1,6 +1,8 @@
 exclude:
   # Ruby 2.4
-  # Only includes rails-5.2, sinatra-2.0
+  # Only test on rails-5.2, sinatra-1.4
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: rails-7.0
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-6.1
   - RUBY_VERSION: ruby:2.4
@@ -8,11 +10,11 @@ exclude:
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: ruby:2.4
-    FRAMEWORK: sinatra-1.4
+    FRAMEWORK: sinatra-2.2
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: grape-1.6
   - RUBY_VERSION: ruby:2.4
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.0
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.0
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-main
   - RUBY_VERSION: ruby:2.4
@@ -21,7 +23,9 @@ exclude:
     FRAMEWORK: grape-master
 
   # rails-4.2 exclusions
-  # Only test on ruby 2.6, 2.5, 2.4, 2.3
+  # Only test on ruby 2.6, 2.5, 2.4
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: rails-4.2
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: rails-4.2
   - RUBY_VERSION: ruby:2.7
@@ -35,6 +39,8 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
     FRAMEWORK: rails-4.2
   # sinatra-1.4 exclusions
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: sinatra-1.4
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: sinatra-1.4
   - RUBY_VERSION: ruby:2.7
@@ -55,7 +61,11 @@ exclude:
   - RUBY_VERSION: ruby:2.4
     FRAMEWORK: rails-6.0
 
-  # Only test rails master on ruby 2.7 and ruby 3.0
+  # Only test rails master on ruby 3.1
+  - RUBY_VERSION: ruby:3.0
+    FRAMEWORK: rails-main
+  - RUBY_VERSION: ruby:2.7
+    FRAMEWORK: rails-main
   - RUBY_VERSION: ruby:2.6
     FRAMEWORK: rails-main
   - RUBY_VERSION: ruby:2.5
@@ -71,7 +81,25 @@ exclude:
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
     FRAMEWORK: rails-main
 
-  # Only test sinatra master on ruby 2.7 and ruby 3.0
+  # Only test rails 7.0 on ruby >= 2.7
+  - RUBY_VERSION: ruby:2.6
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: ruby:2.5
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: ruby:2.4
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
+    FRAMEWORK: rails-7.0
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: rails-7.0
+
+  # Only test sinatra master on ruby 2.7 and ruby 3.1
+  - RUBY_VERSION: ruby:3.0
+    FRAMEWORK: sinatra-master
   - RUBY_VERSION: ruby:2.6
     FRAMEWORK: sinatra-master
   - RUBY_VERSION: ruby:2.5
@@ -104,31 +132,60 @@ exclude:
     FRAMEWORK: grape-master
 
   # grape 1.5 doesn't support ruby 3.0
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: grape-1.6
   - RUBY_VERSION: ruby:3.0
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
 
-  # only test ruby 3.0 with rails 6.0 and rails 6.1
+  # only test ruby >= 3.0 with rails 6.0 and rails 6.1
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: rails-5.2
+  - RUBY_VERSION: ruby:3.1
+    FRAMEWORK: rails-5.1
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: rails-5.2
   - RUBY_VERSION: ruby:3.0
     FRAMEWORK: rails-5.1
 
   # Unsupported
+  # Ruby 2.6
   - RUBY_VERSION: ruby:2.6
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - RUBY_VERSION: ruby:2.6
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # Ruby 2.5
+  - RUBY_VERSION: ruby:2.5
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: ruby:2.5
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # Ruby 2.4
   - RUBY_VERSION: ruby:2.4
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: ruby:2.4
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2
+  - RUBY_VERSION: jruby:9.2
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: jruby:9.2
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-13-jdk
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-13-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-11-jdk
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-11-jdk
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0
+  # JRuby 9.2-8-jdk
+  - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-6.1
   - RUBY_VERSION: docker.elastic.co/observability-ci/jruby:9.2-8-jdk
-    FRAMEWORK: grape-1.6,sinatra-2.0,rails-6.1
+    FRAMEWORK: grape-1.6,sinatra-2.2,rails-7.0

data/.ci/.jenkins_framework.yml

@@ -1,12 +1,13 @@
 FRAMEWORK:
+  - rails-7.0
   - rails-6.1
   - rails-6.0
   - rails-5.2
   - rails-4.2
 
-  - sinatra-2.0
+  - sinatra-2.2
   - sinatra-1.4
 
   - grape-1.6
 
-  - grape-1.6,sinatra-2.0,rails-6.1
+  - grape-1.6,sinatra-2.2,rails-6.1

data/.ci/.jenkins_ruby.yml

@@ -1,8 +1,8 @@
 RUBY_VERSION:
+  - ruby:3.1
   - ruby:3.0
   - ruby:2.7
   - ruby:2.6
-  - ruby:2.5
   - ruby:2.4
   - jruby:9.2
   - docker.elastic.co/observability-ci/jruby:9.2-13-jdk

data/.ci/.jenkins_ruby_benchmarks.yml

@@ -0,0 +1,6 @@
+RUBY_VERSION:
+  - ruby:3.1
+  - ruby:3.0
+  - ruby:2.7
+  - ruby:2.6
+  - jruby:9.2

data/.ci/Jenkinsfile

@@ -21,8 +21,6 @@ pipeline {
     CODECOV_SECRET = 'secret/apm-team/ci/apm-agent-ruby-codecov'
     DOCKER_REGISTRY = 'docker.elastic.co'
     DOCKER_SECRET = 'secret/apm-team/ci/docker-registry/prod'
-    GITHUB_CHECK_ITS_NAME = 'Integration Tests'
-    ITS_PIPELINE = 'apm-integration-tests-selector-mbp/main'
     RELEASE_SECRET = 'secret/apm-team/ci/apm-agent-ruby-rubygems-release'
     OPBEANS_REPO = 'opbeans-ruby'
     REFERENCE_REPO = '/var/lib/jenkins/.git-references/apm-agent-ruby.git'
@@ -123,25 +121,6 @@ pipeline {
             }
           }
         }
-        stage('Integration Tests') {
-          agent none
-          when {
-            beforeAgent true
-            anyOf {
-              changeRequest()
-              expression { return !params.Run_As_Main_Branch }
-            }
-          }
-          steps {
-            githubNotify(context: "${env.GITHUB_CHECK_ITS_NAME}", description: "${env.GITHUB_CHECK_ITS_NAME} ...", status: 'PENDING', targetUrl: "${env.JENKINS_URL}search/?q=${env.ITS_PIPELINE.replaceAll('/','+')}")
-            build(job: env.ITS_PIPELINE, propagate: false, wait: true,
-                  parameters: [ string(name: 'INTEGRATION_TEST', value: 'Ruby'),
-                                string(name: 'BUILD_OPTS', value: "--ruby-agent-version ${env.GIT_BASE_COMMIT} --ruby-agent-version-state ${env.GIT_BUILD_CAUSE} --ruby-agent-repo ${env.CHANGE_FORK?.trim() ?: 'elastic'}/${env.REPO} --opbeans-ruby-agent-branch ${env.GIT_BASE_COMMIT}"),
-                                string(name: 'GITHUB_CHECK_NAME', value: env.GITHUB_CHECK_ITS_NAME),
-                                string(name: 'GITHUB_CHECK_REPO', value: env.REPO),
-                                string(name: 'GITHUB_CHECK_SHA1', value: env.GIT_BASE_COMMIT) ])
-          }
-        }
       }
     }
     stage('Benchmarks') {
@@ -162,13 +141,13 @@ pipeline {
       }
       stages {
         stage('Clean Workspace') {
-          agent { label 'metal' }
+          agent { label 'microbenchmarks-pool' }
           steps {
             echo "Cleaning Workspace"
           }
           post {
             always {
-              cleanWs()
+              cleanWs(notFailBuild: true)
             }
           }
         }
@@ -183,7 +162,7 @@ pipeline {
               unstash 'source'
               dir("${BASE_DIR}"){
                 script {
-                  def versions = readYaml(file: ".ci/.jenkins_ruby.yml")
+                  def versions = readYaml(file: ".ci/.jenkins_ruby_benchmarks.yml")
                   def benchmarkTask = [:]
                   versions['RUBY_VERSION'].each{ v ->
                     benchmarkTask[v] = runBenchmark(v)
@@ -283,7 +262,7 @@ pipeline {
 */
 def runBenchmark(version){
   return {
-    node('metal'){
+    node('microbenchmarks-pool'){
       // 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
@@ -299,8 +278,6 @@ def runBenchmark(version){
             }
             try{
               sh """./spec/scripts/benchmarks.sh "${version}" "${REFERENCE_REPO}" """
-            } catch(e){
-              throw e
             } finally {
               archiveArtifacts(
                 allowEmptyArchive: true,
@@ -308,6 +285,7 @@ def runBenchmark(version){
                 onlyIfSuccessful: false)
               sendBenchmarks(file: "benchmark-${transformedVersion}.bulk",
                 index: "benchmark-ruby", archive: true)
+              cleanWs(notFailBuild: true)
             }
           }
         }

data/CHANGELOG.asciidoc

@@ -35,6 +35,30 @@ endif::[]
 [[release-notes-4.x]]
 === Ruby Agent version 4.x
 
+[[release-notes-4.6.0]]
+==== 4.6.0
+
+[float]
+===== Added
+
+- Added transaction_name to reported error to allow grouping by transaction name {pull}1267[#1267]
+- Added ability to query server for version (useful in the future) {pull}1278[#1278]
+- Added instrumentation for https://github.com/zendesk/racecar/ Racecar Kafka library {pull}1284[#1284]
+
+===== Changed
+
+- Expanded filtering to sanitize any key that contains the string 'auth' {pull}1266[#1266]
+- Rename `log_ecs_formatting` option to `log_ecs_reformatting`, deprecate old option name {pull}1248[#1248]
+- When the configuration value for `log_path` is set, override the `logger` to point to that path instead of using e.g. Rails logger {pull}1247[#1247]
+- Only send tracestate header for distributed tracing when it has content {pull}1277[#1277]
+- Use the hostname as the Kubernetes pod name in the Container Info metadata if the pod id is parsed from cgroup {pull}1314[#1314]
+
+====== Fixed
+
+- Small change to Sidekiq tests to handle new configuration passing method {pull}1283[#1283]
+- Set transaction sample rate to 0 when it's unsampled {pull}1339[#1339]
+- Don't send unsampled transactions to APM server >= 8.0 {pull}1341[#1341]
+
 [[release-notes-4.5.1]]
 ==== 4.5.1
 

data/Gemfile

@@ -46,11 +46,12 @@ if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
   gem 'google-protobuf', '< 3.12'
 end
 gem 'grpc' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '3.0'
-gem 'json', '2.6.2' # note: can be unpinned when https://github.com/flori/json/issues/495 is resolved
+gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
 gem 'rake', '>= 13.0', require: nil
+gem 'racecar', require: nil if !defined?(JRUBY_VERSION)
 gem 'resque', require: nil
 gem 'sequel', require: nil
 gem 'shoryuken', require: nil
@@ -77,6 +78,10 @@ frameworks_versions = parsed_frameworks.inject({}) do |frameworks, str|
 end
 
 frameworks_versions.each do |framework, version|
+  if framework =='rails' && RUBY_VERSION >= '3.1'
+    gem 'net-smtp', require: false
+  end
+
   case version
   when 'master' # sinatra, grape
     gem framework, github: GITHUB_REPOS.fetch(framework)
@@ -115,8 +120,8 @@ else
   gem 'sqlite3'
 end
 
-# current sneakers only supports >=2.5.0
-if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('2.5.0')
+# sneakers main only supports >=2.5.0
+if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create('2.5.0') && !defined?(JRUBY_VERSION)
   gem 'sneakers', github: 'jondot/sneakers', ref: 'd761dfe1493', require: nil
 end
 

data/bench/report.rb

@@ -11,7 +11,7 @@ git_date = `git log -n 1 --pretty="format:%ai"`
 platform = Gem::Platform.local
 
 def doc(payload)
-  puts({ index: { _index: "benchmark-ruby", _type: "_doc" } }.to_json)
+  puts({ index: { _index: "benchmark-ruby" } }.to_json)
   puts(payload.to_json)
 end
 

data/docs/configuration.asciidoc

@@ -506,12 +506,12 @@ Elastic APM can instrument your Rake tasks. This is an opt-in field, as they are
 
 [float]
 [[config-log-ecs-formatting]]
-==== `log_ecs_formatting`
+==== `log_ecs_reformatting`
 
 [options="header"]
 |============
 | Environment             | `Config` key | Default
-| `ELASTIC_APM_LOG_ECS_FORMATTING` | `log_ecs_formatting`  | `off`
+| `ELASTIC_APM_LOG_ECS_REFORMATTING` | `log_ecs_reformatting`  | `off`
 |============
 
 This is an experimental option that configures the agent to use the logger from the `ecs-logging` gem. The two
@@ -520,7 +520,7 @@ valid options are `off` and `override`.
 Setting this option to `override` will set the agent logger to a `EcsLogging::Logger` instance and all logged output
 will be in ECS-compatible json.
 
-The `ecs-logging` gem must be installed before the agent is started. If `log_ecs_formatting` is set to `override`,
+The `ecs-logging` gem must be installed before the agent is started. If `log_ecs_reformatting` is set to `override`,
 the agent will attempt to require the gem and if it cannot be loaded, it will fall back to using the standard Ruby
 `::Logger` and log the load error.
 
@@ -556,6 +556,8 @@ A path to a log file.
 
 By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
 
+If `log_path` is specified, this will override `Rails.log` to point to that path instead.
+
 This should support both absolute and relative paths. Please be sure the directory exists.
 
 [float]
@@ -654,7 +656,7 @@ when this option is false.
 [options="header"]
 |============
 | Environment                        | `Config` key           | Default                                                                                        | Example
-| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,authorization,set-cookie"` | `Auth*tion,abc*,*xyz`
+| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,*auth*,set-cookie"` | `Auth*tion,abc*,*xyz`
 |============
 
 Sometimes it is necessary to sanitize the data sent to Elastic APM to remove sensitive values.

data/elastic-apm.gemspec

@@ -22,8 +22,8 @@ require 'elastic_apm/version'
 Gem::Specification.new do |spec|
   spec.name    = 'elastic-apm'
   spec.version = ElasticAPM::VERSION
-  spec.authors = ['Mikkel Malmberg']
-  spec.email   = ['mikkel@elastic.co']
+  spec.authors = ['Mikkel Malmberg', 'Emily Stolfo']
+  spec.email   = ['info@elastic.co']
 
   spec.summary  = 'The official Elastic APM agent for Ruby'
   spec.homepage = 'https://github.com/elastic/apm-agent-ruby'
@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency('concurrent-ruby', '~> 1.0')
   spec.add_dependency('http', '>= 3.0')
+  spec.add_runtime_dependency('ruby2_keywords')
 
   spec.require_paths = ['lib']
 end

data/lib/elastic_apm/central_config.rb

@@ -181,6 +181,11 @@ module ElasticAPM
           DEFAULT_MAX_AGE
         end
 
+      if seconds < 5
+        debug "Next fetch is too low (#{seconds}s) - increasing to default"
+        seconds = 5
+      end
+
       @scheduled_task =
         Concurrent::ScheduledTask
         .execute(seconds) { fetch_and_apply_config }

data/lib/elastic_apm/config/server_info.rb

@@ -0,0 +1,50 @@
+# 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
+  class Config
+    # @api private
+    class ServerInfo
+      attr_reader :payload, :config, :http
+
+      VERSION_8_0 = '8.0'
+      VERSION_0 = '0'
+
+      def initialize(config)
+        @config = config
+        @http = Transport::Connection::Http.new(config)
+      end
+
+      def execute
+        resp = http.get(config.server_url)
+        @payload = JSON.parse(resp.body)
+      rescue
+        @payload = { "version" => VERSION_0 }
+      end
+
+      def version
+        @version ||= begin
+          execute
+          payload["version"] ? payload["version"].to_s : VERSION_0
+        end
+      end
+    end
+  end
+end
+  

data/lib/elastic_apm/config.rb

@@ -24,14 +24,17 @@ require 'elastic_apm/config/options'
 require 'elastic_apm/config/round_float'
 require 'elastic_apm/config/regexp_list'
 require 'elastic_apm/config/wildcard_pattern_list'
+require 'elastic_apm/deprecations'
+require 'elastic_apm/config/server_info'
 
 module ElasticAPM
   # @api private
   class Config
     extend Options
+    extend Deprecations
 
     SANITIZE_FIELD_NAMES_DEFAULT =
-      %w[password passwd pwd secret *key *token* *session* *credit* *card* authorization set-cookie].freeze
+      %w[password passwd pwd secret *key *token* *session* *credit* *card* *auth* set-cookie].freeze
 
     # rubocop:disable Layout/LineLength, Layout/ExtraSpacing
     option :config_file,                       type: :string, default: 'config/elastic_apm.yml'
@@ -70,7 +73,7 @@ module ElasticAPM
     option :ignore_url_patterns,               type: :list,   default: [],      converter: RegexpList.new
     option :instrument,                        type: :bool,   default: true
     option :instrumented_rake_tasks,           type: :list,   default: []
-    option :log_ecs_formatting,                type: :string, default: 'off'
+    option :log_ecs_reformatting,              type: :string, default: 'off'
     option :log_level,                         type: :int,    default: Logger::INFO, converter: LogLevelMap.new
     option :log_path,                          type: :string
     option :metrics_interval,                  type: :int,    default: '30s',   converter: Duration.new
@@ -98,6 +101,16 @@ module ElasticAPM
     option :use_elastic_traceparent_header,    type: :bool,   default: true
     option :verify_server_cert,                type: :bool,   default: true
 
+    def log_ecs_formatting
+      log_ecs_reformatting
+    end
+
+    def log_ecs_formatting=(value)
+      @options[:log_ecs_reformatting].set(value)
+    end
+
+    deprecate :log_ecs_formatting, :log_ecs_reformatting
+
     # rubocop:enable Layout/LineLength, Layout/ExtraSpacing
     def initialize(options = {})
       @options = load_schema
@@ -116,7 +129,9 @@ module ElasticAPM
 
       yield self if block_given?
 
-      self.logger ||= build_logger
+      if self.logger.nil? || self.log_path
+        self.logger = build_logger
+      end
 
       @__view_paths ||= []
       @__root_path ||= Dir.pwd
@@ -144,6 +159,7 @@ module ElasticAPM
         mongo
         net_http
         rake
+        racecar
         redis
         resque
         s3
@@ -229,6 +245,10 @@ module ElasticAPM
       super.split.first + '>'
     end
 
+    def version
+      @version ||= ServerInfo.new(self).version
+    end
+
     private
 
     def load_config_file
@@ -247,7 +267,7 @@ module ElasticAPM
     end
 
     def build_logger
-      if self.log_ecs_formatting == 'override'
+      if self.log_ecs_reformatting == 'override'
         begin
           return build_ecs_logger
         rescue LoadError
@@ -294,6 +314,7 @@ module ElasticAPM
       self.framework_name ||= 'Ruby on Rails'
       self.framework_version ||= ::Rails::VERSION::STRING
       self.logger ||= ::Rails.logger
+      self.log_level ||= ::Rails.logger.log_level
 
       self.__root_path = ::Rails.root.to_s
       self.__view_paths = app.config.paths['app/views'].existent +

data/lib/elastic_apm/error.rb

@@ -33,7 +33,7 @@ module ElasticAPM
     end
 
     attr_accessor :id, :culprit, :exception, :log, :transaction_id,
-      :transaction, :context, :parent_id, :trace_id
+      :transaction_name, :transaction, :context, :parent_id, :trace_id
     attr_reader :timestamp
 
     def inspect
@@ -41,6 +41,7 @@ module ElasticAPM
         " culprit:#{culprit}" \
         " timestamp:#{timestamp}" \
         " transaction_id:#{transaction_id}" \
+        " transaction_name:#{transaction_name}" \
         " trace_id:#{trace_id}" \
         " exception:#{exception.inspect}" \
         '>'

data/lib/elastic_apm/error_builder.rb

@@ -74,6 +74,7 @@ module ElasticAPM
       return unless transaction
 
       error.transaction_id = transaction.id
+      error.transaction_name = transaction.name
       error.transaction = {
         sampled: transaction.sampled?,
         type: transaction.type

data/lib/elastic_apm/instrumenter.rb

@@ -124,7 +124,7 @@ module ElasticAPM
         sample_rate = trace_context.tracestate.sample_rate
       else
         sampled = random_sample?(config)
-        sample_rate = config.transaction_sample_rate
+        sample_rate = sampled ? config.transaction_sample_rate : 0
       end
 
       transaction =
@@ -150,7 +150,9 @@ module ElasticAPM
 
       transaction.done result
 
-      enqueue.call transaction
+      if transaction.sampled? || @config.version < Config::ServerInfo::VERSION_8_0
+        enqueue.call transaction
+      end
 
       update_transaction_metrics(transaction)
 

data/lib/elastic_apm/metadata/system_info/container_info.rb

@@ -33,14 +33,15 @@ module ElasticAPM
 
         attr_reader :cgroup_path
 
-        def read!
+        def read!(hostname)
           read_from_cgroup!
+          self.kubernetes_pod_name = hostname if kubernetes_pod_uid
           read_from_env!
           self
         end
 
-        def self.read!
-          new.read!
+        def self.read!(hostname)
+          new.read!(hostname)
         end
 
         def container

data/lib/elastic_apm/metadata/system_info.rb

@@ -29,7 +29,7 @@ module ElasticAPM
         @architecture = gem_platform.cpu
         @platform = gem_platform.os
 
-        container_info = ContainerInfo.read!
+        container_info = ContainerInfo.read!(@detected_hostname)
         @container = container_info.container
         @kubernetes = container_info.kubernetes
       end

data/lib/elastic_apm/span/context/links.rb

@@ -0,0 +1,32 @@
+# 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
+    class Span
+      class Context
+        # @api private
+        class Links < Array
+          # @api private
+          class Link < Struct.new(:trace_id, :span_id)
+          end
+        end
+      end
+    end
+  end
+  

data/lib/elastic_apm/span/context/service.rb

@@ -0,0 +1,55 @@
+# 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
+  class Span
+    class Context
+      # @api private
+      class Service
+        include Fields
+
+        field :target
+
+        # @api private
+        class Target
+          include Fields
+
+          field :name, default: ''
+          field :type, default: ''
+        end
+
+        def initialize(target: nil, **attrs)
+          super(**attrs)
+
+          self.target = build_target(target)
+        end
+
+        private
+
+        def build_target(target = nil)
+          return Target.new unless target
+          return target if target.is_a?(Target)
+
+          Target.new(**target)
+        end
+      end
+    end
+  end
+end
+  

data/lib/elastic_apm/span/context.rb

@@ -27,7 +27,9 @@ module ElasticAPM
         http: nil,
         labels: {},
         sync: nil,
-        message: nil
+        message: nil,
+        service: nil,
+        links: nil
       )
         @sync = sync
         @db = db && Db.new(**db)
@@ -43,6 +45,16 @@ module ElasticAPM
           when Hash then Message.new(**message)
           end
         @labels = labels
+        @service =
+          case service
+          when Service then service
+          when Hash then Service.new(**service)
+          end
+        @links =
+          case links
+          when Links then links
+          when Array then Links.new(links)
+          end
       end
 
       attr_reader(
@@ -50,10 +62,11 @@ module ElasticAPM
         :http,
         :labels,
         :sync,
-        :message
+        :message,
+        :links
       )
 
-      attr_accessor :destination
+      attr_accessor :destination, :service
     end
   end
 end
@@ -62,3 +75,6 @@ require 'elastic_apm/span/context/db'
 require 'elastic_apm/span/context/http'
 require 'elastic_apm/span/context/destination'
 require 'elastic_apm/span/context/message'
+require 'elastic_apm/span/context/service'
+require 'elastic_apm/span/context/links'
+

data/lib/elastic_apm/span.rb

@@ -145,6 +145,9 @@ module ElasticAPM
         service: service,
         cloud: cloud
       )
+      context.service = Span::Context::Service.new(
+        target: Span::Context::Service::Target.new(name: context.destination.service.name, type: context.destination.service.type )
+      )
     end
 
     def inspect

data/lib/elastic_apm/span_helpers.rb

@@ -37,7 +37,7 @@ module ElasticAPM
         type ||= Span::DEFAULT_TYPE
 
         klass.prepend(Module.new do
-          define_method(method) do |*args, &block|
+          ruby2_keywords(define_method(method) do |*args, &block|
             unless ElasticAPM.current_transaction
               return super(*args, &block)
             end
@@ -45,7 +45,7 @@ module ElasticAPM
             ElasticAPM.with_span name.to_s, type.to_s do
               super(*args, &block)
             end
-          end
+          end)
         end)
       end
     end

data/lib/elastic_apm/spies/racecar.rb

@@ -0,0 +1,77 @@
+# 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.
+
+begin
+require 'active_support/notifications'
+require 'active_support/subscriber'
+
+  # frozen_string_literal: true
+  module ElasticAPM
+    # @api private
+    module Spies
+      # @api private
+      class RacecarSpy
+        TYPE = 'kafka'
+        SUBTYPE = 'racecar'
+
+        # @api private
+        class ConsumerSubscriber < ActiveSupport::Subscriber
+          def start_process_message(event)
+            start_process_transaction(event: event, kind: 'process_message')
+          end
+          def process_message(_event)
+            ElasticAPM.end_transaction
+          end
+
+          def start_process_batch(event)
+            start_process_transaction(event: event, kind: 'process_batch')
+          end
+          def process_batch(_event)
+            ElasticAPM.end_transaction
+          end
+
+          private # only public methods will be subscribed
+
+          def start_process_transaction(event:, kind:)
+            ElasticAPM.start_transaction(kind, TYPE)
+            ElasticAPM.current_transaction.context.set_service(framework_name: 'racecar', framework_version: Racecar::VERSION)
+          end
+        end
+
+        class ProducerSubscriber < ActiveSupport::Subscriber
+          def start_deliver_message(event)
+            ElasticAPM.start_transaction('deliver_message',TYPE)
+            ElasticAPM.current_transaction.context.set_service(framework_name: 'racecar', framework_version: Racecar::VERSION)
+          end
+
+          def deliver_message(_event)
+            ElasticAPM.end_transaction
+          end
+        end
+
+        def install
+          ConsumerSubscriber.attach_to(:racecar)
+          ProducerSubscriber.attach_to(:racecar)
+        end
+      end
+      register 'Racecar', 'racecar', RacecarSpy.new
+    end
+  end
+
+rescue LoadError
+  # no active support available
+end

data/lib/elastic_apm/spies/redis.rb

@@ -25,7 +25,7 @@ module ElasticAPM
       # @api private
       module Ext
         def call(command, &block)
-          name = command[0].upcase
+          name = command[0].to_s.upcase
 
           return super(command, &block) if command[0] == :auth
 

data/lib/elastic_apm/spies/sequel.rb

@@ -44,8 +44,17 @@ module ElasticAPM
           name =
             ElasticAPM::Spies::SequelSpy.summarizer.summarize sql
 
+          db_name = ''
+          # postgresql shows current database
+          db_name = connection&.db.to_s if connection.respond_to?(:db)
+          # sqlite may expose a filename
+          db_name = connection&.filename.to_s if db_name == '' && connection.respond_to?(:filename)
+          # fall back to adapter class name
+          db_name = connection.class.to_s if db_name == ''
+
           context = ElasticAPM::Span::Context.new(
             db: { statement: sql, type: 'sql', user: opts[:user] },
+            service: {target: {type: subtype, name: db_name }},
             destination: { service: { resource: subtype } }
           )
 

data/lib/elastic_apm/spies/sqs.rb

@@ -56,6 +56,7 @@ module ElasticAPM
             service: { resource: "#{SUBTYPE}/#{queue_name}" },
             cloud: { region: region }
           }
+          # span links added here?
         )
       end
 

data/lib/elastic_apm/trace_context/tracestate.rb

@@ -107,7 +107,7 @@ module ElasticAPM
           split_by_nl_and_comma(header)
           .each_with_object({}) do |entry, hsh|
             k, v = entry.split('=')
-
+            next unless k && v && !k.empty? && !v.empty?
             hsh[k] =
               case k
               when 'es' then EsEntry.new(v)

data/lib/elastic_apm/trace_context.rb

@@ -96,7 +96,7 @@ module ElasticAPM
     def apply_headers
       yield 'Traceparent', traceparent.to_header
 
-      if tracestate
+      if tracestate && !tracestate.to_header.empty?
         yield 'Tracestate', tracestate.to_header
       end
 

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

@@ -69,6 +69,14 @@ module ElasticAPM
               base[:message] = build_message(context.message)
             end
 
+            if context.service
+              base[:service] = build_service(context.service)
+            end
+
+            if context.links && !context.links.empty?
+              base[:links] = build_links(context.links)
+            end
+
             base
           end
 
@@ -121,6 +129,23 @@ module ElasticAPM
               }
             }
           end
+
+          def build_service(service)
+            {
+              target: {
+                name: keyword_field(service.target&.name),
+                type: keyword_field(service.target&.type)
+              }
+            }
+          end
+
+          def build_links(links)
+            {
+              links: links.map do |link|
+                {"trace_id" => link.trace_id, "span_id" => link.span_id}
+              end
+            }
+          end
         end
 
         private

data/lib/elastic_apm/version.rb

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

data/lib/elastic_apm.rb

@@ -26,6 +26,7 @@ require 'logger'
 require 'concurrent'
 require 'forwardable'
 require 'securerandom'
+require 'ruby2_keywords'
 
 require 'elastic_apm/version'
 require 'elastic_apm/internal_error'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 4.5.1
+  version: 4.6.0
 platform: ruby
 authors:
 - Mikkel Malmberg
+- Emily Stolfo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-17 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,9 +39,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
-- mikkel@elastic.co
+- info@elastic.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -50,6 +65,7 @@ files:
 - ".ci/.jenkins_framework.yml"
 - ".ci/.jenkins_main_framework.yml"
 - ".ci/.jenkins_ruby.yml"
+- ".ci/.jenkins_ruby_benchmarks.yml"
 - ".ci/Jenkinsfile"
 - ".ci/docker/jruby/11-jdk/Dockerfile"
 - ".ci/docker/jruby/12-jdk/Dockerfile"
@@ -136,6 +152,7 @@ files:
 - lib/elastic_apm/config/options.rb
 - lib/elastic_apm/config/regexp_list.rb
 - lib/elastic_apm/config/round_float.rb
+- lib/elastic_apm/config/server_info.rb
 - lib/elastic_apm/config/wildcard_pattern_list.rb
 - lib/elastic_apm/context.rb
 - lib/elastic_apm/context/request.rb
@@ -192,7 +209,9 @@ files:
 - lib/elastic_apm/span/context/db.rb
 - lib/elastic_apm/span/context/destination.rb
 - lib/elastic_apm/span/context/http.rb
+- lib/elastic_apm/span/context/links.rb
 - lib/elastic_apm/span/context/message.rb
+- lib/elastic_apm/span/context/service.rb
 - lib/elastic_apm/span_helpers.rb
 - lib/elastic_apm/spies.rb
 - lib/elastic_apm/spies/action_dispatch.rb
@@ -205,6 +224,7 @@ files:
 - lib/elastic_apm/spies/json.rb
 - lib/elastic_apm/spies/mongo.rb
 - lib/elastic_apm/spies/net_http.rb
+- lib/elastic_apm/spies/racecar.rb
 - lib/elastic_apm/spies/rake.rb
 - lib/elastic_apm/spies/redis.rb
 - lib/elastic_apm/spies/resque.rb