atatus 1.6.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a2777c09d7af196314fb322c9a55feadb46f50d90ffd88976ff978eb5039a2
-  data.tar.gz: 59f1f63ebd4ad84f23359cc2c96ccb62e0c0eabceaa6b48bf63c711c3383bf64
+  metadata.gz: 454ba0ab877ac91b387bb0d4b3355494c2707a56634cd97774b0bcdb3e2194a6
+  data.tar.gz: dc8b8beca08a3a6ecc278c999d48ea7c316ac1fe8f5a221cd32df8a0bcd37262
 SHA512:
-  metadata.gz: 1a705d56af3228c31ce400a16eae3d961fe2bbcae949db3effc4828682563bd4ce3070adb14613cb096caa48d71e8ccce2969dc21f4b0c910c73ca99b28bf566
-  data.tar.gz: 30461593c406cf6f7b8f2e08c9bef4aa64b9f60f0f4c2b3f0bff9de1cff8a26f5cf25e07507b263e8638a37345916f15d479eb11bcb3e58f69a7f34d79d51d70
+  metadata.gz: 8377d4e174399b782592ce39b48ca738a806a8b881fe045cb3586cdc232d1f9d29a3f99ec02ab27cddd8c84a3c250b9bf35ac1f1bbb5f82c94a4d7fb8f7db661
+  data.tar.gz: 6bc01e9bec29bf52a0910abc465cbee55ca8c17dbd9bee531028d8ade630fa91517b06493c928aecfdd7cccee0bbc88cfeeff6ee143c758aec2e606d2f830367

data/CHANGELOG.md

@@ -4,6 +4,17 @@ 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.0.0 (Fri, 19 Jan 2024)
+
+- Change the instrumentation method to prepend mode.
+
+
+## 1.7.0 (Fri, 15 Jul 2022)
+
+- Added support for analytics.
+- Fixed sequel instrumentation.
+
+
 ## 1.6.2 (Mon, 31 Jan 2022)
 
 - Fixed config environment.

data/Gemfile

@@ -22,42 +22,50 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Tools
-gem 'bootsnap', require: false
 gem 'cucumber', require: false
-gem 'pry'
 gem 'rack-test'
 gem 'rspec', '~> 3'
 gem 'rspec-its'
-gem 'rubocop', require: nil
-gem 'rubocop-performance', require: nil
+gem 'rubocop', require: false
+gem 'rubocop-performance', require: false
 gem 'timecop'
 gem 'webmock'
 
 # Integrations
 gem 'aws-sdk-dynamodb', require: nil
+gem 'aws-sdk-s3', require: nil
 gem 'aws-sdk-sqs', require: nil
+gem 'aws-sdk-sns', require: nil
+gem 'azure-storage-table', require: nil if RUBY_VERSION < '3.0'
+gem 'ecs-logging', require: 'ecs_logging/logger'
 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)
+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'
 gem 'json-schema', require: nil
 gem 'mongo', require: nil
 gem 'opentracing', require: nil
-gem 'rake', 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
 gem 'sidekiq', require: nil
 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_VERSION < '2.5'
