atatus 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a2777c09d7af196314fb322c9a55feadb46f50d90ffd88976ff978eb5039a2
-  data.tar.gz: 59f1f63ebd4ad84f23359cc2c96ccb62e0c0eabceaa6b48bf63c711c3383bf64
+  metadata.gz: 3b14ce033d2727c9e1773987897f569026bfd7bb45ff3387ab7bed2d8e5dc912
+  data.tar.gz: 7d006a8ccc31f1cbb59d700eae5d7d83760c174e3dd8b0be7fc97e328feff8f0
 SHA512:
-  metadata.gz: 1a705d56af3228c31ce400a16eae3d961fe2bbcae949db3effc4828682563bd4ce3070adb14613cb096caa48d71e8ccce2969dc21f4b0c910c73ca99b28bf566
-  data.tar.gz: 30461593c406cf6f7b8f2e08c9bef4aa64b9f60f0f4c2b3f0bff9de1cff8a26f5cf25e07507b263e8638a37345916f15d479eb11bcb3e58f69a7f34d79d51d70
+  metadata.gz: b8ee79aac253e143ea0867530643b800a226277dd644ca514a2aa07fbc656065f2a316eb3da46a5630e90ae2bb3041f984331453f475a6fa1a5afcccb349f1df
+  data.tar.gz: df8621294a91c15d6afec8ac6fc76aba8f40376deb989b213b7a6cc5c6d8e6b91fb40c517fcb227f8ddfb0cd1c5dfc1e6f14908aa655d7491df0f41a5fa17eea

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.7.0 (Fri, 15 Jul 2022)
+
+- Added support for analytics.
+- Fixed sequel instrumentation.
+
+
 ## 1.6.2 (Mon, 31 Jan 2022)
 
 - Fixed config environment.

data/lib/atatus/agent.rb

@@ -247,6 +247,14 @@ 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 build_context(rack_env:, for_type:)
       @context_builder.build(rack_env: rack_env, for_type: for_type)
     end

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/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/config.rb

@@ -34,7 +34,9 @@ module Atatus
     option :app_name,                          type: :string
     option :license_key,                       type: :string
     option :notify_host,                       type: :string, default: 'https://apm-rx.atatus.com'
+    option :analytics_notify_host,             type: :string, default: 'https://an-rx.atatus.com'
     option :trace_threshold,                   type: :int,    default: 2000
+    option :analytics,                         type: :bool,   default: false
     option :config_file,                       type: :string, default: 'config/atatus.yml'
     option :server_url,                        type: :url,    default: ''
     option :secret_token,                      type: :string
@@ -52,6 +54,7 @@ module Atatus
     option :current_user_email_method,         type: :string, default: 'email'
     option :current_user_id_method,            type: :string, default: 'id'
     option :current_user_username_method,      type: :string, default: 'username'
+    option :current_company_id_method,         type: :string, default: 'id'
     option :custom_key_filters,                type: :list,   default: [],      converter: RegexpList.new
     option :default_labels,                    type: :dict,   default: {}
     option :disable_metrics,                   type: :list,   default: [],      converter: WildcardPatternList.new

data/lib/atatus/context/company.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Atatus
+  class Context
+    # @api private
+    class Company
+      def initialize(id: nil)
+        @id = id
+      end
+
+      def self.infer(config, record)
+        return unless record
+
+        new(
+          id: safe_get(record, config.current_company_id_method)&.to_s
+        )
+      end
+
+      attr_accessor :id
+
+      def empty?
+        !id
+      end
+
+      def any?
+        !empty?
+      end
+
+      class << self
+        private
+
+        def safe_get(record, method_name)
+          record.respond_to?(method_name) ? record.send(method_name) : nil
+        end
+      end
+    end
+  end
+end

data/lib/atatus/context.rb

@@ -22,6 +22,7 @@ require 'atatus/context/request/socket'
 require 'atatus/context/request/url'
 require 'atatus/context/response'
 require 'atatus/context/user'
+require 'atatus/context/company'
 
 module Atatus
   # @api private
@@ -42,6 +43,8 @@ module Atatus
     attr_reader :custom
     attr_reader :labels
     attr_reader :service
+    attr_accessor :company
+    attr_accessor :response_body
 
     # rubocop:disable Metrics/CyclomaticComplexity
     def empty?

data/lib/atatus/instrumenter.rb

@@ -253,6 +253,16 @@ module Atatus
       current_transaction.set_user(user)
     end
 
+    def set_company(company)
+      return unless current_transaction
+      current_transaction.set_company(company)
+    end
+
+    def set_response_body(response_body)
+      return unless current_transaction
+      current_transaction.set_response_body(response_body)
+    end
+
     def inspect
       '<Atatus::Instrumenter ' \
         "current_transaction=#{current_transaction.inspect}" \

data/lib/atatus/metrics.rb

