appydays 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80170682f5494542ea76d2d6fd4301acbbfd7c5b8388b3d431ae2c7daa7e03d0
-  data.tar.gz: 1dae7bcb7f56835bc39f8562d708fada45e3dd8e555f26246a3165bcd2970ab4
+  metadata.gz: 91b081811b26e7dee2ab9ec7fb8641ef890124d72694a3cfe858ed7f72011afb
+  data.tar.gz: 7cc0dd2e62d643695208f542029c25363a906bb60058fd9fbb47c48f06dc69ee
 SHA512:
-  metadata.gz: 2110baac67b50e765f0b7d2306f71f007d75b89cbc25dde2f5602e25882a1ce01592c94919f1bff6f0093066f30e8983dd73e4b8b420a0ffde94ed301f72e78d
-  data.tar.gz: 98b244ba6540e6a53e437d32278db78e5451f74553924cf2d09df0237e089e44d1ce2922440faf6dc381a85d2ccbbdd415fc1f27dfb73537b9703efe0e012cc4
+  metadata.gz: f39eac94f128c900cb873d1d3a9f486a55b86ff7a38859ef32bb375cd4842cb0fd5fb39544aa172c6cd5b659a9bf6b1dc5d8a120dde08660ef1cea5a83d77aa6
+  data.tar.gz: 1d8ad64ba366d89fd75bf471895a1e16b88fa74346bae806f4a69205fee83be8371dc9f693439e327b53d13263806b60266eac1222244a00370929f43b834e99

data/lib/appydays/loggable/httparty_formatter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+# Formatter that sends structred log information to HTTParty.
+# After requiring this module, use
+# `HTTParty.<method>(..., logger: semantic_logger, log_format: :appydays)`
+# to write out a nice structured log.
+# You can also subclass this formatter to use your own message (default to httparty_request),
+# and modify the fields (override #fields).
+class Appydays::Loggable::HTTPartyFormatter
+  attr_accessor :level, :logger, :message
+  attr_reader :request, :response
+
+  def initialize(logger, level)
+    @logger = logger
+    @level  = level.to_sym
+    @message = "httparty_request"
+  end
+
+  def format(request, response)
+    @request = request
+    @response = response
+    self.logger.public_send(self.level, self.message, **self.fields)
+  end
+
+  def fields
+    return {
+      "content_length" => content_length || "-",
+      "http_method" => http_method,
+      "path" => path,
+      "response_code" => response.code,
+    }
+  end
+
+  def http_method
+    @http_method ||= request.http_method.name.split("::").last.upcase
+  end
+
+  def path
+    @path ||= request.path.to_s
+  end
+
+  def content_length
+    @content_length ||= response.respond_to?(:headers) ? response.headers["Content-Length"] : response["Content-Length"]
+  end
+end
+
+HTTParty::Logger.add_formatter(:appydays, Appydays::Loggable::HTTPartyFormatter)

data/lib/appydays/loggable/sequel_logger.rb

@@ -4,6 +4,32 @@
 require "sequel/database/logging"
 
 class Sequel::Database
+  # Helpers for the Appydays Sequel logger.
+  # Very long messages may end up getting logged; the logger will truncate anything
+  # longer than +truncate_messages_over+, with +truncation_context+ number of chars
+  # at the beginning and at the end.
+  #
+  # If a message is truncated, the full message is logged at +log_full_message_level+ (default :debug).
+  # Use nil to disable the full message logging.
+  module AppydaysLogger
+    class << self
+      attr_accessor :truncate_messages_over, :truncation_message, :truncation_context, :log_full_message_level
+
+      def setdefaults
+        @truncate_messages_over = 2000
+        @truncation_message = "<truncated, full message logged at debug>"
+        @truncation_context = 200
+      end
+
+      def truncate_message(message)
+        return message if message.size <= self.truncate_messages_over
+        msg = message[...self.truncation_context] + self.truncation_message + message[-self.truncation_context..]
+        return msg
+      end
+    end
+  end
+  AppydaysLogger.setdefaults
+
   def log_exception(exception, message)
     level = message.match?(/^SELECT NULL AS "?nil"? FROM .* LIMIT 1$/i) ? :debug : :error
     log_each(
@@ -30,10 +56,25 @@ class Sequel::Database
   # warn level if duration is greater than log_warn_duration.
   def log_duration(duration, message)
     lwd = log_warn_duration
+    was_truncated = false
     log_each(
       lwd && (duration >= lwd) ? :warn : sql_log_level,
       proc { "(#{'%0.6fs' % duration}) #{message}" },
-      proc { ["sequel_query", {duration: duration * 1000, query: message}] },
+      proc do
+        query = AppydaysLogger.truncate_message(message)
+        params = {duration: duration * 1000, query: query}
+        if query != message
+          params[:truncated] = true
+          was_truncated = true
+        end
+        ["sequel_query", params]
+      end,
+    )
+    return unless was_truncated && Sequel::Database::AppydaysLogger.log_full_message_level
+    log_each(
+      Sequel::Database::AppydaysLogger.log_full_message_level,
+      nil,
+      proc { ["sequel_query_debug", {duration: duration * 1000, query: message}] },
     )
   end
 
@@ -41,7 +82,7 @@ class Sequel::Database
     @loggers.each do |logger|
       if logger.is_a?(SemanticLogger::Base)
         logger.public_send(level, *semantic.call)
-      else
+      elsif std
         logger.public_send(level, std.call)
       end
     end

data/lib/appydays/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appydays
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appydays
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Lithic Tech
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: monetize
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: 'appydays provides support for env-based configuration, and common structured
   logging capabilities
 
@@ -218,6 +246,7 @@ files:
 - lib/appydays/configurable.rb
 - lib/appydays/dotenviable.rb
 - lib/appydays/loggable.rb
+- lib/appydays/loggable/httparty_formatter.rb
 - lib/appydays/loggable/request_logger.rb
 - lib/appydays/loggable/sequel_logger.rb
 - lib/appydays/loggable/sidekiq_job_logger.rb