semantic_logger_ecs_addon 0.1.0 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d56d0ab9e926ca66fd4889271eb4b5157b41b2b6719b6fc22ebf2acd29745eb
-  data.tar.gz: 518de9e56bd832649fdf2cda28da0a0453461bafa2895ac9cf4169058625d817
+  metadata.gz: ce4015b55b1cb91fd4cb92b6e8e1000a3516128fecf4070988f69dfcbe8cd44a
+  data.tar.gz: '0849c201922f70ad1f7cef19354a648d10b433352f9d3737eb5ac15c3424e651'
 SHA512:
-  metadata.gz: ca8f68e438c4f018e1205b513455120f8b8cefbe311b980614e4a7f739672391362b58203d99696b4d51a21e80f726488ffcb6d03893ec277822fd0caa00e47a
-  data.tar.gz: 30f219878394f83e632e222241a23323cb090323faafe86a0dccb0d430ad7cc4cea95cd942db3070e892b5765f911f6bd4f53893b66a64b992fd97124420f1a4
+  metadata.gz: a6a62ae9c3e5a4971c60d079bd311efa1a0c2f62a2ca3a52d7fe3ee342a4eac0da8f35a6c748af7c0ab51b692656ed96db79917bceea2afd951da3852bc50120
+  data.tar.gz: fe6ce8a9344ed8242fc1bbc0a604df8a94bc1ffe53de6359b9913acba44c990fe4690c30e21282248d4622b6b3c40b2b9bf77086210e768298b1fe9117c54c4a

data/lib/rails_semantic_logger/sequel/log_subscriber.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+if defined?(Sequel) && defined? ActiveSupport::LogSubscriber
+  module RailsSemanticLogger
+    module Sequel
+      class LogSubscriber < ActiveSupport::LogSubscriber
+        class << self
+          attr_reader :logger
+        end
+
+        def self.runtime= value
+          # ::ActiveRecord::RuntimeRegistry.sql_runtime = value
+          RequestStore.store[:sql_runtime] = value
+        end
+
+        def self.runtime
+          # ::ActiveRecord::RuntimeRegistry.sql_runtime ||= 0
+          RequestStore.fetch(:sql_runtime) { 0 }
+        end
+
+        def self.count= value
+          RequestStore.store[:sql_count] = value
+        end
+
+        def self.count
+          RequestStore.fetch(:sql_count) { 0 }
+        end
+
+        def self.reset_runtime
+          previous = runtime
+          self.runtime = 0
+          previous
+        end
+
+        def self.reset_count
+          previous = count
+          self.count = 0
+          previous
+        end
+
+        def sql event
+          self.class.runtime += event.duration
+          self.class.count += 1
+          return unless logger.debug?
+
+          payload = event.payload
+          name = payload[:name]
+
+          log_payload = {sql: payload[:sql].squeeze(" ")}
+          log_payload[:binds] = bind_values payload unless (payload[:binds] || []).empty?
+          log_payload[:allocations] = event.allocations if event.respond_to? :allocations
+          log_payload[:cached] = event.payload[:cached]
+
+          log = {message: name, payload: log_payload, duration: event.duration}
+
+          # Log the location of the query itself.
+          if logger.send(:level_index) >= SemanticLogger.backtrace_level_index
+            log[:backtrace] = SemanticLogger::Utils.strip_backtrace caller
+          end
+
+          logger.debug log
+        end
+
+        private
+
+        @logger = SemanticLogger["Sequel"]
+
+        # When multiple values are received for a single bound field, it is converted into an array
+        def add_bind_value binds, key, value
+          key = key.downcase.to_sym unless key.nil?
+          value = (Array(binds[key]) << value) if binds.key? key
+          binds[key] = value
+        end
+
+        def logger
+          self.class.logger
+        end
+
+        def bind_values payload
+          binds = {}
+          binds = "  " + payload[:binds].map { |col, v| [col.name, v] }
+                                        .inspect
+          payload[:binds].each { |col, value| add_bind_value binds, col.name, value }
+          binds
+        end
+      end
+    end
+  end
+
+  RailsSemanticLogger::Sequel::LogSubscriber.attach_to :sequel
+end

data/lib/semantic_logger_ecs_addon/formatters/base.rb

@@ -145,7 +145,9 @@ module SemanticLoggerEcsAddon
       end
 
       def rack_metrics
-        metrics_keys = formatted_payload.keys.select { |k| k.to_s.end_with?("_runtime") }
+        metrics_keys = formatted_payload.keys.select do |k|
+          k.to_s.end_with? "_runtime", "_count"
+        end
         formatted_payload[:metrics].merge! formatted_payload.extract!(:allocations, *metrics_keys)
         formatted_payload[:metrics][:object_allocations] =
           formatted_payload[:metrics].delete :allocations