+  gem 'loofah', '~> 2.20.0', require: nil
+end
+
 ## Install Framework
 GITHUB_REPOS = {
   'grape' => 'ruby-grape/grape',
@@ -74,9 +82,15 @@ 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'
+  when 'master' # grape
     gem framework, github: GITHUB_REPOS.fetch(framework)
+  when 'main' # sinatra, rails
+    gem framework, github: GITHUB_REPOS.fetch(framework), branch: 'main'
   when /.+/
     gem framework, "~> #{version}.0"
   else
@@ -85,18 +99,40 @@ frameworks_versions.each do |framework, version|
 end
 
 if frameworks_versions.key?('rails')
-  unless frameworks_versions['rails'] =~ /^(master|6)/
+  unless /^(main|6)/.match?(frameworks_versions['rails'])
     gem 'delayed_job', require: nil
   end
 end
 
 if RUBY_PLATFORM == 'java'
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'jdbc-sqlite3'
+  # See issue #6547 in the JRuby repo. It is fixed in JRuby 9.3
+  gem 'i18n', '< 1.8.8' if JRUBY_VERSION < '9.3'
+
+  case rails = frameworks_versions['rails']
+  when 'main'
+    gem 'activerecord-jdbcsqlite3-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', glob: 'activerecord-jdbcsqlite3-adapter/*.gemspec'
+  when ''
+    gem 'activerecord-jdbcsqlite3-adapter', "~> 61.0"
+  when nil
+    gem 'jdbc-sqlite3'
+  else
+    gem 'activerecord-jdbcsqlite3-adapter', "~> #{rails.tr('.', '')}.0"
+  end
 elsif frameworks_versions['rails'] =~ /^(4|5)/
   gem 'sqlite3', '~> 1.3.6'
+elsif RUBY_VERSION < '2.7'
+  gem 'sqlite3', '~> 1.4.4'
 else
-  gem 'sqlite3' # rubocop:disable Bundler/DuplicatedGem
+  gem 'sqlite3'
+end
+
+# 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
+
+if Gem::Version.create(RUBY_VERSION) <= Gem::Version.create('2.5.0')
+  gem 'bigdecimal', '1.3.5'
 end
 
 group :bench do

data/LICENSE

@@ -1,4 +1,4 @@
-All components of this product are Copyright (c) 2022 Atatus. All rights reserved.
+All components of this product are Copyright (c) 2024 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

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'atatus'
   spec.version       = Atatus::VERSION
   spec.authors       = ['Atatus']
-  spec.email         = 'success@atatus.com'
+  spec.email         = ['success@atatus.com']
 
   spec.summary       = 'Atatus Ruby Agent'
   spec.homepage      = 'https://www.atatus.com'
@@ -14,8 +14,7 @@ Gem::Specification.new do |spec|
     'changelog_uri' => 'https://docs.atatus.com/docs/release-notes/ruby.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']
