atatus 1.2.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6399d781fb6ed0fbf4d275871f8badd44feef60f0579fb98395471d837ab0a2
-  data.tar.gz: 0da5efde082affe391be507829d4cfb2eac79e9e7d87e35143e86857167f2407
+  metadata.gz: fdb76c9559c230c2e772a5878d82486da076104089c39302722fccca8f0c22db
+  data.tar.gz: 20233ccdea5269e3b3eb6c7c348091a161f875fbd1946554bdd314ee09f55ba2
 SHA512:
-  metadata.gz: 9332acfc6e05a1627e05e98dcf9ab3bfee8c7e111f1ccc41300340b54650e5d56145a0cbc46da4f07bd4b2084cc4af0e57ccdadf55831d6732309d573dd8eb78
-  data.tar.gz: b0570c4ea30150e82bdaaf1f61939ec405205a96e3808654bb3e2aaf5a156a0f25d825038c19286ca9d3774175ad5568156baa43fb5cd08b98703e3eeb55eb13
+  metadata.gz: c0dfd9f4d6ecddad2036b1b289ec864ea0edbc5f0949bfd76639b741e5a6be6ca2da9840347b10950635a235df37c20c9464505675e022b10d5c9341dc2807c1
+  data.tar.gz: 38d6f642f6f413e8c0ed989ba28d70bb9ce9643525fa28156ce8853e3781c1b3d3e9329d06d9ed0d8b7096a7d6799ad8817701012007a443f9a44a47ecf16136

data/CHANGELOG.md

@@ -4,6 +4,29 @@ 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).
 
+
+## 1.6.0 (Fri, 24 Dec 2021)
+
+- Added support for set custom data.
+- Fixed the span timing issue.
+
+
+## 1.5.0 (Thu, 27 May 2021)
+
+- Fixed issue in status code conversion.
+
+
+## 1.4.0 (Tue, 15 Sept 2020)
+
+- Added histogram support.
+- Fixed Ruby 2.7.0 warning messages.
+
+
+## 1.3.0 (Wed, 18 Mar 2020)
+
+- Added custom instrumentation via annotate method.
+
+
 ## 1.2.0 (Tue, 21 Jan 2020)
 
 - Updated Sidekiq operation as background transaction.

data/Gemfile

@@ -1,57 +1,107 @@
+# 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
 
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gemspec
-
+# Tools
+gem 'bootsnap', require: false
+gem 'cucumber', require: false
+gem 'pry'
 gem 'rack-test'
-gem 'rspec'
+gem 'rspec', '~> 3'
 gem 'rspec-its'
 gem 'rubocop', require: nil
+gem 'rubocop-performance', require: nil
 gem 'timecop'
 gem 'webmock'
 
+# Integrations
+gem 'aws-sdk-dynamodb', require: nil
+gem 'aws-sdk-sqs', require: nil
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
+gem 'graphql', require: nil
+gem 'google-protobuf', '< 3.12' if !defined?(JRUBY_VERSION) && RUBY_VERSION < '2.5'
+gem 'grpc' if !defined?(JRUBY_VERSION)
+gem 'json'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
 gem 'rake', require: nil
+gem 'resque', require: nil
 gem 'sequel', require: nil
+gem 'shoryuken', require: nil
 gem 'sidekiq', require: nil
-gem 'simplecov', require: false, group: :test
-gem 'simplecov-cobertura', require: false, group: :test
+gem 'simplecov', require: false
+gem 'simplecov-cobertura', require: false
+gem 'sneakers', '~> 2.12', require: nil
+gem 'sucker_punch', '~> 2.0', require: nil
 gem 'yard', require: nil
 gem 'yarjuf'
 
-if RUBY_PLATFORM == 'java'
-  gem 'jdbc-sqlite3'
-else
-  gem 'sqlite3'
-end
+## Install Framework
+GITHUB_REPOS = {
+  'grape' => 'ruby-grape/grape',
+  'rails' => 'rails/rails',
+  'sinatra' => 'sinatra/sinatra'
+}.freeze
 
