nexaas-auditor 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97c934a97ebfb5dfdab737c7c4a6807c8e70cdd9
-  data.tar.gz: eb88338679bc55d16e301b2bc131d859fd2b6441
+  metadata.gz: c08401a6d6365bf876971aa27083a52b05bd439d
+  data.tar.gz: d19eb0e9021bdc97b32f1798d4c540effbac9409
 SHA512:
-  metadata.gz: 1820f36fadcb65604c15b7160b62009fe77d525fd976c5342bffc0d74678a9f7f04a88e52855e2aab86211604a232cfaf8eddd2ce2cf8ad2b93eb9a9eff31e62
-  data.tar.gz: f1b006f1a0608ea35d092c8685073f9daaac92cb07665f5137272b57ae967377aa72f1a97d0e83126f5cac71fe977494ef60330bf5be1de1a87fc08a6234f9da
+  metadata.gz: 3f912ad859cfe4342e3ae78a884cec21ad7641b3424faaea3c740d1f35cb6e043a866b0d603bcc75b9af344dd5ccf58eaea7419efd40d09c1d852ae706fd9255
+  data.tar.gz: a709f06fac327e6c2b41908b397d36237b3a86f8cf152d9684242944f4bc135bfb80375e5246161b9d716c7a23c8fe75c8926197a155a509b6d43533164d753c

data/README.md

@@ -70,6 +70,10 @@ Nexaas::Auditor.configure do |config|
   end
 end
 
+# make sure all subscribers are loaded before subscribing below
+Dir[Rails.root.join("app/loggers/*.rb")].each { |f| require f }
+Dir[Rails.root.join("app/statistics/*.rb")].each { |f| require f }
+
 # setup all subscribers
 Nexaas::Auditor.subscribe_all
 ```

data/TODO.md

@@ -2,11 +2,13 @@
 
 Tasks yet to be done, in order of importance. Feel free to help out ;-)
 
-- Only require [Nunes](https://github.com/jnunemaker/nunes) gem if the configuration says `track_rails_events = true`, and "fail fast" if `Nunes` is not loaded
-- Only require [StatHat](https://github.com/patrickxb/stathat) gem if the configuration says `statistics_service = 'stathat'`, and "fail fast" if `StatHat` is not loaded
-- Extract log formating logic out of Nexaas::Auditor::AuditLogger into a proper log formating class
-- Add possibility of supporting more log formats (currently only logfmt format is supported)
-- Add options to limit the metrics subscribed by default when `track_rails_events = true`; by default [Nunes](https://github.com/jnunemaker/nunes) sends **a lot** of metrics, some of them may not be so useful and end up "polluting" the statistics service (or, more importantly, cost unnecessary money if the service restricts the number of metrics created)
-- Add more statistic services support ([Instrumental](https://instrumentalapp.com/), [self-hosted StatsD](https://github.com/etsy/statsd), [Librato](https://www.librato.com/), [DataDoc](https://www.datadoghq.com/), etc)
+- Figure out a way to make sure all app-level subscribers (subclasses of `Nexaas::Auditor::LogsSubscriber` and `Nexaas::Auditor::StatsSubscriber`) are loaded by Rails before calling `Nexaas::Auditor.subscribe_all` automatically, without having to require them manually first.
+- Only require [Nunes](https://github.com/jnunemaker/nunes) gem if the configuration says `track_rails_events = true`, and "fail fast" if `Nunes` is not loaded.
+- Only require [StatHat](https://github.com/patrickxb/stathat) gem if the configuration says `statistics_service = 'stathat'`, and "fail fast" if `StatHat` is not loaded.
+- Extract log formating logic out of Nexaas::Auditor::AuditLogger into a proper log formating class.
+- Add possibility of supporting more log formats (currently only logfmt format is supported).
+- Add options to limit the metrics subscribed by default when `track_rails_events = true`; by default [Nunes](https://github.com/jnunemaker/nunes) sends **a lot** of metrics, some of them may not be so useful and end up "polluting" the statistics service (or, more importantly, cost unnecessary money if the service restricts the number of metrics created).
+- Add more statistic services support ([Instrumental](https://instrumentalapp.com/), [self-hosted StatsD](https://github.com/etsy/statsd), [Librato](https://www.librato.com/), [DataDoc](https://www.datadoghq.com/), etc).
 - Separate the audit logging part from the statistics tracking part, maybe in separate gems as well, but in a way that they could just as easily be all used togheter and share common code.
 - Separate the bussiness-logic statistics tracking part from the Rails (Nunes) statistics tracking, maybe in separate gems as well, but in a way that they could just as easily be all used togheter and share common code.
+- Separeate log-formatting logic into a gem, that requires and uses lograge, etc, and is compatible with the Rails logger and also Sidekiq, RPush and other common gems and etc.

data/lib/nexaas/auditor/subscriber.rb

@@ -5,6 +5,7 @@ module Nexaas
     class Subscriber
 
       def self.subscribe_all
+        validate_subclasses!
         subscribers = []
         subclasses.each do |klass|
           subscribers << klass.subscribe()
@@ -35,6 +36,13 @@ module Nexaas
         raise "Not Implemented, override in subclass."
       end
 
+      # raise error if no app-level subclasses (of StatsSubscriber and
+      # LogsSubscriber) are found.
+      def self.validate_subclasses!
+        raise RuntimeError,
+          "no subclasses of #{self} found!" if subclasses.empty?
+      end
+
     end
   end
 end

data/lib/nexaas/auditor/version.rb

@@ -1,5 +1,5 @@
 module Nexaas
   module Auditor
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-auditor
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Rodrigo Tassinari de Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler