biola_logs 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c88ba89e5b0b199c4a3aefb09177eaae64625e8
-  data.tar.gz: 21aedaa234cc64351544c6beee922066d2f0dd31
+  metadata.gz: c26cee0e0e3494d6294520b3e4e28d6129c7fd80
+  data.tar.gz: f1ca6c6a8fbb86bb1ac02e9d2bdcc7d53963a1a5
 SHA512:
-  metadata.gz: 78d53ecc58bb570425e606fa806968c08efaf4f385f7a9be89b40f46750c7047c9f8f2f9477dfeddfdc32a0ff6ebb747c5fbb435c1cb42f6a086e6484b417cbf
-  data.tar.gz: eafc64f9f9541a096a3eecff8000c8b12a6c7dbb7de8ae741bbb3ac44afd2dcaeaf5be374dcd5bb5a2b3653c740fc7aef0cbdae89e9a8433e094886d57c6b80e
+  metadata.gz: 9fecd0263f8464aad5742b2c4ca21bfd9fdfbbdc5b5f8940f4cf86bd9ae8226674a2156bba09528460a2d8184e5eb5aa4f476e29a15f089b040b817c435a0797
+  data.tar.gz: ccb871e2cc83e6db1b7e3166da87bddceb02e2afa70cae1dcd900bf25b692eca70c038557970502f2056bd461877647167534a2e96ff232482a0889448f4ba7a

data/README.md

@@ -1,7 +1,7 @@
 Biola Logs
 ==========
 
-A simple gem to standardize log formatting across all our Rails apps
+A simple gem to standardize log formatting across all our Rails apps using [lograge](https://github.com/roidrage/lograge).
 
 Usage
 -----
@@ -12,7 +12,31 @@ Add the following to your `Gemfile`
 gem 'biola_logs'
 ```
 
-And you're done.
+Biola Logs doesn't include PID and timestamp, so assuming you want those you'll need to add the following to your environment file(s) (eg. /config/environments/production.rb)
+
+```ruby
+# Use default logging formatter so that PID and timestamp are not suppressed.
+config.log_formatter = ::Logger::Formatter.new
+```
+
+To log `session_id`, `request_id` (or uuid), and `host_name` you need to add the following custom variables to payload in your controller. The `Headers` generator will pull these custom variables out and add them to the hash passed to lograge's `custom_options` config method.
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  def append_info_to_payload(payload)
+    super
+    payload[:session_id] = request.session_options[:id]
+    payload[:uuid] = request.uuid
+    payload[:host] = request.host
+  end
+end
+```
+
+Generators
+----------
+
+Generators inherit from the `Base` class and should override the `to_hash` method. `Generators.handler` merges the returned hash from each generator to populate `config.lograge.custom_options` in railtie.rb.
 
 License
 -------

data/lib/biola_logs.rb

@@ -1,6 +1,7 @@
 require 'lograge'
 require 'biola_logs/generators'
 require 'biola_logs/generators/base'
+require 'biola_logs/generators/headers'
 require 'biola_logs/generators/params'
 require 'biola_logs/railtie'
 

data/lib/biola_logs/generators.rb

@@ -1,10 +1,15 @@
 module BiolaLogs
   module Generators
     def self.all
+      # Class method to get all classes in the BiolaLogs::Generators module 
+      # returns an Array, skipping BiolaLogs::Generators::Base
+      # example: [BiolaLogs::Generators::Params, BiolaLogs::Generators::Headers] 
       self.constants.map(&self.method(:const_get)).grep(Class) - [Base]
     end
 
     def self.handler
+      # Class method that returns a hash of key/value pairs for `config.lograge.custom_options`
+      # Calls to_hash() on all generators and merges the results into a single hash
       Proc.new do |event|
         self.all.each_with_object({}) do |klass, hash|
           hash.merge! klass.new(event).to_hash

data/lib/biola_logs/generators/headers.rb

@@ -0,0 +1,37 @@
+module BiolaLogs
+  module Generators
+    class Headers < Base
+
+      def to_hash
+        if method_supported?
+          h = {}
+          h[:session_id] = session_id if session_id
+          h[:host_name] = host if host
+          h[:request_id] = uuid if uuid
+          h
+        else
+          {}
+        end
+      end
+
+      private
+
+      def session_id
+        event.payload[:session_id] #requires adding :session_id to payload
+      end
+
+      def uuid
+        event.payload[:uuid] #requires adding :uuid to payload
+      end
+
+      def host
+        event.payload[:host] #requires adding :host to payload
+      end
+
+      def method_supported?
+        # SUPPORTED_HTTP_METHODS.include?(event.payload[:method])
+        true
+      end
+    end
+  end
+end

data/lib/biola_logs/version.rb

@@ -1,3 +1,3 @@
 module BiolaLogs
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: biola_logs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-11 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -35,6 +35,7 @@ files:
 - lib/biola_logs.rb
 - lib/biola_logs/generators.rb
 - lib/biola_logs/generators/base.rb
+- lib/biola_logs/generators/headers.rb
 - lib/biola_logs/generators/params.rb
 - lib/biola_logs/railtie.rb
 - lib/biola_logs/version.rb