+  spec.license       = 'Apache-2.0'
   spec.required_ruby_version = ">= 2.3.0"
   spec.extra_rdoc_files = [
     "CHANGELOG.md",
@@ -31,6 +30,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/atatus/agent.rb

@@ -137,7 +137,7 @@ module Atatus
     end
 
     def stop
-      debug 'Stopping agent'
+      info 'Stopping agent'
 
       central_config.stop
       metrics.stop
@@ -154,7 +154,6 @@ module Atatus
     # transport
 
     def enqueue(obj)
-      # transport.submit obj
       case obj
       when Atatus::Transaction
         collector.add_txn(obj)
@@ -164,7 +163,7 @@ module Atatus
         collector.add_error(obj)
       when Atatus::Metricset
         collector.add_metrics(obj)
-      end
+      end      
     end
 
     # instrumentation
@@ -231,8 +230,8 @@ module Atatus
     end
     # rubocop:enable Metrics/ParameterLists
 
-    def end_span
-      instrumenter.end_span
+    def end_span(span = nil)
+      instrumenter.end_span(span)
     end
 
     def set_label(key, value)
@@ -247,6 +246,18 @@ module Atatus
       instrumenter.set_user(user)
     end
 
+    def set_company(company)
+      instrumenter.set_company(company)
+    end
+
+    def set_response_body(response_body)
+      instrumenter.set_response_body(response_body)
+    end
+
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      current_span&.set_destination(address: nil, port: nil, service: nil, cloud: nil)
+    end
+
     def build_context(rack_env:, for_type:)
       @context_builder.build(rack_env: rack_env, for_type: for_type)
     end
@@ -296,8 +307,8 @@ module Atatus
     def detect_forking!
       return if @pid == Process.pid
 
-      config.logger.debug "Detected forking,
-        restarting threads in process [PID:#{Process.pid}]"
+      config.logger.debug(
+        "Forked process detected, restarting threads in process [PID:#{Process.pid}]")
 
       central_config.handle_forking!
       collector.handle_forking!

data/lib/atatus/central_config.rb

@@ -19,6 +19,7 @@
 
 require 'atatus/central_config/cache_control'
 
+# rubocop:disable Style/AccessorGrouping
 module Atatus
   # @api private
   class CentralConfig
@@ -27,6 +28,7 @@ module Atatus
     # @api private
     class ResponseError < InternalError
       def initialize(response)
+        super
         @response = response
       end
 
@@ -66,14 +68,15 @@ module Atatus
     def fetch_and_apply_config
       @promise =
         Concurrent::Promise
-        .execute(&method(:fetch_config))
-        .on_success(&method(:handle_success))
-        .rescue(&method(:handle_error))
+        .execute { fetch_config }
+        .on_success { |resp| handle_success(resp) }
+        .rescue { |err| handle_error(err) }
     end
 
     def fetch_config
       resp = perform_request
 
+      # rubocop:disable Lint/DuplicateBranch
       case resp.status
       when 200..299
         resp
@@ -84,6 +87,7 @@ module Atatus
       when 500..599
         raise ServerError, resp
       end
+      # rubocop:enable Lint/DuplicateBranch
     end
 
     def assign(update)
@@ -117,14 +121,14 @@ module Atatus
       end
 
       if resp.status == 304
-        info 'Received 304 Not Modified'
+        debug 'Received 304 Not Modified'
       else
         if resp.body && !resp.body.empty?
           update = JSON.parse(resp.body.to_s)
           assign(update)
         end
 
-        if update && update.any?
+        if update&.any?
           info 'Updated config from Kibana'
           debug 'Modified: %s', update.inspect
           debug 'Modified original options: %s', @modified_options.inspect
@@ -162,11 +166,12 @@ module Atatus
       @server_url ||=
         config.server_url +
         '/config/v1/agents' \
-        "?service.name=#{config.service_name}"
+        "?service.name=#{CGI.escape(config.service_name)}" \
+        "&service.environment=#{CGI.escape(config.environment || '')}"
     end
 
     def headers
-      { 'Etag': @etag }
+      { 'If-None-Match': @etag }
     end
 
     def schedule_next_fetch(resp = nil)
@@ -178,9 +183,15 @@ module Atatus
           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, &method(:fetch_and_apply_config))
+        .execute(seconds) { fetch_and_apply_config }
     end
   end
 end
+# rubocop:enable Style/AccessorGrouping

data/lib/atatus/collector/base.rb

@@ -42,7 +42,12 @@ module Atatus
         @metrics_lock = Mutex.new
         @metrics_agg = []
 
+        @analytics = @config.analytics
+        @analytics_lock = Mutex.new
+        @analytics_agg = []
+
         @hostinfo_response = {}
+        @hostinfo_response["analytics"] = true
         @transport = Atatus::BaseTransport.new(config)
         @collect_counter = 0
         @running = false
@@ -154,6 +159,95 @@ module Atatus
         end
       end
 
+      def add_analytics(txn)
+        analytics_txn = {}
+        analytics_txn[:timestamp] = Util.ms(txn.timestamp).to_i
+        analytics_txn[:txnId] = ""
+        analytics_txn[:txnId] = txn.id if !txn.id.nil?
+        analytics_txn[:traceId] = ""
+        analytics_txn[:traceId] = txn.trace_id if !txn.trace_id.nil?
+        analytics_txn[:name] = txn.name
+        analytics_txn[:duration] = Util.ms(txn.duration)
+
+        if !txn.context.nil?
+          if !txn.context.request.nil?
+            r = txn.context.request
+
+            analytics_txn[:method] = r.method if !r.method.nil?
+
+            if !r.headers.nil?
+              analytics_txn[:requestHeaders] = r.headers
+              analytics_txn[:userAgent] = r.headers['User-Agent'] if r.headers.key?('User-Agent')
+            end
+
+            if !r.body.nil?
+              if !r.body.empty?
+                if r.body != "[SKIPPED]"
+                  analytics_txn[:requestBody] = r.body.to_json
+                end
+              end
+            end
+
+            if !r.url.nil?
+              analytics_txn[:url] = r.url.full
+            end
+
+            if !r.socket.nil?
+              analytics_txn[:ip] = r.socket.remote_addr
+            end
+
+          end
+
+          if
+            defined?(txn.context.response_body) &&
+            !txn.context.response_body.nil?
+          then
+            analytics_txn[:responseBody] = txn.context.response_body
+          end
+
+          if !txn.context.response.nil?
+            if !txn.context.response.headers.nil?
+              analytics_txn[:responseHeaders] = txn.context.response.headers
+            end
+            if !txn.context.response.status_code.nil?
+              analytics_txn[:statusCode] = txn.context.response.status_code.to_i
+            end
+          end
+
+          if
+            defined?(txn.context.custom) &&
+            !txn.context.custom.nil? &&
+            !txn.context.custom.empty?
+          then
+            analytics_txn[:customData] = txn.context.custom
+          end
+
+          if
+            defined?(txn.context.user) &&
+            !txn.context.user.nil? &&
+            !txn.context.user.empty?
+          then
+            analytics_txn[:userId] = txn.context.user.id
+            analytics_txn[:userEmail] = txn.context.user.email
+            analytics_txn[:userName] = txn.context.user.username
+          end
+
+          if
+            defined?(txn.context.company) &&
+            !txn.context.company.nil? &&
+            !txn.context.company.empty?
+          then
+            analytics_txn[:companyId] = txn.context.company.id
+          end
+        end
+
+        @analytics_lock.synchronize do
+          if @analytics_agg.length < 10000
+            @analytics_agg << analytics_txn
+          end
+        end
+      end
+
       def add_span(span)
         ensure_worker_running
 
@@ -377,6 +471,13 @@ module Atatus
             end
           end
 
+          if @hostinfo_response.key?("analytics")
+            if @hostinfo_response["analytics"] == true && @analytics == true
+              if background == false
+                add_analytics txn
+              end
+            end
+          end
         end
       end
 
@@ -420,7 +521,6 @@ module Atatus
         @collect_counter += 1
 
         end_time = (Time.now.to_f * 1000).to_i
-        debug '%s: data collector', pid_str
 
         txns_data = nil
         txn_hist_data = nil
@@ -429,6 +529,7 @@ module Atatus
         error_requests_data = nil
         errors_data = nil
         metrics_data = nil
+        analytics_data = nil
 
         @txns_lock.synchronize do
           txns_data = @txns_agg
@@ -447,6 +548,11 @@ module Atatus
           @error_requests_agg = []
         end
 
+        @analytics_lock.synchronize do
+          analytics_data = @analytics_agg
+          @analytics_agg = []
+        end
+
         @errors_lock.synchronize do
           errors_data = @errors_aggs
           @errors_aggs = []
@@ -473,6 +579,12 @@ module Atatus
         @transport.errors(start_time, end_time, errors_data) unless errors_data.empty?
 
         @transport.metrics(start_time, end_time, metrics_data) unless metrics_data.empty?
+
+        if @hostinfo_response.key?("analytics")
+          if @hostinfo_response["analytics"] == true && @analytics == true
+            @transport.analytics(start_time, end_time, analytics_data) unless analytics_data.empty?
+          end
+        end
       end
     end
   end

data/lib/atatus/collector/builder.rb

@@ -92,6 +92,14 @@ module Atatus
       payload
     end
 
+    def analytics(start_time, end_time, analytics_data)
+      payload = common()
+      payload[:startTime] = start_time
+      payload[:endTime] = end_time
+      payload[:requests] = analytics_data
+      payload
+    end
+
     private
 
     def keyword_field(value)

data/lib/atatus/collector/layer.rb

@@ -33,7 +33,7 @@ module Atatus
       KINDS = {
         'db' => 'Database',
         'cache' => 'Database',
-        'ext' => 'Remote',
+        'external' => 'Remote',
         'websocket' => 'Remote',
         'template' => 'Template'
       }.freeze

data/lib/atatus/collector/transport.rb

@@ -14,6 +14,7 @@ module Atatus
     ERROR_ENDPOINT = "/track/apm/error".freeze
     ERROR_METRIC_ENDPOINT = "/track/apm/error_metric".freeze
     METRIC_ENDPOINT = "/track/apm/metric".freeze
+    ANALYTICS_ENDPOINT = "/track/apm/analytics/txn".freeze
 
     def initialize(config)
       @config = config
@@ -24,6 +25,12 @@ module Atatus
         @notify_host = "https://apm-rx.atatus.com"
       end
 
+      @analytics_notify_host = @config.analytics_notify_host
+      uri = URI(@analytics_notify_host)
+      if not uri.kind_of?(URI::HTTPS) and not uri.kind_of?(URI::HTTP)
+        @analytics_notify_host = "https://an-rx.atatus.com"
+      end
+
       @builder = Atatus::Builder.new(config)
       @headers = {}
       @headers['Content-Type'] = "application/json"
@@ -71,6 +78,11 @@ module Atatus
       post(METRIC_ENDPOINT, payload)
     end
 
+    def analytics(start_time, end_time, analytics_data)
+      payload = @builder.analytics(start_time, end_time, analytics_data)
+      post(ANALYTICS_ENDPOINT, payload)
+    end
+
     private
 
     def post(endpoint, data)
@@ -80,7 +92,12 @@ module Atatus
       end
 
       begin
-        uri = URI(@notify_host + endpoint)
+        notify_host = @notify_host
+        if endpoint == ANALYTICS_ENDPOINT
+          notify_host = @analytics_notify_host
+        end
+
+        uri = URI(notify_host + endpoint)
         uri.query = URI.encode_www_form({"license_key": @config.license_key, "agent_name": AGENT_NAME, "agent_version": VERSION})
 
         request = Net::HTTP::Post.new(uri.request_uri, @headers)
@@ -90,7 +107,7 @@ module Atatus
         http.verify_mode = OpenSSL::SSL::VERIFY_PEER
         response = http.start { |http| http.request(request) }
       rescue SystemCallError, Timeout::Error, EOFError, SocketError => e
-        error format('Atatus transport [%s%s] failed with exception: %s', @notify_host, endpoint, e.message)
+        error format('Atatus transport [%s%s] failed with exception: %s', notify_host, endpoint, e.message)
         return
       end
 
@@ -109,6 +126,10 @@ module Atatus
 
           resp = JSON.parse response.body
           if resp
+            if resp.key?("analytics")
+              @hostinfo_response['analytics'] = resp["analytics"]
+            end
+
             if resp.key?("capturePercentiles")
               @capture_percentiles = resp["capturePercentiles"]
               @hostinfo_response['capturePercentiles'] = @capture_percentiles

data/lib/atatus/{sql_summarizer.rb → config/log_level_map.rb}

@@ -17,37 +17,31 @@
 
 # frozen_string_literal: true
 
-require 'atatus/util/lru_cache'
-
 module Atatus
-  # @api private
-  class SqlSummarizer
-    DEFAULT = 'SQL'
-    TABLE_REGEX = %{["'`]?([A-Za-z0-9_]+)["'`]?}
-
-    REGEXES = {
-      /^BEGIN/iu => 'BEGIN',
-      /^COMMIT/iu => 'COMMIT',
-      /^SELECT .* FROM #{TABLE_REGEX}/iu => 'SELECT FROM ',
-      /^INSERT INTO #{TABLE_REGEX}/iu => 'INSERT INTO ',
-      /^UPDATE #{TABLE_REGEX}/iu => 'UPDATE ',
-      /^DELETE FROM #{TABLE_REGEX}/iu => 'DELETE FROM '
-    }.freeze
+  class Config
+    # @api private
+    class LogLevelMap
+      LEVELS = {
+        debug: Logger::DEBUG,
+        info: Logger::INFO,
+        warn: Logger::WARN,
+        error: Logger::ERROR,
+        fatal: Logger::FATAL,
+        trace: Logger::DEBUG,
+        warning: Logger::WARN,
+        critical: Logger::FATAL,
+        off: Logger::FATAL
+      }.freeze
 
-    FORMAT = '%s%s'
-
-    def self.cache
-      @cache ||= Util::LruCache.new
-    end
+      DEFAULT = Logger::INFO
 
-    def summarize(sql)
-      sql = sql.encode('utf-8', invalid: :replace, undef: :replace)
-      self.class.cache[sql] ||=
-        REGEXES.find do |regex, sig|
-          if (match = sql[0...1000].match(regex))
-            break format(FORMAT, sig, match[1] && match[1].gsub(/["']/, ''))
-          end
-        end || DEFAULT
+      def call(value)
+        if value.is_a?(Integer)
+          LEVELS.value?(value) ? value : DEFAULT
+        else
+          LEVELS.fetch(value.to_sym, DEFAULT)
+        end
+      end
     end
   end
 end

data/lib/atatus/config/options.rb

@@ -38,7 +38,8 @@ module Atatus
           set(value || default)
         end
 
-        attr_reader :key, :value, :default, :type
+        attr_reader :key, :default, :type, :converter
+        attr_accessor :value
 
         def set(value)
           @value = normalize(value)

data/lib/atatus/config/regexp_list.rb

@@ -23,7 +23,7 @@ module Atatus
     class RegexpList
       def call(value)
         value = value.is_a?(String) ? value.split(',') : Array(value)
-        value.map(&Regexp.method(:new))
+        value.map { |p| Regexp.new(p) }
       end
     end
   end