technologic 0.23.8 → 0.25.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27e46a1e94a51aaabbbd362368d96d3682bdca681e255a26b4978a0c66b4ad67
-  data.tar.gz: 95d009c3dfdeecf5eaf5d818663643b40b94f805db9363fad8eff9693b897f63
+  metadata.gz: 2fac527e781d749fb20e815bfc288adc1e22a40297e80a75805e1632442886c0
+  data.tar.gz: 9a4244bdafac62e23eb0019e1d85b1d892641191faf80c780cf70610b2a88790
 SHA512:
-  metadata.gz: 3780668c0537e015849f5e0d57d66da3873dc647973994f7e1a5d9697136cbcd6dcc5f6a9f9f1c015a9498d8d4e4796b315ea9928f406167970301721ab06ac4
-  data.tar.gz: b456592170d1411b1739ffd5ad186634d82596e4716caa7388a13f54d681ae264d1fd6c4e7bb3c22d5641b1a478c248bf9e979fa5f20accd0d6e7cbe902f44e4
+  metadata.gz: 16d11b6464725b8a451c7633853c2c7e3d74e51ddf4b10504fc9071567101737e0b77d0441378be164a6ed297b055dbcdddda3757ceb899eda3a0dba74060dd8
+  data.tar.gz: a958d41ac5d074e01560decd34c1f3f66fb4ededba5baa4c9b60ffec516e6ad3e63ffe066bdd02248cbd13dac07e2a1097c7ec28bbb931fa7655bf256829565d

data/README.md

@@ -53,6 +53,40 @@ error :email_for_user_does_not_exist, user_id: @user.email
 fatal :it_is_going_to_be_a_long_day, need_to_know: info_dump
 ```
 
+If given a block, these methods will include the runtime duration of the given block after the code is evaluated:
+```ruby
+info :something_happening_in_here, extra_data: "I really need this data" do
+  sleep 0.5
+  puts "Important things happening here!"
+end
+
+# Results in:
+
+Important things happening here!
+{"extra_data":"I really need this data","event":"something_happening_in_here.Object","duration":503.745,"@timestamp":"2020-07-27T20:05:06.355-04:00","@version":"1","severity":"INFO","host":"localhost"}
+```
+
+### Configuration
+
+_TODO: Improve me_
+
+* `log_duration_in_ms` - Boolean; default: false
+  
+  By default, Technologic will log duration as a float in seconds. To log duration as milliseconds instead, set it in your application config:
+    
+  ```ruby
+  # Rails app - in application.rb
+  Rails.application.configure do |config|
+    ...
+    technologic.log_duration_in_ms = true
+  end
+  
+  # For a plain ol' Ruby app with no Railties:
+  Technologic::ConfigOptions.log_duration_in_ms = true
+  ```
+  
+  **NOTE:** In a future version of Technologic, the default will change from `false` to `true`
+
 ## Development
 
 Consult Spicerack's [development instructions](../README.md#development) for more info.

data/lib/technologic/config_options.rb

@@ -2,6 +2,8 @@
 
 module Technologic
   class ConfigOptions
+    include AroundTheWorld
+
     class_attribute :enabled, default: true
 
     class_attribute :subscribe_to_fatal, default: true
@@ -15,5 +17,22 @@ module Technologic
     class_attribute :log_warn_events, default: true
     class_attribute :log_info_events, default: true
     class_attribute :log_debug_events, default: true
+
+    class_attribute :log_duration_in_ms, default: false
+
+    # TODO: Remove with duration-as-seconds deprecation
+    class << self
+      around_method :log_duration_in_ms= do |*args|
+        super(*args).tap do
+          @_log_duration_in_ms_set_explicitly = true
+        end
+      end
+
+      private
+
+      def log_duration_in_ms_set_explicitly?
+        !!@_log_duration_in_ms_set_explicitly
+      end
+    end
   end
 end

data/lib/technologic/event.rb

@@ -4,6 +4,8 @@ module Technologic
   class Event
     include ShortCircuIt
 
+    LOGGABLE_DURATION_THRESHOLD_MS = 0.04
+
     attr_reader :name, :duration
 
     def initialize(name, started, finished, payload)
@@ -13,10 +15,12 @@ module Technologic
     end
 
     def data
+      duration_in_ms = duration * 1000
+
       {}.tap do |hash|
         hash.merge!(@payload)
         hash[:event] = name
-        hash[:duration] = duration if duration.round > 0
+        hash[:duration] = ConfigOptions.log_duration_in_ms ? duration_in_ms : duration if duration_in_ms > LOGGABLE_DURATION_THRESHOLD_MS
       end
     end
     memoize :data

data/lib/technologic/setup.rb

@@ -8,6 +8,7 @@ module Technologic
 
         setup_subscribers(technologic_config)
         setup_loggers(technologic_config)
+        warn_duration_unit_not_set(technologic_config)
       end
 
       private
@@ -27,6 +28,12 @@ module Technologic
         Technologic::InfoSubscriber.on_event { |e| Technologic::Logger.log(:info, e) } if config.log_info_events
         Technologic::DebugSubscriber.on_event { |e| Technologic::Logger.log(:debug, e) } if config.log_debug_events
       end
+
+      def warn_duration_unit_not_set(config)
+        return if config.__send__(:log_duration_in_ms_set_explicitly?)
+
+        warn "WARNING: Technologic.log_duration_in_ms is not set. In a future version of Technologic, the default value will change from false to true. To maintain existing behavior, set `application.config.technologic.log_duration_in_ms = false` explicitly."
+      end
     end
   end
 end

data/lib/technologic/version.rb

@@ -2,5 +2,5 @@
 
 module Technologic
   # This constant is managed by spicerack
-  VERSION = "0.23.8"
+  VERSION = "0.25.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: technologic
 version: !ruby/object:Gem::Version
-  version: 0.23.8
+  version: 0.25.3
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.8
+        version: 0.25.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.8
+        version: 0.25.3
 description: A clean and terse way to produce standardized, highly actionable, and
   data-rich logs
 email:
@@ -87,7 +87,7 @@ metadata:
   homepage_uri: https://github.com/Freshly/spicerack/tree/master/technologic
   source_code_uri: https://github.com/Freshly/spicerack/tree/master/technologic
   changelog_uri: https://github.com/Freshly/spicerack/blob/master/technologic/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/technologic/0.23.8
+  documentation_uri: https://www.rubydoc.info/gems/technologic/0.25.3
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Logging system built on an extensible event triggering system requiring minimal