-framework, *version = ENV.fetch('FRAMEWORK', 'rails').split('-')
-version = version.join('-')
+#                new               || legacy           || default
+env_frameworks = ENV['FRAMEWORKS'] || ENV['FRAMEWORK'] || ''
+parsed_frameworks = env_frameworks.split(',')
+frameworks_versions = parsed_frameworks.inject({}) do |frameworks, str|
+  framework, *version = str.split('-')
+  frameworks.merge(framework => version.join('-'))
+end
 
-case version
-when 'master'
-  gem framework, github: "#{framework}/#{framework}"
-when /.+/
-  gem framework, "~> #{version}.0"
-else
-  gem framework
+frameworks_versions.each do |framework, version|
+  case version
+  when 'master'
+    gem framework, github: GITHUB_REPOS.fetch(framework)
+  when /.+/
+    gem framework, "~> #{version}.0"
+  else
+    gem framework
+  end
 end
 
-gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+if frameworks_versions.key?('rails')
+  unless frameworks_versions['rails'] =~ /^(master|6)/
+    gem 'delayed_job', require: nil
+  end
+end
 
-unless version =~ /^(master|6)/
-  gem 'delayed_job', require: nil
+if RUBY_PLATFORM == 'java'
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'jdbc-sqlite3'
+elsif frameworks_versions['rails'] =~ /^(4|5)/
+  gem 'sqlite3', '~> 1.3.6'
+else
+  gem 'sqlite3' # rubocop:disable Bundler/DuplicatedGem
 end
 
 group :bench do
   gem 'ruby-prof', require: nil, platforms: %i[ruby]
   gem 'stackprof', require: nil, platforms: %i[ruby]
 end
+
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-All components of this product are Copyright (c) 2019 Atatus. All rights reserved.
+All components of this product are Copyright (c) 2021 Atatus. All rights reserved.
 
 Except as otherwise expressly provided in this Agreement,
 End User shall not (and shall not permit any third party to):

data/atatus.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://www.atatus.com'
   spec.metadata      = {
     'changelog_uri' => 'https://docs.atatus.com/docs/release-notes/ruby.html',
-    'documentation_uri' => 'https://docs.atatus.com/docs/application-monitoring/ruby-agent/rails.html',
+    'documentation_uri' => 'https://docs.atatus.com/docs/application-monitoring/ruby-agent/overview.html',
   }
   spec.date = Time.now.strftime('%Y-%m-%d')
   spec.licenses       = ['Atatus']
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   ]
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|docs|releases)/}) || f.match(%r{^(CONTRIBUTING.md|RELEASE.md)})
+    f.match(%r{^(bench|bin|test|spec|features|docs|releases)/}) || f.match(%r{^(CONTRIBUTING.md|RELEASE.md|Rakefile|docker-compose.yml|Dockerfile)})
   end
 
   spec.add_dependency('concurrent-ruby', '~> 1.0')

data/lib/atatus/agent.rb

@@ -1,3 +1,20 @@
+# 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 'atatus/error'
@@ -5,19 +22,18 @@ require 'atatus/error'
 require 'atatus/context_builder'
 require 'atatus/error_builder'
 require 'atatus/stacktrace_builder'
-require 'atatus/collector/base'
 
 require 'atatus/central_config'
-# require 'atatus/transport/base'
+require 'atatus/collector/base'
 require 'atatus/metrics'
 
 require 'atatus/spies'
 
 module Atatus
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Agent
     include Logging
+    extend Forwardable
 
     LOCK = Mutex.new
 
@@ -27,7 +43,6 @@ module Atatus
       @instance
     end
 
-    # rubocop:disable Metrics/MethodLength
     def self.start(config)
       return @instance if @instance
 
@@ -36,9 +51,9 @@ module Atatus
       LOCK.synchronize do
         return @instance if @instance
 
-        unless config.active?
+        unless config.enabled?
           config.logger.debug format(
-            "%sAgent disabled with `active: false'",
+            "%sAgent disabled with `enabled: false'",
             Logging::PREFIX
           )
           return
@@ -47,7 +62,6 @@ module Atatus
         @instance = new(config).start
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def self.stop
       LOCK.synchronize do
@@ -62,24 +76,21 @@ module Atatus
       !!@instance
     end
 
-    # rubocop:disable Metrics/MethodLength
     def initialize(config)
-      @config = config
-
       @stacktrace_builder = StacktraceBuilder.new(config)
       @context_builder = ContextBuilder.new(config)
       @error_builder = ErrorBuilder.new(self)
 
       @central_config = CentralConfig.new(config)
-      # @transport = Transport::Base.new(config)
+      @collector = Collector::Base.new(config)
+      @metrics = Metrics.new(config) { |event| enqueue event }
       @instrumenter = Instrumenter.new(
         config,
+        metrics: metrics,
         stacktrace_builder: stacktrace_builder
       ) { |event| enqueue event }
-      @metrics = Metrics.new(config) { |event| enqueue event }
-      @collector = Collector::Base.new(config)
+      @pid = Process.pid
     end
-    # rubocop:enable Metrics/MethodLength
 
     attr_reader(
       :central_config,
@@ -89,29 +100,31 @@ module Atatus
       :instrumenter,
       :metrics,
       :stacktrace_builder,
-      # :transport,
       :collector
     )
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def_delegator :@central_config, :config
+
     def start
-      unless config.disable_start_message
-        info '[%s] Starting atatus ruby agent', VERSION
+      unless config.disable_start_message?
+        config.logger.info format(
+          '[%s] Starting atatus ruby agent',
+          VERSION
+        )
       end
 
-      if @config.license_key.nil? || @config.app_name.nil?
-        if @config.license_key.nil? && @config.app_name.nil?
+      if config.license_key.nil? || config.app_name.nil?
+        if config.license_key.nil? && config.app_name.nil?
           error 'Atatus configuration license_key and app_name are missing'
-        elsif @config.license_key.nil?
+        elsif config.license_key.nil?
           error 'Atatus configuration license_key is missing'
-        elsif @config.app_name.nil?
+        elsif config.app_name.nil?
           error 'Atatus configuration app_name is missing'
         end
       end
 
-      collector.start
       central_config.start
-      # transport.start
+      collector.start
       instrumenter.start
       metrics.start
 
@@ -122,7 +135,6 @@ module Atatus
 
       self
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def stop
       debug 'Stopping agent'
@@ -131,7 +143,6 @@ module Atatus
       metrics.stop
       instrumenter.stop
       collector.stop
-      # transport.stop
 
       self
     end
@@ -172,9 +183,13 @@ module Atatus
       context: nil,
       trace_context: nil
     )
+      return unless config.recording?
+      detect_forking!
+
       instrumenter.start_transaction(
         name,
         type,
+        config: config,
         context: context,
         trace_context: trace_context
       )
@@ -192,8 +207,16 @@ module Atatus
       action: nil,
       backtrace: nil,
       context: nil,
-      trace_context: nil
+      trace_context: nil,
+      parent: nil,
+      sync: nil
     )
+      detect_forking!
+
+      # We don't check config.recording? because the span
+      # will not be created if there's no transaction.
+      # We want to use the recording value from the config
+      # that existed when start_transaction was called. ~estolfo
       instrumenter.start_span(
         name,
         type,
@@ -201,7 +224,9 @@ module Atatus
         action: action,
         backtrace: backtrace,
         context: context,
-        trace_context: trace_context
+        trace_context: trace_context,
+        parent: parent,
+        sync: sync
       )
     end
     # rubocop:enable Metrics/ParameterLists
@@ -229,6 +254,8 @@ module Atatus
     # errors
 
     def report(exception, context: nil, handled: true)
+      return unless config.recording?
+      detect_forking!
       return if config.filter_exception_types.include?(exception.class.to_s)
 
       error = @error_builder.build_exception(
@@ -241,6 +268,9 @@ module Atatus
     end
 
     def report_message(message, context: nil, backtrace: nil, **attrs)
+      return unless config.recording?
+      detect_forking!
+
       error = @error_builder.build_log(
         message,
         context: context,
@@ -256,6 +286,25 @@ module Atatus
     def add_filter(key, callback)
       # transport.add_filter(key, callback)
     end
+
+    # misc
+
+    def inspect
+      super.split.first + '>'
+    end
+
+    def detect_forking!
+      return if @pid == Process.pid
+
+      config.logger.debug "Detected forking,
+        restarting threads in process [PID:#{Process.pid}]"
+
+      central_config.handle_forking!
+      collector.handle_forking!
+      instrumenter.handle_forking!
+      metrics.handle_forking!
+
+      @pid = Process.pid
+    end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/atatus/central_config/cache_control.rb

@@ -1,3 +1,20 @@
+# 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 Atatus
@@ -26,7 +43,7 @@ module Atatus
       def parse!(value)
         value.split(',').each do |token|
           k, v = token.split('=').map(&:strip)
-          instance_variable_set(:"@#{k.gsub('-', '_')}", v ? v.to_i : true)
+          instance_variable_set(:"@#{k.tr('-', '_')}", v ? v.to_i : true)
         end
       end
     end

data/lib/atatus/central_config.rb

@@ -1,3 +1,20 @@
+# 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 'atatus/central_config/cache_control'
@@ -23,21 +40,29 @@ module Atatus
     def initialize(config)
       @config = config
       @modified_options = {}
-      @service_info = {
-        'service.name': config.service_name,
-        'service.environment': config.environment
-      }.to_json
+      # @http = Transport::Connection::Http.new(config)
+      @etag = 1
     end
 
     attr_reader :config
     attr_reader :scheduled_task, :promise # for specs
 
     def start
+      return
       return unless config.central_config?
 
+      debug 'Starting CentralConfig'
+
       fetch_and_apply_config
     end
 
+    def stop
+      return
+      debug 'Stopping CentralConfig'
+
+      @scheduled_task&.cancel
+    end
+
     def fetch_and_apply_config
       @promise =
         Concurrent::Promise
@@ -46,11 +71,6 @@ module Atatus
         .rescue(&method(:handle_error))
     end
 
-    def stop
-      @scheduled_task&.cancel
-    end
-
-    # rubocop:disable Metrics/MethodLength
     def fetch_config
       resp = perform_request
 
@@ -65,7 +85,6 @@ module Atatus
         raise ServerError, resp
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def assign(update)
       # For each updated option, store the original value,
@@ -81,20 +100,35 @@ module Atatus
         update[key] = @modified_options.delete(key)
       end
 
-      config.assign(update)
+      @config.replace_options(update)
+    end
+
+    def handle_forking!
+      stop
+      start
     end
 
     private
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def handle_success(resp)
+      if (etag = resp.headers['Etag'])
+        @etag = etag
+      end
+
       if resp.status == 304
         info 'Received 304 Not Modified'
       else
-        update = JSON.parse(resp.body.to_s)
-        assign(update)
+        if resp.body && !resp.body.empty?
+          update = JSON.parse(resp.body.to_s)
+          assign(update)
+        end
 
-        info 'Updated config from Kibana'
+        if update && update.any?
+          info 'Updated config from Kibana'
+          debug 'Modified: %s', update.inspect
+          debug 'Modified original options: %s', @modified_options.inspect
+        end
       end
 
       schedule_next_fetch(resp)
@@ -104,31 +138,42 @@ module Atatus
       error 'Failed to apply remote config, %s', e.inspect
       debug { e.backtrace.join('\n') }
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def handle_error(error)
-      error(
+      # For tests, WebMock failures don't have real responses
+      response = error.response if error.respond_to?(:response)
+
+      debug(
         'Failed fetching config: %s, trying again in %d seconds',
-        error.response.body, DEFAULT_MAX_AGE
+        response&.body, DEFAULT_MAX_AGE
       )
 
       assign({})
 
-      schedule_next_fetch(error.response)
+      schedule_next_fetch(response)
     end
 
     def perform_request
-      Http.post(
-        config.server_url + '/agent/v1/config/',
-        body: @service_info,
-        headers: { etag: 1, content_type: 'application/json' }
-      )
+      # @http.get(server_url, headers: headers)
+    end
+
+    def server_url
+      @server_url ||=
+        config.server_url +
+        '/config/v1/agents' \
+        "?service.name=#{config.service_name}"
+    end
+
+    def headers
+      { 'Etag': @etag }
     end
 
-    def schedule_next_fetch(resp)
+    def schedule_next_fetch(resp = nil)
+      headers = resp&.headers
       seconds =
-        if (cache_header = resp.headers['Cache-Control'])
-          CacheControl.new(cache_header).max_age
+        if headers && headers['Cache-Control']
+          CacheControl.new(headers['Cache-Control']).max_age
         else
           DEFAULT_MAX_AGE
         end