logging-remote-syslog 0.0.4 → 0.0.5

data/.gitignore

@@ -8,6 +8,7 @@ InstalledFiles
 _yardoc
 coverage
 doc/
+.idea/
 lib/bundler/man
 pkg
 rdoc

data/README.md

@@ -1,6 +1,6 @@
 # logging/remote-syslog
 
-logging/remote-syslog is a remote syslog appender for use with the Logging library. ![Travis CI Status](https://secure.travis-ci.org/BIAINC/logging-remote-syslog.png)
+logging/remote-syslog is a remote syslog appender for use with the [Logging](https://github.com/TwP/logging) library. ![Travis CI Status](https://secure.travis-ci.org/BIAINC/logging-remote-syslog.png)
 
 ## Installation
 
@@ -20,10 +20,13 @@ Or install it yourself as:
     ```
 
 ## Options
-:ident - [String] The identity of the sender
-:syslog_server [String] - The syslog server
-:strip_colors [True|False] - Some loggers like shell colors, should we remove them?
-:facility [String] - Something like local6
+
+    :ident - [String] Identity of the sender, such as a hostname or app ID
+    :syslog_server [String] - Syslog server hostname or IP (default: `127.0.0.1`)
+    :port [Integer] - Syslog server port (default: `514`)
+    :strip_colors [True|False] - Some loggers like shell colors, should we remove them? (default: `True`)
+    :facility [String] - A syslog facility name (default: `user`)
+    :modifier [Method] - A callback for altering the original message (takes original message; returns modified one)
 
 ## Usage
 
@@ -41,12 +44,32 @@ logger.info 'MyApp Message'
 
 ```
 
+Note that as shown above, a name is required as the first argument when
+adding the appender. (If an `ident:` options hash key is also provided,
+its value will be used as the sender instead of the name.)
+
+## Example
+
+This registers a new appender named after the system's hostname. It will
+log to `logs.example.com:1111`.
+
+```
+require 'socket'
+logger = Logging.logger['MyApp']
+logger.add_appenders(
+  Logging.appenders.remote_syslog(Socket.gethostname, syslog_server: 'logs.example.com', port: 1111)
+  )
+```
+
 ## Tests
 
 ```
 rake
 ```
 
+## Change Log
+0.0.3 - Strip ANSI shell codes by default
+
 ## Contributing
 
 1. Fork it

data/lib/logging/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/logging/appenders/remote-syslog.rb

@@ -34,6 +34,7 @@ module Logging::Appenders
     #    :syslog_server => address of the remote syslog server
     #    :port          => port of the remote syslog server
     #    :facility      => the syslog facility to use
+    #    :modifier      => an optional callback method for altering original message; takes original message and returns updated one
     #
     # The parameter :ident is a string that will be prepended to every
     # message. The :facility parameter encodes a default facility to be
@@ -78,6 +79,7 @@ module Logging::Appenders
       @ident = opts.getopt(:ident, name)
       @syslog_server =  opts.getopt(:syslog_server, '127.0.0.1')
       @port = opts.getopt(:port, 514, :as => Integer)
+      @modifier = opts.getopt(:modifier)
 
       @strip_colors =  opts.getopt(:strip_colors, true)
 
@@ -123,7 +125,9 @@ module Logging::Appenders
     end
 
     def prepare_message(message)
-      @strip_colors ? strip_ansi_colors(message) : message
+      message = @strip_colors ? strip_ansi_colors(message) : message
+      message = @modifier.call(message) if @modifier
+      message
     end
 
     private

data/spec/logging/appenders/remote_syslog_spec.rb

@@ -65,4 +65,9 @@ describe Logging::Appenders::RemoteSyslog do
     appender = Logging.appenders.remote_syslog('Test', :syslog_server => '127.0.0.1', :facility => SyslogProtocol::FACILITIES['local6'], :strip_colors => false)
     appender.prepare_message("\e[KTest Message\e[0m").should ==  "\e[KTest Message\e[0m"
   end
+
+  it 'can modify original message' do
+    appender = Logging.appenders.remote_syslog('Test', :syslog_server => '127.0.0.1', :facility => SyslogProtocol::FACILITIES['local6'], :strip_colors => false, :modifier => lambda{|msg| "foo: #{msg}"})
+    appender.prepare_message("Test").should ==  "foo: Test"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logging-remote-syslog
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -126,38 +126,42 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3667170423268001466
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3667170423268001466
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ! '# logging/remote-syslog  logging/remote-syslog is a remote syslog appender
-  for use with the Logging library. ![Travis CI Status](https://secure.travis-ci.org/BIAINC/logging-remote-syslog.png)  ##
-  Installation  Add this line to your application''s Gemfile: ``` gem ''logging-remote-syslog'',
-  :require => ''logging/remote-syslog'' ```  And then execute: ``` $ bundle ```  Or
-  install it yourself as: ``` $ gem install logging-remote-syslog ```  ## Options
-  :ident - [String] The identity of the sender :syslog_server [String] - The syslog
-  server :strip_colors [True|False] - Some loggers like shell colors, should we remove
-  them? :facility [String] - Something like local6  ## Usage  ``` require ''logging''
+  for use with the [Logging](https://github.com/TwP/logging) library. ![Travis CI
+  Status](https://secure.travis-ci.org/BIAINC/logging-remote-syslog.png)  ## Installation  Add
+  this line to your application''s Gemfile: ``` gem ''logging-remote-syslog'', :require
+  => ''logging/remote-syslog'' ```  And then execute: ``` $ bundle ```  Or install
+  it yourself as: ``` $ gem install logging-remote-syslog ```  ## Options  :ident
+  - [String] Identity of the sender, such as a hostname or app ID :syslog_server [String]
+  - Syslog server hostname or IP (default: `127.0.0.1`) :port [Integer] - Syslog server
+  port (default: `514`) :strip_colors [True|False] - Some loggers like shell colors,
+  should we remove them? (default: `True`) :facility [String] - A syslog facility
+  name (default: `user`) :modifier [Method] - A callback for altering the original
+  message (takes original message; returns modified one)  ## Usage  ``` require ''logging''
   require ''logging/remote-syslog''  logger = Logging.logger[''MyApp''] logger.add_appenders(
   Logging.appenders.remote_syslog(ident, syslog_server: syslog_host, port: syslog_port)
-  )  logger.level = :info logger.info ''MyApp Message''  ```  ## Tests  ``` rake ```  ##
-  Contributing  1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)
-  3. Write code and add _tests_ 4. Commit your changes (`git commit -am ''Added some
-  feature''`) 5. Push to the branch (`git push origin my-new-feature`) 6. Create new
-  Pull Request'
+  )  logger.level = :info logger.info ''MyApp Message''  ```  Note that as shown above,
+  a name is required as the first argument when adding the appender. (If an `ident:`
+  options hash key is also provided, its value will be used as the sender instead
+  of the name.)  ## Example  This registers a new appender named after the system''s
+  hostname. It will log to `logs.example.com:1111`.  ``` require ''socket'' logger
+  = Logging.logger[''MyApp''] logger.add_appenders( Logging.appenders.remote_syslog(Socket.gethostname,
+  syslog_server: ''logs.example.com'', port: 1111) ) ```  ## Tests  ``` rake ```  ##
+  Change Log 0.0.3 - Strip ANSI shell codes by default  ## Contributing  1. Fork it
+  2. Create your feature branch (`git checkout -b my-new-feature`) 3. Write code and
+  add _tests_ 4. Commit your changes (`git commit -am ''Added some feature''`) 5.
+  Push to the branch (`git push origin my-new-feature`) 6. Create new Pull Request'
 test_files:
 - spec/logging/appenders/remote_syslog_spec.rb
 - spec/spec_helper.rb