opinionated-metrics 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f358f4ab7a7d418697861f4c1fa40e1db2d29f8
-  data.tar.gz: 34c680435c3da6555381174d16b8e49dcb72d368
+SHA256:
+  metadata.gz: 125809985163fe5f5a5e0abb99e64b96c362f680e63cd0aed5052c12eecb7f11
+  data.tar.gz: 21e293db7ff53f5a2867f17fe2a5f7f6fb42dc731184a32f2787b33c1942e431
 SHA512:
-  metadata.gz: c760761d49da445c13f9684ecf4f826f780d01f9ef5b632ab9ee42552ab6131706a8e76de5c52d4dbb5b5bdf4763cee90ff1e7759b524a3954274132a638e9ba
-  data.tar.gz: be5dd54881a0f45250b5604a1b3aeef72d9355320129e7a933433166e87192ba959185cf3c1744b32e798aad54916f86495d6c82f0637199611c9e6d1caac431
+  metadata.gz: 95883e31abd394627da9f5f76bdb079b62fe36e47c347d507d9d02cf60579336396a8f8df9f03321fa8830ad6482bd4aa6d8a5226537485244500002660cc8b0
+  data.tar.gz: f96c67253bdde4806992c8fd7fa159600fa91bcb3726f00d941acd31d36c7a54d78ffffce71050ad071ad85e180eec181826f4586ba52123cf27a22a8e1b3d85

data/lib/metrics_service.rb

@@ -1,9 +1,21 @@
+# frozen_string_literal: true
+
+##
+# An object with methods for tracking basic, consistent metrics
 class MetricsService
+  ##
+  # Track a basic event; intended for COUNT queries. Outputs `TrackedEvent`
+  #
+  # @param [String] name A name for filtering within WHERE queries
   def self.event(name, **additional_properties)
-    properties = {name: name}.merge(additional_properties)
-    ::NewRelic::Agent.record_custom_event("TrackedEvent", properties)
+    properties = { name: name }.merge(additional_properties)
+    ::NewRelic::Agent.record_custom_event('TrackedEvent', properties)
   end
 
+  ##
+  # Given a name and a block, tracks the milliseconds involved in processing the operation. Outputs `OpDurationMs`
+  #
+  # @param [String] name A name for filtering within WHERE queries
   def self.time_operation(name, **additional_properties)
     raise 'A block is required for time_operation calls' unless block_given?
 
@@ -14,26 +26,46 @@ class MetricsService
     Rails.logger.error("Failed reporting timing to NewRelic: #{e}")
   end
 
+  ##
+  # Given a name and a start/finish time, tracks the milliseconds involved in processing the operation. Outputs `OpDurationMs`
+  #
+  # @param [String] name A name for filtering within WHERE queries
+  # @param [Time] start The start time of the operation
+  # @param [Time] end The end time of the operation
   def self.duration_start_end(name, start, finish, **additional_properties)
     duration(name, (finish - start).seconds, **additional_properties)
   rescue StandardError => e
     Rails.logger.error("Failed reporting duration to NewRelic: #{e}")
   end
 
+  ##
+  # Given a name and a duration, tracks the milliseconds involved in processing the operation. Outputs `OpDurationMs`
+  #
+  # @param [String] name A name for filtering within WHERE queries
+  # @param [Time] start The start time of the operation
+  # @param [Time] end The end time of the operation
   def self.duration(name, duration, **additional_properties)
-    properties = {name: name, duration: duration.in_milliseconds}.merge(additional_properties)
-    ::NewRelic::Agent.record_custom_event("OpDurationMs", properties)
+    properties = { name: name, duration: duration.in_milliseconds }.merge(additional_properties)
+    ::NewRelic::Agent.record_custom_event('OpDurationMs', properties)
   rescue StandardError => e
     Rails.logger.error("Failed reporting duration to NewRelic: #{e}")
   end
 
+  ##
+  # Tracks an exception for error reporting when errors are suppressable for the purpose of HTTP status codes. Outputs `Error`
+  #
+  # @param [String] name A name for filtering within WHERE queries
   def self.exception(name, exception)
     error(name, type: exception.class.name, message: exception&.message)
   end
 
+  ##
+  # Tracks an error for error reporting with arbitrary additional named argument properties. Outputs `Error`
+  #
+  # @param [String] name A name for filtering within WHERE queries
   def self.error(name, **additional_properties)
-    properties = {error_name: name}.merge(additional_properties)
-    ::NewRelic::Agent.record_custom_event("Error", properties)
+    properties = { error_name: name }.merge(additional_properties)
+    ::NewRelic::Agent.record_custom_event('Error', properties)
   rescue StandardError => e
     Rails.logger.error("Failed reporting error to NewRelic: #{e}")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opinionated-metrics
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brian Wyant
@@ -38,7 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple metrics gem built to abstract out metrics provider differences