trinidad_logging_extension 0.2.1 → 1.0.0

data/History.txt

@@ -1,3 +1,7 @@
+== 1.0.0 (2011-08-18)
+
+* Route log through slf4j and add support for logback and java.util.logging
+
 == 0.2.0 (2010-07-31)
 
 * Upgrade to Tomcat 7

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2009 David Calavera
+Copyright (c) 2011 Michael Leinartas
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -3,7 +3,12 @@ Trinidad Logging Extension
 
 # DESCRIPTION
 
-Extension to enhance the Trinidad's logging based on Apache Log4j(http://logging.apache.org/log4j).
+Extension to enhance the Trinidad's logging by routing it through one of:
+ - Log4j (http://logging.apache.org/log4j/index.html)
+ - Logback (http://logback.qos.ch/)
+ - java.util.logging
+
+SLF4J and the jruby-rack slf4j RackLogger are used to abstract the different implementations
 
 # INSTALLATION
 
@@ -11,9 +16,14 @@ jruby -S gem install trinidad_logging_extension
 
 # CONFIGURATION
 
-The extension needs a configuration file for log4j. The default path for
-this file is 'config/trinidad-logging.properties' but it can be overrided
-into the Trinidad's configuration file.
+The extension needs a configuration file for the chosen logging system. This file can be overridden in config
+ - Log4j (Default)
+   Default configuration file: 'config/trinidad-logging.properties'
+ - Logback
+   Default configuration file: 'config/trinidad-logging.xml'
+ - java.util.logging
+   Default configuration file: 'config/trinidad-logging.properties'
+
 
 To enable the extension add this to your trinidad.yml:
 
@@ -21,6 +31,7 @@ To enable the extension add this to your trinidad.yml:
   extensions:
     logging:
       config: other_properties.properties # This field is optional
+    logging_system: log4j # This field is optional defaulting to 'log4j'. 'logback', and 'jul' are also valid choices
 
 This is an example of configuration file extracted from the Tomcat's documentation:
 
@@ -37,3 +48,4 @@ You can find further information on how to write your own extension in the wiki:
 # Copyright
 
 Copyright (c) 2010 David Calavera. See LICENSE for details.
+Copyright (c) 2011 Michael Leinartas. See LICENSE for details.

data/lib/trinidad_logging_extension.rb

@@ -1,18 +1,57 @@
 module Trinidad
   module Extensions
     module Logging
-      VERSION = '0.2.1'
+      VERSION = '1.0.0'
     end
 
-    __DIR__ = File.dirname(__FILE__)
-    require File.expand_path('../trinidad-libs/juli-adapters', __DIR__)
-    require File.expand_path('../trinidad-libs/log4j-1.2.16', __DIR__)
+    require 'trinidad_logging_extension/jars'
 
     class LoggingServerExtension < ServerExtension
+      include Trinidad::Extensions::LoggingJars
+
       def configure(tomcat)
-        @options[:config] ||= 'config/trinidad-logging.properties'
-        java.lang.System.set_property('log4j.configuration', 
-          java.io.File.new(File.expand_path(@options[:config])).to_url.to_s)
+        @options[:logging_system] ||= 'log4j'
+        @options[:config] ||= @options[:logging_system].eql? 'logback' ?
+           'config/trinidad-logging.xml' : 'config/trinidad-logging.properties'
+
+        require_common_jars
+
+        case @options[:logging_system]
+        when 'log4j'
+          set_config_property 'log4j.configuration'
+          require_log4j_jars
+          configure_jul_bridge
+        when 'logback'
+          set_config_property 'logback.configurationFile'
+          require_logback_jars
+          configure_jul_bridge
+        when 'jul', 'jdk14', 'util'
+          set_config_property('java.util.logging.config.file', false)
+          require_jul_jars
+          java_import 'java.util.logging.LogManager'
+          java.util.logging.LogManager.getLogManager.readConfiguration
+        else
+          return
+        end
+      end
+
+      def configure_jul_bridge
+        java_import 'org.slf4j.bridge.SLF4JBridgeHandler'
+        org.slf4j.bridge.SLF4JBridgeHandler.install
+      end
+
+      def set_config_property(property_name, url=true)
+        config_file = File.expand_path(@options[:config])
+        if url
+          config_file = java.io.File.new(config_file).to_url.to_s
+        end
+        java.lang.System.set_property(property_name, config_file)
+      end
+    end
+
+    class LoggingWebAppExtension < WebAppExtension
+      def configure(tomcat, app_context)
+        app_context.add_parameter('jruby.rack.logging', 'slf4j')
       end
     end
   end

data/lib/trinidad_logging_extension/jars.rb

@@ -0,0 +1,33 @@
+$:.unshift(File.expand_path"../../trinidad-libs", File.dirname(__FILE__))
+
+module Trinidad
+  module Extensions
+    module LoggingJars
+      SLF4J_VERSION = '1.6.1'
+      LOG4J_VERSION = '1.2.16'
+      LOGBACK_VERSION = '0.9.29'
+
+      def require_common_jars
+        require "slf4j-api-#{SLF4J_VERSION}.jar"
+        require "juli-adapters.jar"
+        require "jcl-over-slf4j-#{SLF4J_VERSION}.jar"
+      end
+
+      def require_log4j_jars
+        require "slf4j-log4j12-#{SLF4J_VERSION}.jar"
+        require "log4j-#{LOG4J_VERSION}"
+        require "jul-to-slf4j-#{SLF4J_VERSION}.jar"
+      end
+
+      def require_logback_jars
+        require "logback-core-#{LOGBACK_VERSION}.jar"
+        require "logback-classic-#{LOGBACK_VERSION}.jar"
+        require "jul-to-slf4j-#{SLF4J_VERSION}.jar"
+      end
+
+      def require_jul_jars
+        require "slf4j-jdk14-#{SLF4J_VERSION}.jar"
+      end
+    end
+  end
+end

data/trinidad_logging_extension.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'trinidad_logging_extension'
-  s.version           = '0.2.1'
-  s.date              = '2010-09-22'
+  s.version           = '1.0.0'
+  s.date              = '2011-08-18'
   s.rubyforge_project = 'trinidad_logging_extension'
 
   ## Make sure your summary is short. The description may be as long
@@ -57,8 +57,16 @@ Gem::Specification.new do |s|
     README
     Rakefile
     lib/trinidad_logging_extension.rb
+    lib/trinidad_logging_extension/jars.rb
+    trinidad-libs/jcl-over-slf4j-1.6.1.jar
+    trinidad-libs/jul-to-slf4j-1.6.1.jar
     trinidad-libs/juli-adapters.jar
     trinidad-libs/log4j-1.2.16.jar
+    trinidad-libs/logback-classic-0.9.29.jar
+    trinidad-libs/logback-core-0.9.29.jar
+    trinidad-libs/slf4j-api-1.6.1.jar
+    trinidad-libs/slf4j-jdk14-1.6.1.jar
+    trinidad-libs/slf4j-log4j12-1.6.1.jar
     trinidad_logging_extension.gemspec
   ]
   # = MANIFEST =

metadata

@@ -1,67 +1,51 @@
 --- !ruby/object:Gem::Specification 
 name: trinidad_logging_extension
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
+  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors: 
-- David Calavera
+  - David Calavera
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-09-22 00:00:00 +02:00
+date: 2011-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: trinidad
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 57
-        segments: 
-        - 0
-        - 9
-        - 1
-        version: 0.9.1
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: trinidad
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.9.1
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: mocha
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
 description: Configure logging service for Trinidad
 email: calavera@apache.org
 executables: []
@@ -69,48 +53,50 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
-- LICENSE
+  - README
+  - LICENSE
 files: 
-- History.txt
-- LICENSE
-- README
-- Rakefile
-- lib/trinidad_logging_extension.rb
-- trinidad-libs/juli-adapters.jar
-- trinidad-libs/log4j-1.2.16.jar
-- trinidad_logging_extension.gemspec
+  - History.txt
+  - LICENSE
+  - README
+  - Rakefile
+  - lib/trinidad_logging_extension.rb
+  - lib/trinidad_logging_extension/jars.rb
+  - trinidad-libs/jcl-over-slf4j-1.6.1.jar
+  - trinidad-libs/jul-to-slf4j-1.6.1.jar
+  - trinidad-libs/juli-adapters.jar
+  - trinidad-libs/log4j-1.2.16.jar
+  - trinidad-libs/logback-classic-0.9.29.jar
+  - trinidad-libs/logback-core-0.9.29.jar
+  - trinidad-libs/slf4j-api-1.6.1.jar
+  - trinidad-libs/slf4j-jdk14-1.6.1.jar
+  - trinidad-libs/slf4j-log4j12-1.6.1.jar
+  - trinidad_logging_extension.gemspec
 has_rdoc: true
 homepage: http://github.com/calavera/trinidad_logging_extension
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
+  - --charset=UTF-8
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: trinidad_logging_extension
-rubygems_version: 1.3.7
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 2
 summary: Logging extension for Trinidad