@@ -66,7 +66,6 @@ module Atatus
           timeout_interval: TIMEOUT_INTERVAL
         ) do
           begin
-            debug 'Collecting metrics'
             collect_and_send
             true
           rescue StandardError => e

data/lib/atatus/spies/sequel.rb

@@ -28,59 +28,60 @@ module Atatus
       ACTION = 'query'
 
       def self.summarizer
-        @summarizer ||= Sql.summarizer
+        @summarizer ||= Sql::Signature::Summarizer.new
       end
 
-      def install
-        require 'sequel/database/logging'
-
-        if defined?(::Sequel) && defined?(::Sequel::Database)
-
-          ::Sequel::Database.class_eval do
-            alias log_connection_yield_without_apm log_connection_yield
-
-            def log_connection_yield(sql, connection, args = nil, &block)
-              unless Atatus.current_transaction
-                return log_connection_yield_without_apm(
-                  sql, connection, args, &block
-                )
-              end
+      # @api private
+      module Ext
+        # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+        def log_connection_yield(sql, connection, args = nil, &block)
+          unless Atatus.current_transaction
+            return super(sql, connection, args, &block)
+          end
 
-              subtype = database_type.to_s
+          subtype = database_type.to_s
 
-              name =
-                Atatus::Spies::SequelSpy.summarizer.summarize sql
+          name =
+            Atatus::Spies::SequelSpy.summarizer.summarize sql
 
-              context = Atatus::Span::Context.new(
-                db: { statement: sql, type: 'sql', user: opts[:user] },
-                destination: { name: subtype, resource: subtype, type: TYPE }
-              )
+          context = Atatus::Span::Context.new(
+            db: { statement: sql, type: 'sql', user: opts[:user] },
+            destination: { service: { resource: subtype } }
+          )
 
-              span = Atatus.start_span(
-                name,
-                TYPE,
-                subtype: subtype,
-                action: ACTION,
-                context: context
-              )
-              yield.tap do |result|
-                if name =~ /^(UPDATE|DELETE)/
-                  if connection.respond_to?(:changes)
-                    span.context.db.rows_affected = connection.changes
-                  elsif result.is_a?(Integer)
-                    span.context.db.rows_affected = result
-                  end
-                end
+          span = Atatus.start_span(
+            name,
+            TYPE,
+            subtype: subtype,
+            action: ACTION,
+            context: context
+          )
+          super(sql, connection, args, &block).tap do |result|
+            if /^(UPDATE|DELETE)/.match?(name)
+              if connection.respond_to?(:changes)
+                span.context.db.rows_affected = connection.changes
+              elsif result.is_a?(Integer)
+                span.context.db.rows_affected = result
               end
-            ensure
-              Atatus.end_span
             end
           end
-
+        rescue
+          span&.outcome = Span::Outcome::FAILURE
+          raise
+        ensure
+          span&.outcome ||= Span::Outcome::SUCCESS
+          Atatus.end_span
         end
+        # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+      end
+
+      def install
+        require 'sequel/database/logging'
+
+        ::Sequel::Database.prepend(Ext)
       end
     end
 
     register 'Sequel', 'sequel', SequelSpy.new
   end
-end
+end

data/lib/atatus/transaction.rb

@@ -148,6 +148,14 @@ module Atatus
       context.user = Context::User.infer(@config, user)
     end
 
+    def set_company(company)
+      context.company = Context::Company.infer(@config, company)
+    end
+
+    def set_response_body(response_body)
+      context.response_body = response_body
+    end
+
     def inspect
       "<Atatus::Transaction id:#{id}" \
         " name:#{name.inspect} type:#{type.inspect}>"

data/lib/atatus/version.rb

@@ -19,5 +19,5 @@
 
 module Atatus
   AGENT_NAME = 'Ruby'
-  VERSION = '1.6.2'
+  VERSION = '1.7.0'
 end

data/lib/atatus.rb

@@ -376,6 +376,22 @@ module Atatus
       agent&.set_user(user)
     end
 
+    # Provide a company to the current transaction
+    #
+    # @param company [Object] An object representing a company
+    # @return [Object] Given company
+    def set_company(company)
+      agent&.set_company(company)
+    end
+
+    # Provide the response body to the current transaction
+    #
+    # @param response_body [String] A string containing the response body
+    # @return [String] Given response body
+    def set_response_body(response_body)
+      agent&.set_response_body(response_body.to_s)
+    end
+
     # Provide a filter to transform payloads before sending them off
     #
     # @param key [Symbol] Unique filter key

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atatus
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Atatus
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -74,6 +74,7 @@ files:
 - lib/atatus/config/regexp_list.rb
 - lib/atatus/config/wildcard_pattern_list.rb
 - lib/atatus/context.rb
+- lib/atatus/context/company.rb
 - lib/atatus/context/request.rb
 - lib/atatus/context/request/socket.rb
 - lib/atatus/context/request/url.rb