@@ -162,11 +164,13 @@ module SemanticLoggerEcsAddon
       end
 
       def format_payload
-        return unless log.payload.respond_to?(:empty?) && !log.payload.empty?
-
-        self.formatted_payload = Utils::Hash[**log.payload]
+        if log.payload.respond_to?(:empty?) && !log.payload.empty?
+          self.formatted_payload = Utils::Hash[**log.payload]
 
-        rack_extract
+          rack_extract
+        else
+          self.formatted_payload = {}
+        end
       end
 
       def request

data/lib/semantic_logger_ecs_addon/identity.rb

@@ -5,8 +5,8 @@ module SemanticLoggerEcsAddon
   module Identity
     NAME = "semantic_logger_ecs_addon"
     LABEL = "Semantic Logger Ecs Addon"
-    VERSION = "0.1.0"
+    VERSION = "0.1.7"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
-    SUMMARY = "A semantic logger formatter that formats the logs according to Elastic Common Schema and adds APM trace data if ElasticAPM is enabled."
+    SUMMARY = "A semantic logger formatter that formats the logs according to Elastic Common Schema, adds APM trace data if ElasticAPM is enabled and instruments sequel logs for rails if available."
   end
 end

data/lib/semantic_logger_ecs_addon.rb

@@ -2,6 +2,13 @@
 
 require "pathname"
 require "zeitwerk"
+if defined?(Sequel)
+  if defined? ActiveSupport::LogSubscriber
+    require_relative "rails_semantic_logger/sequel/log_subscriber"
+  end
+  require_relative "sequel/database" if defined?(ActiveSupport::Notifications)
+  require_relative "sequel/railties/controller_runtime" if defined?(ActionController)
+end
 
 loader = Zeitwerk::Loader.for_gem
 loader.setup

data/lib/sequel/database.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+if defined?(Sequel) && defined?(ActiveSupport::Notifications)
+  require "sequel/database/logging"
+
+  module Sequel
+    class Database
+      def log_connection_yield sql, conn, args = nil
+        log_connection_info = (connection_info conn if conn && log_connection_info)
+        log_args = ("; #{args.inspect}" if args)
+        sql_for_log = "#{log_connection_info}#{sql}#{log_args}"
+        start = Time.now
+        begin
+          ::ActiveSupport::Notifications.instrument(
+            "sql.sequel",
+            sql: sql,
+            name: self.class,
+            binds: args
+          ) do
+            yield
+          end
+        rescue StandardError => error
+          log_exception error, sql_for_log unless @loggers.empty?
+          raise
+        ensure
+          log_duration Time.now - start, sql_for_log unless error || @loggers.empty?
+        end
+      end
+
+      def log_yield sql, args = nil, &block
+        log_connection_yield(sql, nil, args, &block)
+      end
+    end
+  end
+end

data/lib/sequel/railties/controller_runtime.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+if defined?(Sequel) && defined?(ActionController)
+  require "active_support/core_ext/module/attr_internal"
+  unless defined?(RailsSemanticLogger::Sequel::LogSubscriber)
+    require_relative "../../rails_semantic_logger/sequel/log_subscriber"
+  end
+
+  module Sequel
+    module Railties
+      module ControllerRuntime
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def log_process_action payload
+            messages = super
+            db_runtime = payload[:db_runtime]
+            db_query_count = payload[:db_query_count]
+            if db_runtime && db_query_count
+              messages << (format "Sequel: %.1fms & %d queries", db_runtime.to_f, db_query_count)
+            end
+            messages
+          end
+        end
+
+        private
+
+        attr_internal :db_runtime, :db_query_count
+
+        def process_action action, *args
+          # We also need to reset the runtime before each action
+          # because of queries in middleware or in cases we are streaming
+          # and it won't be cleaned up by the method below.
+          RailsSemanticLogger::Sequel::LogSubscriber.reset_runtime
+          RailsSemanticLogger::Sequel::LogSubscriber.reset_count
+          super
+        end
+
+        def cleanup_view_runtime
+          if logger && logger.info?
+            db_rt_before_render = RailsSemanticLogger::Sequel::LogSubscriber.reset_runtime
+            self.db_runtime = (db_runtime || 0) + db_rt_before_render
+            runtime = super
+            db_rt_after_render = RailsSemanticLogger::Sequel::LogSubscriber.reset_runtime
+            self.db_runtime += db_rt_after_render
+            runtime - db_rt_after_render
+          else
+            super
+          end
+        end
+
+        def append_info_to_payload payload
+          super
+          payload[:db_runtime] =
+            (db_runtime || 0) + RailsSemanticLogger::Sequel::LogSubscriber.reset_runtime
+          payload[:db_query_count] =
+            (db_query_count || 0) + RailsSemanticLogger::Sequel::LogSubscriber.reset_count
+        end
+      end
+    end
+  end
+
+  ActionController::Base.include Sequel::Railties::ControllerRuntime
+  ActionController::API.include Sequel::Railties::ControllerRuntime
+end

