elastic-apm 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d759346f9597d0a9b179ca5b0f4b888c6b95b0f3b36efa26c568c423d82a6701
-  data.tar.gz: 1a9a46998c62b9f5d337cf4371f8472c5e337f1fb75a4094f3bd6347e4e9d537
+  metadata.gz: 4b8d2dcb34f97fa80f6dd200bbb5d6a02a0219d054a0f2ca0df5a186ff530c8a
+  data.tar.gz: 4ad68c7e8c7fcac5d82c7b621090091dd9816e90584115b0482523b7ca458942
 SHA512:
-  metadata.gz: a969fa9e0929166458d40d775d8577d0579a193f5d2b8fece6e26ddf3d15b8bdb8a5551efd7872d2a6e28a321dff77aadf433eccc4c707be0a70d560d947ccba
-  data.tar.gz: 2f849a3f13569328da9d6726a89ee80e5c9d233c53e4191525e6b95daa64f8b92cba98b981c8591d4440f86f7509056d5a578b9a481a4d278a43c6a9923e70ad
+  metadata.gz: f1203dad667452f7080e67d7509f8046b327989c88da82e7019ecac3488c6a990d974e631a2ebd284c0e7b0896c8d533912bb8228bf728f7244c4a6da10edbd6
+  data.tar.gz: be5499f9a2bbb5803879d8fde02c8aa6b4b6c7585b150cb9f7baebd7d52b86df79db664aaa3b9e330458e2f29c60dc53b4f0a96ffeb999a8615215a7b8de2289

data/CHANGELOG.md

@@ -4,6 +4,16 @@ 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)
+
+### Added
+
+- Read container info from Docker or Kupernetes ([#303](https://github.com/elastic/apm-agent-ruby/pull/303))
+
+### Fixed
+
+- Fix logging exceptions when booting via Railtie ([#306](https://github.com/elastic/apm-agent-ruby/pull/306))
+
 ## 2.3.0 (2019-01-29)
 
 ### Added

data/lib/elastic_apm/instrumenter.rb

@@ -3,6 +3,7 @@
 require 'elastic_apm/trace_context'
 require 'elastic_apm/span'
 require 'elastic_apm/transaction'
+require 'elastic_apm/span_helpers'
 
 module ElasticAPM
   # rubocop:disable Metrics/ClassLength

data/lib/elastic_apm/metadata/system_info.rb

@@ -10,9 +10,13 @@ module ElasticAPM
         @hostname = @config.hostname || `hostname`.chomp
         @architecture = gem_platform.cpu
         @platform = gem_platform.os
+
+        container_info = ContainerInfo.read!
+        @container = container_info.container
+        @kupernetes = container_info.kupernetes
       end
 
-      attr_reader :hostname, :architecture, :platform
+      attr_reader :hostname, :architecture, :platform, :container, :kupernetes
 
       private
 
@@ -22,3 +26,5 @@ module ElasticAPM
     end
   end
 end
+
+require 'elastic_apm/metadata/system_info/container_info'

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  class Metadata
+    class SystemInfo
+      # @api private
+      class ContainerInfo
+        CGROUP_PATH = '/proc/pid/cgroup'
+
+        attr_accessor :container_id, :kupernetes_namespace,
+          :kupernetes_node_name, :kupernetes_pod_name, :kupernetes_pod_uid
+
+        def initialize(cgroup_path: CGROUP_PATH)
+          @cgroup_path = cgroup_path
+        end
+
+        attr_reader :cgroup_path
+
+        def read!
+          read_from_cgroup!
+          read_from_env!
+          self
+        end
+
+        def self.read!
+          new.read!
+        end
+
+        def container
+          @container ||=
+            begin
+              return unless container_id
+              { id: container_id }
+            end
+        end
+
+        def kupernetes
+          @kupernetes =
+            begin
+              kupernetes = {}
+
+              kupernetes[:namespace] = kupernetes_namespace
+              kupernetes[:node_name] = kupernetes_node_name
+              kupernetes[:pod_name] = kupernetes_pod_name
+              kupernetes[:pod_uid] = kupernetes_pod_uid
+              return nil if kupernetes.values.all?(&:nil?)
+
+              kupernetes
+            end
+        end
+
+        private
+
+        def read_from_env!
+          self.kupernetes_namespace =
+            ENV.fetch('KUBERNETES_NAMESPACE', kupernetes_namespace)
+          self.kupernetes_node_name =
+            ENV.fetch('KUBERNETES_NODE_NAME', kupernetes_node_name)
+          self.kupernetes_pod_name =
+            ENV.fetch('KUBERNETES_POD_NAME', kupernetes_pod_name)
+          self.kupernetes_pod_uid =
+            ENV.fetch('KUBERNETES_POD_UID', kupernetes_pod_uid)
+        end
+
+        CONTAINER_ID_REGEX = /^[0-9A-Fa-f]{64}$/.freeze
+        KUBEPODS_REGEX = %r{(?:^/kubepods/[^/]+/pod([^/]+)$)|(?:^/kubepods\.slice/kubepods-[^/]+\.slice/kubepods-[^/]+-pod([^/]+)\.slice$)}.freeze # rubocop:disable Metrics/LineLength
+        SYSTEMD_SCOPE_SUFFIX = '.scope'
+
+        # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
+        def read_from_cgroup!
+          return unless File.exist?(cgroup_path)
+          IO.readlines(cgroup_path).each do |line|
+            parts = line.strip.split(':')
+            next if parts.length != 3
+
+            cgroup_path = parts[2]
+
+            # Depending on the filesystem driver used for cgroup
+            # management, the paths in /proc/pid/cgroup will have
+            # one of the following formats in a Docker container:
+            #
+            #   systemd: /system.slice/docker-<container-ID>.scope
+            #   cgroupfs: /docker/<container-ID>
+            #
+            # In a Kubernetes pod, the cgroup path will look like:
+            #
+            #   systemd:
+            #      /kubepods.slice/kubepods-<QoS-class>.slice/kubepods-\
+            #        <QoS-class>-pod<pod-UID>.slice/<container-iD>.scope
+            #   cgroupfs:
+            #      /kubepods/<QoS-class>/pod<pod-UID>/<container-iD>
+            directory, container_id = File.split(cgroup_path)
+
+            if container_id.end_with?(SYSTEMD_SCOPE_SUFFIX)
+              container_id = container_id[0...-SYSTEMD_SCOPE_SUFFIX.length]
+              if container_id.include?('-')
+                container_id = container_id.split('-', 2)[1]
+              end
+            end
+
+            if (kubepods_match = KUBEPODS_REGEX.match(directory))
+              pod_id = kubepods_match[1] || kubepods_match[2]
+
+              self.container_id = container_id
+              self.kupernetes_pod_uid = pod_id
+            elsif CONTAINER_ID_REGEX.match(container_id)
+              self.container_id = container_id
+            end
+          end
+        end
+        # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize
+      end
+    end
+  end
+end

data/lib/elastic_apm/railtie.rb

@@ -10,7 +10,7 @@ module ElasticAPM
     Config::DEFAULTS.each { |option, value| config.elastic_apm[option] = value }
 
     initializer 'elastic_apm.initialize' do |app|
-      config = app.config.elastic_apm.merge(app: app).tap do |c|
+      config = Config.new(app.config.elastic_apm.merge(app: app)).tap do |c|
         # Prepend Rails.root to log_path if present
         if c.log_path && !c.log_path.start_with?('/')
           c.log_path = Rails.root.join(c.log_path)
@@ -27,7 +27,7 @@ module ElasticAPM
         end
       rescue StandardError => e
         config.alert_logger.error format('Failed to start: %s', e.message)
-        config.alert_logger.debug e.backtrace.join("\n")
+        config.alert_logger.debug "Backtrace:\n" + e.backtrace.join("\n")
       end
     end
 

data/lib/elastic_apm/transport/connection.rb

@@ -119,7 +119,7 @@ module ElasticAPM
           if resp&.status == 202
             debug 'APM Server responded with status 202'
           elsif resp
-            error "APM Server reponded with an error:\n%p", resp.body.to_s
+            error "APM Server responded with an error:\n%p", resp.body.to_s
           end
 
           resp

data/lib/elastic_apm/util/prefixed_logger.rb

@@ -11,8 +11,8 @@ module ElasticAPM
 
     attr_reader :prefix
 
-    def add(severity, message = nil, progname = nil)
-      super(severity, format('%s%s', prefix, message), progname)
+    def add(severity, message = nil, progname = nil, &block)
+      super(severity, message, format('%s%s', prefix, progname), &block)
     end
   end
 end

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -104,6 +104,7 @@ files:
 - lib/elastic_apm/metadata/process_info.rb
 - lib/elastic_apm/metadata/service_info.rb
 - lib/elastic_apm/metadata/system_info.rb
+- lib/elastic_apm/metadata/system_info/container_info.rb
 - lib/elastic_apm/metrics.rb
 - lib/elastic_apm/metrics/cpu_mem.rb
 - lib/elastic_apm/metricset.rb