nexaas-auditor 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9346148a901d3522638421724dc138eb776fd1a
-  data.tar.gz: fa44e097369d0fe7217d6310773a1724efe5de1e
+  metadata.gz: 41aa4aade90e929f1017124ecc8dc919dbdf8009
+  data.tar.gz: 140f0375f99bf74b7066dee4d4f7c7476c867f2c
 SHA512:
-  metadata.gz: e66ad047a111d655e416bac410f17f01f530a133257dc2dfedc0b3e572727b5aeb6d0d9fed7a2d47d9b93c5d2be88f7a8d1775be0f2d2aa29148260aaa83bdbd
-  data.tar.gz: 555203f20ed7b5e799aea8f2cbf8d235a420dd1c7e8c7f4983009bf84f5b49decf86340fbb0ac4dd91f5ef34d574ca1574e34636c7ce91a3c453f523b0adffc9
+  metadata.gz: e04fd39437da7fe52f8b1da3eea32fc8fe09e2b284926a5e650fafd4cc4ed15422e34dffda5a46de83c6d0172b7ada47cdba70fc83636a7d678c310a2cf0d53c
+  data.tar.gz: f0902b3f3775e410f6572efeaa46b5707f6ed66c8e9e7e84379bca4ae8de49dc5990f8e0486e3df7b21fc6ae64b9910208981cdb0e7bf571c20573bf6c5a49b1

data/README.md

@@ -10,7 +10,7 @@ This has been tested with Rails 4.2.x only so far. It probably works fine as wel
 
 The audit log is created in a [logfmt](https://www.brandur.org/logfmt) format only for now. Support for more log formats is planned in the future.
 
-Both the audit log and statistics tracking assume all instrumented events are named in a dot notation format, for example you could use `'app.users.login.sucess'` to instrument a successful user login event. The `'app.'` prefix is a suggestion to separate your bussiness-logic events from framework-specific (Rails) events, which will always have a `'rails.'` prefix, for example `'rails.action_controller.runtime.total'` for example.
+Both the audit log and statistics tracking assume all instrumented events are named in a dot notation format, for example you could use `'app.users.login.sucess'` to instrument a successful user login event. The `'app.'` prefix is a suggestion to separate your business-logic events from framework-specific (Rails) events, which will always have a `'rails.'` prefix, for example `'rails.action_controller.runtime.total'` for example.
 
 ## Installation
 
@@ -43,10 +43,10 @@ Nexaas::Auditor.configure do |config|
   config.enabled = true
   config.logger = Rails.logger
 
-  # use audit logging for bussiness-logic instrumented events
+  # use audit logging for business-logic instrumented events
   config.log_app_events = true
 
-  # use statistics tracking for bussiness-logic instrumented events
+  # use statistics tracking for business-logic instrumented events
   config.track_app_events = true
 
   # use statistics tracking for default Rails instrumented events
@@ -74,12 +74,12 @@ end
 Nexaas::Auditor.subscribe_all
 ```
 
-Then, create your loggers and statistic trackers in `app/loggers/` and `app/statistics/` for example, inheriting from `Nexaas::Auditor::LogSubscriber` and `Nexaas::Auditor::StatsSubscriber` respectively.
+Then, create your loggers and statistic trackers in `app/loggers/` and `app/statistics/` for example, inheriting from `Nexaas::Auditor::LogsSubscriber` and `Nexaas::Auditor::StatsSubscriber` respectively.
 
 For example:
 
 ```ruby
-class UsersAppLogger < ::Nexaas::Auditor::LogSubscriber
+class UsersAppLogger < ::Nexaas::Auditor::LogsSubscriber
   # The namespace for events to subscribe to. In this example, subscribe to all
   # events beggining with "app.users.".
   def self.pattern

data/lib/nexaas/auditor/statistics_trackers/base.rb

@@ -3,18 +3,18 @@ module Nexaas
     module StatisticsTrackers
       class Base
 
-        def track_count(name, value=nil)
-          track(:count, name, value)
+        def track_count(metric:, value: nil)
+          value ||= 1
+          track(:count, metric, value)
         end
 
-        def track_value(name, value)
-          track(:value, name, value)
+        def track_value(metric:, value:)
+          track(:value, metric, value)
         end
 
         private
 
         def track(type, name, value)
-          value ||= 1 if type == :count
           validate_value!(value, type)
           full_name = full_metric_name(name)
           validate_name!(name, full_name)

data/lib/nexaas/auditor/version.rb

@@ -1,5 +1,5 @@
 module Nexaas
   module Auditor
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-auditor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rodrigo Tassinari de Oliveira