data.tar.gz.sig

@@ -1 +1,4 @@
-��=3�D�od��q&|}!������UE��d��"��0��}�J�ۮNg����{�P��GL���"���C<aB�{X����:��V�n`���g>�������O�'�\�H�`�O���$����G�i�<�;�8�-�m&�B9�`.+�p	BNl�,�&���\��*���WfvI%���\����k�D愕ւo�d���@�B�P
+<P�,JtI����=�#�@P������ڄ_P] �uc�D��G��X��;eq`�t��۝Huawq�KW��	�,��Fv6�U�ۛ�n�;8�x
+E"x��q��T�z��5	���I]B:J�H�p��;]�%���DG1��gޗ`3|��I����t�m&7�]XH���T��pq:r�#��8�R"S��<��A���zn}[��W�*���!���$&�scyһmq�vWݨ�͋Ψ|�@n��Rm,.��
+gG�
B���O�F"�cn��+sɼ3u\`2A�`KÀ&P�4�.R�
+�	�]|㹨�y��}��D��}�=�9���R:#��)�O�����yc-lN��yA�ϑ��a��

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger_ecs_addon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.7
 platform: ruby
 authors:
 - Sajeev Ramasamy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIERDCCAqygAwIBAgIBATANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDDBt0aG9y
-  aW9uMzAwNi9EQz1nbWFpbC9EQz1jb20wHhcNMjEwNjA4MTAyMzI4WhcNMjIwNjA4
-  MTAyMzI4WjAmMSQwIgYDVQQDDBt0aG9yaW9uMzAwNi9EQz1nbWFpbC9EQz1jb20w
-  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC1entXzzkGYW4W906xYuTr
-  6SQWJXxjPo3GrsWk2L+KXMkY94d1MyJN9IJ0LEy6M7onkmpYSzFqBQ8W+8VRaW0y
-  HVLX1EQRZ9hVd0LV9j5tNx2pDUfXzoxeyNllBd64Ne7r/6D93lAErATC/+v9X6QC
-  cHd17QBGWU8Qb0ePkYY1UvImbePdgLRwu6F2KrUPyn3ewoAvBxsAG74XU6SbORQ2
-  7Hhfh9vvRAcgboXmbyPW+6Z6KN7YdBFnAwI7r/9M9cMRhWwpprTPwKNdAMR0wl+l
-  Bdp7Se7x8fxriTl9TTpgMScGdXIc/m2Pj48W+cnk5Wf2xlcrzXptX3UYelF8f7j3
-  R/Ft2OTSvG0jdYW50mGD96Om0WKM6Ggfx0Dz6pvComl2LNajTSYpHB0xj8d1L6QX
-  UQ2kcIERhnVMqriZauA21b2J9ZLxFf+Ddou7V2AiLMlFi9cPxgj4eHrHLiOylC29
-  sBztOdq1mbfofNe5ifothYpj/uMKYEdXRjlKXUITCFcCAwEAAaN9MHswCQYDVR0T
-  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFP9FcvZBAdqH9D6ECTtDk6GsVUYL
+  aW9uMzAwNi9EQz1nbWFpbC9EQz1jb20wHhcNMjEwODIzMTIxMzE2WhcNMjIwODIz
+  MTIxMzE2WjAmMSQwIgYDVQQDDBt0aG9yaW9uMzAwNi9EQz1nbWFpbC9EQz1jb20w
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC82tKwQZ/1Lr/8zSDcxJlI
+  4+bjQ/Q7Em96Bu3bwkwJWFhCTWPAaktyjNlM/8IpSdkiVVsn4RyFYU/jua0U4Yeg
+  kzCXKONxDMZK92z5LoNMCEC6f7d5ZVHMIf/1XoLU181Spd39bkfqqwxWJyGojERv
+  AUHmMm4kOniHMjIn+NMY81NXdf2HM84H1SCV6FKjvfZb7vQOEkkjDN4TI2gOnW63
+  QRPNzlJ9QO3FVf1G/YEVHgWcrsio/ivf/KT0NNUzktN/uk/a+cEjyENWtTNGGLv/
+  o7xSoPP9o/pjnLfKhk44F6R9efoG1CVTa3n71Q+KgrOfLhfYBeIC0HjdcB91RXw1
+  fO9+2/aeecHhlqJZOmAMhOHT+aruuNvyyh74YBr1Gw1It7b1rSvnIoCcPt6k7TVK
+  lYSpQyp66AnSITEDUyBmhKhEp4LQFqalaiTXD7NfxmOjV9obV9qUgbwq5GQZjzsE
+  wIhEbAt2EiPLBQn7rzEjzeezE4hs2w55atwguyfxNrkCAwEAAaN9MHswCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJTGpSljUdzxn3EOCDgPFO2QmTsu
   MCAGA1UdEQQZMBeBFXRob3Jpb24zMDA2QGdtYWlsLmNvbTAgBgNVHRIEGTAXgRV0
-  aG9yaW9uMzAwNkBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQADggGBAK0XGR9ezspt
-  S4Dy1PZ0FeGQXjtUkXcEgY6a/BnJGie9PnHRQZx4fHeVWLH3cDTsy860rTp7tmmw
-  Q/5NIM05AfHabnA/HVqNj/jQt1+EpQS2DGIRNiVtD+Mk/NEyggb4nvg1AJa++IpS
-  XmIAlpJdGwDAsLAv8JlKVbH252QFYVNVTBaikFAQ70GOxL2PnnVPl+GrC23DCpVs
-  eDXVMLZlUe40RTL3Ru6mEMXASB6byp4PwQ7eCaoAUlGQwvdvW09ai0jRI4zqgsAi
-  sSKEjVZRRZcr6wP+zvDReTG5FSVOag1G5g0SivvltgjWqDy2EmY41Qp08jtLu+iQ
-  m3Fy3/MP/izFtIvuQAJaZH+1l83GFI//m8V53ZH7Gg+1VFPlXXmpGQIMR9yZSDBe
-  ewungQjw99puFMSK2d/NFj2L2oSvamT0vGoiH63zwx02vLziB6Jbn34/tuDEqUQ9
-  WEUeG6yA2jP44YUZzNP+Xbjpzr/RvJxAmFw+7SNkHkmP3csIS+0TIg==
+  aG9yaW9uMzAwNkBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQADggGBALGLP4+FXfd1
+  7+1Tlrd477uRIBjbGg7D/7g04xYVNjOMNGI7gUHbi1rlQ6TDg72EBefcnfsBe/IC
+  Wr5NxA/nhZl8ulMIWkypyk6tgq4wMe9I8umE83A8960vG6GSf12AuAfdZ5pQGz0V
+  tKGUKqED9Yzsmayw+DZgUi1KSezmGdz2Y3BW6DBrNx8qHXUjgPwDnyzdPHTOPqly
+  dxZBuseVz7147l9amCG1fopHUpEkPSYznbOaKPyLCdSxfaKu9dwZQ1uF9DTIKGg6
+  16+iw7FZcVbyjw1KQTkYxPOaQcxwNCKQ+yVeICli6NoOinyzO4+onRG8fLOyREaW
+  NGxVhaV01YqK1z7lZZoAuVWqbE1NMIO//5tvWC9slgKmWyuCc5YQCT3w+3sA4y82
+  vYrYpx2LhW5Xd0nPdr4aI+5BUqGdI7Ypl3BqNHZljUUlieiWu7rU0MhIZgQ1lIMa
+  pQreMxz5itbb+2KmpdBlkm8nuRoFv0jrL5LR+7+UBRknGsHXaEQQcQ==
   -----END CERTIFICATE-----
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: semantic_logger
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +78,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
-description: 
+description:
 email:
 - thorion3006@gmail.com
 executables: []
@@ -75,6 +89,7 @@ extra_rdoc_files:
 files:
 - LICENSE.md
 - README.md
+- lib/rails_semantic_logger/sequel/log_subscriber.rb
 - lib/semantic_logger_ecs_addon.rb
 - lib/semantic_logger_ecs_addon/formatters/base.rb
 - lib/semantic_logger_ecs_addon/formatters/json.rb
@@ -82,6 +97,8 @@ files:
 - lib/semantic_logger_ecs_addon/identity.rb
 - lib/semantic_logger_ecs_addon/utils/backtrace_cleaner.rb
 - lib/semantic_logger_ecs_addon/utils/hash.rb
+- lib/sequel/database.rb
+- lib/sequel/railties/controller_runtime.rb
 homepage: https://github.com/thorion3006/semantic_logger_ecs_addon
 licenses:
 - MIT
@@ -90,7 +107,7 @@ metadata:
   changelog_uri: https://github.com/thorion3006/semantic_logger_ecs_addon/blob/master/CHANGES.md
   documentation_uri: https://github.com/thorion3006/semantic_logger_ecs_addon
   source_code_uri: https://github.com/thorion3006/semantic_logger_ecs_addon
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,9 +125,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: A semantic logger formatter that formats the logs according to Elastic Common
-  Schema and adds APM trace data if ElasticAPM is enabled.
+  Schema, adds APM trace data if ElasticAPM is enabled and instruments sequel logs
+  for rails if available.
 test_files: []