appydays 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 191701f151a4b25333ee5f6cc1262e70c4d62dc063350bbebd4d00798cb2128e
-  data.tar.gz: 05d188d89e2db3047837f59784773284aa194f9435c2d6f83a8d8bc84b7c06d3
+  metadata.gz: f7233dee300e207e49803a368896ad6b098641db88b703d54860002055609826
+  data.tar.gz: 8c1d7694c1ab1695526676690900f1d5d12facee1adb4b3a823d409af22606a2
 SHA512:
-  metadata.gz: dd5f3a2c5ebfc6d172992e98ed34d6eb33a581b5ef3c55cb0744491cdb22274c9e519af561aba1014dedd68606be9b714e8c7bf5aa9d6deb4b849cbd7115ec1c
-  data.tar.gz: fd5c9afa41fa2d9ededce48760d147339029c29c21e9679e3d58cbf43f544419a95201634c8626413718da52eac91262fead6515361e2fd7017901e355ed5171
+  metadata.gz: b45d24f4ae6769ea2bd3b42b2985c404339d6b74238c33ae15d3413d8b04088137442dc4a62710b9ed8fdc215bc1bc98f2f91c14c6370550034e5a24a2b992f5
+  data.tar.gz: 27ac2dc1b1ee65373c807518df6a4cb0e2038b65f6ccababc20ba89a2b3cc3bd5a1042e06c838f69ebaa054f8c88ef6e4ce42e8e61a2be063aaad61a48989020

data/lib/appydays/loggable/sequel_logger.rb

@@ -45,7 +45,7 @@ class Sequel::Database
       :info,
       proc { args ? "#{message}; #{args.inspect}" : message },
       proc do
-        o = {message: message}
+        o = {message:}
         o[:args] = args unless args.nil?
         ["sequel_log", o]
       end,
@@ -62,7 +62,7 @@ class Sequel::Database
       proc { "(#{'%0.6fs' % duration}) #{message}" },
       proc do
         query = AppydaysLogger.truncate_message(message)
-        params = {duration: duration * 1000, query: query}
+        params = {duration: duration * 1000, query:}
         if query != message
           params[:truncated] = true
           was_truncated = true

data/lib/appydays/loggable/sidekiq_job_logger.rb

@@ -20,7 +20,7 @@ class Appydays::Loggable::SidekiqJobLogger < Sidekiq::JobLogger
 
   Sidekiq.logger = self.logger
 
-  def call(item, _queue, &block)
+  def call(item, _queue, &)
     start = self.now
     tags = {
       job_class: item["class"],
@@ -28,7 +28,7 @@ class Appydays::Loggable::SidekiqJobLogger < Sidekiq::JobLogger
       thread_id: self.tid,
     }
     self.with_log_tags(tags) do
-      self.call_inner(start, &block)
+      self.call_inner(start, &)
     end
   end
 
@@ -43,11 +43,13 @@ class Appydays::Loggable::SidekiqJobLogger < Sidekiq::JobLogger
     yield
     duration = self.elapsed(start)
     log_method = duration >= self.slow_job_seconds ? :warn : :info
-    self.logger.send(log_method, "job_done", duration: duration * 1000)
+    self.logger.send(log_method, "job_done", duration: duration * 1000, **self.class.job_tags)
   rescue StandardError
     # Do not log the error since it is probably a sidekiq retry error
-    self.logger.error("job_fail", duration: self.elapsed(start) * 1000)
+    self.logger.error("job_fail", duration: self.elapsed(start) * 1000, **self.class.job_tags)
     raise
+  ensure
+    self.class.job_tags.clear
   end
 
   protected def elapsed(start)
@@ -58,6 +60,18 @@ class Appydays::Loggable::SidekiqJobLogger < Sidekiq::JobLogger
     return ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
   end
 
+  # Set job tags that get logged out in the "job_done" and "job_fail" messages.
+  # See README for more info.
+  # We do NOT merge the job_tags in with critical errors (death and job_error),
+  # since those will log the job args, and they aren't properly tested right now.
+  # We may add support in the future.
+  def self.set_job_tags(**tags)
+    Thread.current[:appydays_sidekiq_job_logger_job_tags] ||= {}
+    Thread.current[:appydays_sidekiq_job_logger_job_tags].merge!(tags)
+  end
+
+  def self.job_tags = Thread.current[:appydays_sidekiq_job_logger_job_tags] || {}
+
   def self.error_handler(ex, ctx)
     # ctx looks like:
     # {

