technologic 0.23.4 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94bd4f55e521d94ddef4284aa3926e409f17a40030852ddb5ae18d59a5001893
-  data.tar.gz: 5ceeef0d4e001ede311d9d7ecbcae9b3239f0f8a7a03f300a3effb78850ecfbb
+  metadata.gz: 52a6e844d98ed256add1a8c2c5d11945dd5597c0e644d091131fa915660c4372
+  data.tar.gz: 1940dae0ce9b81276619169b839177318006401e1b06e3ba9f5abb97f2cb97a7
 SHA512:
-  metadata.gz: 6697f86cde981b3cc04ae18653c79c759e599488d19893bc3e70f16453a962ff7c36a73bf618624821664909e07a5047d8479a01bc2ee95a9d8c5ddea80a3467
-  data.tar.gz: 828beb9f4f56a09d32fffe65074d436ada7044a0c6cdf6fa455dedca08a653b85a8df441c28c1a0578b9d38c3d7b69071235f35734e55a5ef258adc57118c7ba
+  metadata.gz: d0a2810468d56201704d74aa896291dfa83a94c4e2d4d991e7dcf54d8f20b3fdc681d770a4c729c0d49fc6a3295813086b3a93e032803acac3a8ade07ad9b29d
+  data.tar.gz: 624da89c51c1598b9ebd657398fb3d8a29c4df474f40f5198193c5d807c4a7f96d25b43af16f7bf7e01d447c9ad5979b47dffcf3c8a913a42055981a90081080

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.4"
+  VERSION = "0.24.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: technologic
 version: !ruby/object:Gem::Version
-  version: 0.23.4
+  version: 0.24.0
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-07-28 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.4
+        version: 0.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.4
+        version: 0.24.0
 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.4
+  documentation_uri: https://www.rubydoc.info/gems/technologic/0.24.0
 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