logjam_logger 1.1.0 → 1.1.1

data/README.markdown

@@ -0,0 +1,38 @@
+This gem provides syslog-compatible logging for rails applications. Just add it to your application and you are good to go -- no other changes are required. (But to really take your logging to the next level, also add [time_bandits](http://github.com/skaes/time_bandits).)
+
+Standard rails log:
+
+    Completed in 775ms (View: 158, DB: 79) | 200 OK ...
+  
+With logjam_logger, including optional user_id:
+
+    Dec 18 17:36:17 elk rails[13902] user[10]: Completed in 775ms (View: 158, DB: 79) | 200 OK ...
+  
+Logjam_logger plus time bandits, including memcache, gc, and heap statistics:
+
+    Dec 18 17:36:17 elk rails[23914] user[10]: Completed in 775.170ms (View: 157.536, DB: 78.723(20,2), MC: 0.000(0r,0m), GC: 63.514(1), HP: 0(450818,157437,5412650)) | 200 OK ...
+
+## Installation
+
+    config.gem 'logjam_logger'
+    
+## User ids
+
+User ids can be logged via a global hash, $user_ids. You can use a before_filter in your application_controller to set it, eg:
+
+    before_filter { |controller| ($user_ids ||= {})[Thread.current] = controller.session[:user_id] || 0 }
+    
+This is optional -- if $user_ids is undefined, that part of the log line will be left out.
+
+## Custom formatting
+
+If you wish to change the format of the logged output, you can set LOGJAM_FORMATTER_CLASS to your own formatter after loading the gem. For a simple example, see LogjamLogger::SimpleFormatter in lib/logjam_logger/simple_formatter.rb.
+
+    config.gem 'logjam_logger'
+    LOGJAM_FORMATTER_CLASS = MyCustomFormatter
+    
+For example, you might want to extend LogjamLogger::Formatter to also include the session_id.
+    
+## Log file analysis
+
+logjam_logger was written to work well with [Logjam](http://github.com/alpinegizmo/logjam).

data/logjam_logger.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{logjam_logger}
-  s.version = "1.1.0"
+  s.version = "1.1.1"
  
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Anderson"]
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email = %q{david@alpinegizmo.com}
   s.files = [
      "LICENSE",
-     "README",
+     "README.markdown",
      "logjam_logger.gemspec",
      "lib/logjam_logger.rb",
      "lib/logjam_logger/buffer.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: logjam_logger
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - David Anderson
@@ -23,7 +23,7 @@ extra_rdoc_files: []
 
 files: 
 - LICENSE
-- README
+- README.markdown
 - logjam_logger.gemspec
 - lib/logjam_logger.rb
 - lib/logjam_logger/buffer.rb

data/README

@@ -1,12 +0,0 @@
-This gem provides syslog-compatible logging for rails applications. Just add it to your application and you are good to go -- no other changes are required. (But to really take your logging to the next level, also add time_bandits.)
-
-    config.gem 'logjam_logger'
-
-User ids are logged via a global variable, $user_id. You can use a before_filter in your application_controller to set it, eg:
-
-    before_filter { |controller| $user_id = controller.session[:user_id] || 0 }
-
-If you wish to change the format of the logged output, you can set LOGJAM_FORMATTER_CLASS to your own formatter after loading the gem. For a simple example, see LogjamLogger::SimpleFormatter in lib/logjam_logger/simple_formatter.rb.
-
-    config.gem 'logjam_logger'
-    LOGJAM_FORMATTER_CLASS = MyCustomFormatter