hoss-agent 1.0.7

data/lib/hoss/metadata/process_info.rb

@@ -0,0 +1,35 @@
+# 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 Hoss
+  class Metadata
+    # @api private
+    class ProcessInfo
+      def initialize(config)
+        @config = config
+
+        @argv = ARGV
+        @pid = $PID || Process.pid
+        @title = $PROGRAM_NAME
+      end
+
+      attr_reader :argv, :pid, :title
+    end
+  end
+end

data/lib/hoss/metadata/service_info.rb

@@ -0,0 +1,76 @@
+# 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 Hoss
+  class Metadata
+    # @api private
+    class ServiceInfo
+      # @api private
+      class Versioned
+        def initialize(name: nil, version: nil)
+          @name = name
+          @version = version
+        end
+
+        attr_reader :name, :version
+      end
+
+      class Agent < Versioned; end
+      class Framework < Versioned; end
+      class Language < Versioned; end
+      class Runtime < Versioned; end
+
+      def initialize(config)
+        @config = config
+
+        @name = @config.service_name
+        @node_name = @config.service_node_name
+        @environment = @config.environment
+        @agent = Agent.new(name: 'ruby', version: VERSION)
+        @framework = Framework.new(
+          name: @config.framework_name,
+          version: @config.framework_version
+        )
+        @language = Language.new(name: 'ruby', version: RUBY_VERSION)
+        @runtime = lookup_runtime
+        @version = @config.service_version || Util.git_sha
+      end
+
+      attr_reader :name, :node_name, :environment, :agent, :framework, :language,
+        :runtime, :version
+
+      private
+
+      def lookup_runtime
+        case RUBY_ENGINE
+        when 'ruby'
+          Runtime.new(
+            name: RUBY_ENGINE,
+            version: RUBY_VERSION || RUBY_ENGINE_VERSION
+          )
+        when 'jruby'
+          Runtime.new(
+            name: RUBY_ENGINE,
+            version: JRUBY_VERSION || RUBY_ENGINE_VERSION
+          )
+        end
+      end
+    end
+  end
+end

data/lib/hoss/metadata/system_info.rb

@@ -0,0 +1,47 @@
+# 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 Hoss
+  class Metadata
+    # @api private
+    class SystemInfo
+      def initialize(config)
+        @config = config
+
+        @hostname = @config.hostname || `hostname`.chomp
+        @architecture = gem_platform.cpu
+        @platform = gem_platform.os
+
+        container_info = ContainerInfo.read!
+        @container = container_info.container
+        @kubernetes = container_info.kubernetes
+      end
+
+      attr_reader :hostname, :architecture, :platform, :container, :kubernetes
+
+      private
+
+      def gem_platform
+        @gem_platform ||= Gem::Platform.local
+      end
+    end
+  end
+end
+
+require 'hoss/metadata/system_info/container_info'

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

@@ -0,0 +1,136 @@
+# 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 Hoss
+  class Metadata
+    class SystemInfo
+      # @api private
+      class ContainerInfo
+        CGROUP_PATH = '/proc/self/cgroup'
+
+        attr_accessor :container_id, :kubernetes_namespace,
+          :kubernetes_node_name, :kubernetes_pod_name, :kubernetes_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 kubernetes
+          @kubernetes =
+            begin
+              kubernetes = {
+                namespace: kubernetes_namespace,
+                node: { name: kubernetes_node_name },
+                pod: {
+                  name: kubernetes_pod_name,
+                  uid: kubernetes_pod_uid
+                }
+              }
+              return nil if kubernetes.values.all?(&:nil?)
+
+              kubernetes
+            end
+        end
+
+        private
+
+        def read_from_env!
+          self.kubernetes_namespace =
+            ENV.fetch('KUBERNETES_NAMESPACE', kubernetes_namespace)
+          self.kubernetes_node_name =
+            ENV.fetch('KUBERNETES_NODE_NAME', kubernetes_node_name)
+          self.kubernetes_pod_name =
+            ENV.fetch('KUBERNETES_POD_NAME', kubernetes_pod_name)
+          self.kubernetes_pod_uid =
+            ENV.fetch('KUBERNETES_POD_UID', kubernetes_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/PerceivedComplexity
+        # rubocop:disable Metrics/CyclomaticComplexity
+        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.kubernetes_pod_uid = pod_id
+            elsif CONTAINER_ID_REGEX.match(container_id)
+              self.container_id = container_id
+            end
+          end
+        end
+        # rubocop:enable Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity
+      end
+    end
+  end
+end

data/lib/hoss/naively_hashable.rb

@@ -0,0 +1,38 @@
+# 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 Hoss
+  # @api private
+  module NaivelyHashable
+    def naively_hashable?
+      true
+    end
+
+    def to_h
+      instance_variables.each_with_object({}) do |name, h|
+        key = name.to_s.delete('@').to_sym
+        value = instance_variable_get(name)
+        is_hashable =
+          value.respond_to?(:naively_hashable?) && value.naively_hashable?
+
+        h[key] = is_hashable ? value.to_h : value
+      end
+    end
+  end
+end

data/lib/hoss/rails.rb

@@ -0,0 +1,68 @@
+# 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
+
+require 'hoss/railtie'
+
+module Hoss
+  # Module for explicitly starting the Hoss agent and hooking into Rails.
+  # It is recommended to use the Railtie instead.
+  module Rails
+    extend self
+    # Start the Hoss agent and hook into Rails.
+    # Note that the agent won't be started if the Rails console is being used.
+    #
+    # @param config [Config, Hash] An instance of Config or a Hash config.
+    # @return [true, nil] true if the agent was started, nil otherwise.
+    def start(config)
+      config = Config.new(config) unless config.is_a?(Config)
+
+      if (reason = should_skip?(config))
+        unless config.disable_start_message?
+          config.logger.info "Skipping because: #{reason}. " \
+            "Start manually with `Hoss.start'"
+        end
+
+        return
+      end
+
+      Hoss.start(config).tap do |agent|
+      end
+
+      Hoss.running?
+    rescue StandardError => e
+      if config.disable_start_message?
+        config.logger.error format('Failed to start: %s', e.message)
+        config.logger.debug "Backtrace:\n" + e.backtrace.join("\n")
+      else
+        puts format('Failed to start: %s', e.message)
+        puts "Backtrace:\n" + e.backtrace.join("\n")
+      end
+    end
+
+    private
+
+    def should_skip?(_config)
+      if ::Rails.const_defined?('Console', false)
+        return 'Rails console'
+      end
+
+      nil
+    end
+  end
+end

data/lib/hoss/railtie.rb

@@ -0,0 +1,42 @@
+# 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 Hoss
+  # @api private
+  class Railtie < ::Rails::Railtie
+    config.hoss = ActiveSupport::OrderedOptions.new
+
+    Config.schema.each do |key, args|
+      next unless args.length > 1
+      config.hoss[key] = args[:default]
+    end
+
+    initializer 'hoss.initialize' do |app|
+      config = Config.new(app.config.hoss.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)
+        end
+      end
+
+      if Rails.start(config)
+      end
+    end
+  end
+end