log2json-loggers 0.1.5 → 0.1.6

data/lib/log2json/railslogger.rb

@@ -1,29 +1,26 @@
 # Use it like this in your config/environments/{staging,production}.rb:
 #
-#   config.logger = ::Log2Json::create_custom_ralis_logger('/tmp/alternative.log', config)
+#   config.logger = ::Log2Json::create_custom_ralis_logger(config)
 #
 # Also, in unicorn.rb, add it like this:
 #
-#   logger ::Log2Json::create_custom_unicorn_logger('/tmp/alternative.log', self)
+#   logger ::Log2Json::create_custom_unicorn_logger(self)
 #
 
 require 'logger'
     
 module Log2Json
 
-  def self.create_custom_logger(to_path)
-    logger = ::Logger.new(to_path)
-    logger.formatter = proc do |severity, datetime, progname, msg|
+  def self.log_formatter
+    proc do |severity, datetime, progname, msg|
       "#{datetime.strftime('%Y-%m-%dT%H:%M:%S%z')}: [#{severity}] #{$$} #{msg.gsub(/\n/, '#012')}\n"
     end
-    logger
   end
 
   # Create a custom logger that's just like the default Rails logger but
-  # additionally logs to another file that has its own formatting for easier
-  # parsing by a log2json log monitoring script.
+  # has its own formatting for easier parsing by a log2json log monitoring script.
   #
-  def self.create_custom_rails_logger(to_path, config)
+  def self.create_custom_rails_logger(config)
     # Do what railties' bootstrap.rb does to initialize a default logger for a Rails app.
     path = config.paths["log"].first
     unless File.exist? File.dirname path
@@ -38,58 +35,17 @@ module Log2Json
     )
     logger.level = ActiveSupport::BufferedLogger.const_get(config.log_level.to_s.upcase)
 
-    logger.extend(::Log2Json::Logger.broadcast(
-        ::Log2Json::create_custom_logger(to_path)))
+    logger.formatter = ::Log2Json::log_formatter
   end
 
   # Simiar to the custom rails logger, but for unicorn.
   #
-  def self.create_custom_unicorn_logger(to_path, config)
+  def self.create_custom_unicorn_logger(config)
     logger = ::Logger.new(config.set[:stderr_path])
-    logger.extend(::Log2Json::Logger.broadcast(
-        ::Log2Json::create_custom_logger(to_path)))
+    logger.formatter = ::Log2Json::log_formatter
   end
 
 
-  # Code stolen from activesupport-4.0.0
-  class Logger < ::Logger
-
-    # Broadcasts logs to multiple loggers.
-    def self.broadcast(logger) # :nodoc:
-      Module.new do
-        define_method(:add) do |*args, &block|
-          logger.add(*args, &block)
-          super(*args, &block)
-        end
-
-        define_method(:<<) do |x|
-          logger << x
-          super(x)
-        end
-
-        define_method(:close) do
-          logger.close
-          super()
-        end
-
-        define_method(:progname=) do |name|
-          logger.progname = name
-          super(name)
-        end
-
-        define_method(:formatter=) do |formatter|
-          logger.formatter = formatter
-          super(formatter)
-        end
-
-        define_method(:level=) do |level|
-          logger.level = level
-          super(level)
-        end
-      end
-    end
-  end
-
 end
 
 

metadata