data/lib/appydays/loggable/spec_helpers.rb

@@ -36,7 +36,7 @@ module Appydays::Loggable::SpecHelpers
     loggers.each { |log| log.level = level }
 
     io = StringIO.new
-    appender = SemanticLogger.add_appender(io: io, level: level)
+    appender = SemanticLogger.add_appender(io:, level:)
     appender.formatter = formatter if formatter
     begin
       yield

data/lib/appydays/loggable.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "semantic_logger"
+require "semantic_logger/formatters/raw"
+require "semantic_logger/formatters/json"
 
 require "appydays/version"
 
@@ -29,6 +31,75 @@ class SemanticLogger::Formatters::Raw
   end
 end
 
+# SemanticLogger Formatter that truncates large strings in the structured log payload.
+# If the emitted JSON log is longer than +max_message_len+:
+# - the payload is walked,
+# - any strings with a length greater than +max_string_len+ are shortened using +shorten_string+.
+#   Override +shorten_string+ for custom behavior.
+# - any key +:stack_trace+ has its array truncated. Stack traces are very large,
+#   but contain short strings. Override +truncate_stack_trace+ for custom behavior.
+class SemanticLogger::Formatters::JsonTrunc < SemanticLogger::Formatters::Raw
+  attr_accessor :max_message_len, :max_string_len
+
+  def initialize(max_message_len: 1024 * 3, max_string_len: 300, **args)
+    super(**args)
+    @max_message_len = max_message_len
+    @max_string_len = max_string_len
+  end
+
+  def truncate_at(max_message_len, max_string_len)
+    @max_message_len = max_message_len
+    @max_string_len = max_string_len
+  end
+
+  def call(log, logger)
+    r = super
+    rj = r.to_json
+    return rj if rj.length <= @max_message_len
+    rshort = self.trim_long_strings(r)
+    return rshort.to_json
+  end
+
+  def trim_long_strings(v)
+    case v
+      when Hash
+        v.each_with_object({}) do |(hk, hv), memo|
+          memo[hk] =
+            if hk == :stack_trace && hv.is_a?(Array)
+              self.truncate_stack_trace(hv)
+            else
+              self.trim_long_strings(hv)
+            end
+        end
+      when Array
+        v.map { |item| self.trim_long_strings(item) }
+      when String
+        if v.size > @max_string_len
+          self.shorten_string(v)
+        else
+          v
+        end
+      else
+        v
+    end
+  end
+
+  # Given a long string, return the truncated string.
+  # @param v [String]
+  # @return [String]
+  def shorten_string(v)
+    return v[..@max_string_len] + "..."
+  end
+
+  # Given a stack trace array, return the array to log.
+  # @param arr [Array]
+  # @return [Array]
+  def truncate_stack_trace(arr)
+    return arr if arr.length <= 4
+    return [arr[0], arr[1], "skipped #{arr.length - 4} frames", arr[-2], arr[-1]]
+  end
+end
+
 ##
 # Helpers for working with structured logging.
 # Use this instead of calling semantic_logger directly.
@@ -94,8 +165,8 @@ module Appydays::Loggable
   end
 
   module Methods
-    def with_log_tags(tags, &block)
-      return SemanticLogger.named_tagged(tags, &block)
+    def with_log_tags(tags, &)
+      return SemanticLogger.named_tagged(tags, &)
     end
   end
 end

data/lib/appydays/spec_helpers.rb

@@ -85,7 +85,7 @@ module Appydays::SpecHelpers
     end
 
     protected def change_tz(t, zone)
-      return t.change(zone: zone) if t.respond_to?(:change)
+      return t.change(zone:) if t.respond_to?(:change)
       prev_tz = ENV.fetch("TZ", nil)
       begin
         ENV["TZ"] = zone

data/lib/appydays/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appydays
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Lithic Tech
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -267,7 +281,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="