@@ -1,128 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: log2json-loggers
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jack Kuan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-13 00:00:00 -04:00
-default_executable: 
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies: []
-
-description: |+
-  Log2json lets you read, filter and send logs as JSON objects via Unix pipes.
-  It is inspired by Logstash, and is meant to be compatible with it at the JSON
-  event/record level so that it can easily work with Kibana. 
-  
-  Reading logs is done via a shell script(eg, `tail`) running in its own process.
-  You then configure(see the `syslog2json` or the `nginxlog2json` script for
-  examples) and run your filters in Ruby using the `Log2Json` module and its
-  contained helper classes.
-  
-  `Log2Json` reads from stdin the logs(one log record per line), parses the log
-  lines into JSON records, and then serializes and writes the records to stdout,
-  which then can be piped to another process for processing or sending it to
-  somewhere else.
-  
-  Currently, Log2json ships with a `tail-log` script that can be run as the input
-  process. It's the same as using the Linux `tail` utility with the `-v -F`
-  options except that it also tracks the positions(as the numbers of lines read
-  from the beginning of the files) in a few files in the file system so that if the
-  input process is interrupted, it can continue reading from where it left off
-  next time if the files had been followed. This feature is similar to the sincedb
-  feature in Logstash's file input.
-  
-  Note: If you don't need the tracking feature(ie, you are fine with always
-  tailling from the end of file with `-v -F -n0`), then you can just use the `tail`
-  utility that comes with your Linux distribution.(Or more specifically, the
-  `tail` from the GNU coreutils). Other versions of the `tail` utility may also
-  work, but are not tested. The input protocol expected by Log2json is very
-  simple and documented in the source code.
-  
-  ** The `tail-log` script uses a patched version of `tail` from the GNU coreutils
-     package. A binary of the `tail` utility compiled for Ubuntu 12.04 LTS is
-     included with the Log2json gem. If the binary doesn't work for your
-     distribution, then you'll need to get GNU coreutils-8.13, apply the patch(it
-     can be found in the src/ directory of the installed gem), and then replace
-     the bin/tail binary in the directory of the installed gem with your version
-     of the binary. ** 
-  
-  P.S. If you know of a way to configure and compile ONLY the tail program in
-       coreutils, please let me know! The reason I'm not building tail post gem
-       installation is that it takes too long to configure && make because that
-       actually builds every utilties in coreutils.
-  
-  
-  For shipping logs to Redis, there's the `lines2redis` script that can be used as
-  the output process in the pipe. For shipping logs from Redis to ElasticSearch,
-  Log2json provides a `redis2es` script.
-  
-  Finally here's an example of Log2json in action:
-  
-  From a client machine:
-  
-    tail-log /var/log/{sys,mail}log /var/log/{kern,auth}.log | syslog2json |
-          queue=jsonlogs \
-          flush_size=20 \
-          flush_interval=30 \
-          lines2redis host.to.redis.server 6379 0  # use redis DB 0
-  
-  
-  On the Redis server:
-  
-    redis_queue=jsonlogs redis2es host.to.es.server
-  
-  
-  
-  
-  
+description: ! "Log2json lets you read, filter and send logs as JSON objects via Unix
+  pipes.\nIt is inspired by Logstash, and is meant to be compatible with it at the
+  JSON\nevent/record level so that it can easily work with Kibana. \n\nReading logs
+  is done via a shell script(eg, `tail`) running in its own process.\nYou then configure(see
+  the `syslog2json` or the `nginxlog2json` script for\nexamples) and run your filters
+  in Ruby using the `Log2Json` module and its\ncontained helper classes.\n\n`Log2Json`
+  reads from stdin the logs(one log record per line), parses the log\nlines into JSON
+  records, and then serializes and writes the records to stdout,\nwhich then can be
+  piped to another process for processing or sending it to\nsomewhere else.\n\nCurrently,
+  Log2json ships with a `tail-log` script that can be run as the input\nprocess. It's
+  the same as using the Linux `tail` utility with the `-v -F`\noptions except that
+  it also tracks the positions(as the numbers of lines read\nfrom the beginning of
+  the files) in a few files in the file system so that if the\ninput process is interrupted,
+  it can continue reading from where it left off\nnext time if the files had been
+  followed. This feature is similar to the sincedb\nfeature in Logstash's file input.\n\nNote:
+  If you don't need the tracking feature(ie, you are fine with always\ntailling from
+  the end of file with `-v -F -n0`), then you can just use the `tail`\nutility that
+  comes with your Linux distribution.(Or more specifically, the\n`tail` from the GNU
+  coreutils). Other versions of the `tail` utility may also\nwork, but are not tested.
+  The input protocol expected by Log2json is very\nsimple and documented in the source
+  code.\n\n** The `tail-log` script uses a patched version of `tail` from the GNU
+  coreutils\n   package. A binary of the `tail` utility compiled for Ubuntu 12.04
+  LTS is\n   included with the Log2json gem. If the binary doesn't work for your\n
+  \  distribution, then you'll need to get GNU coreutils-8.13, apply the patch(it\n
+  \  can be found in the src/ directory of the installed gem), and then replace\n
+  \  the bin/tail binary in the directory of the installed gem with your version\n
+  \  of the binary. ** \n\nP.S. If you know of a way to configure and compile ONLY
+  the tail program in\n     coreutils, please let me know! The reason I'm not building
+  tail post gem\n     installation is that it takes too long to configure && make
+  because that\n     actually builds every utilties in coreutils.\n\n\nFor shipping
+  logs to Redis, there's the `lines2redis` script that can be used as\nthe output
+  process in the pipe. For shipping logs from Redis to ElasticSearch,\nLog2json provides
+  a `redis2es` script.\n\nFinally here's an example of Log2json in action:\n\nFrom
+  a client machine:\n\n  tail-log /var/log/{sys,mail}log /var/log/{kern,auth}.log
+  | syslog2json |\n        queue=jsonlogs \\\n        flush_size=20 \\\n        flush_interval=30
+  \\\n        lines2redis host.to.redis.server 6379 0  # use redis DB 0\n\n\nOn the
+  Redis server:\n\n  redis_queue=jsonlogs redis2es host.to.es.server\n\n\n\nResources
+  that help writing log2json filters:\n  - look at log2json.rb source and example
+  filters\n  - http://grokdebug.herokuapp.com/\n  - http://www.ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/DateTime.html#method-i-strftime\n\n"
 email: jack.kuan@thescore.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/log2json/railslogger.rb
-has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Custom loggers for Rails and Unicorn that log to another file in addition to what their default loggers do.
+summary: Custom loggers for Rails and Unicorn that use log2json's single-line log
+  format.
 test_files: []
-
+has_rdoc: