logutils 0.1.0

data/History.md

@@ -0,0 +1,3 @@
+### 0.1.0 / 2013-02-13
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.md
+Manifest.txt
+NOTES.md
+README.md
+Rakefile
+lib/logutils.rb
+lib/logutils/db/deleter.rb
+lib/logutils/db/models.rb
+lib/logutils/db/schema.rb
+lib/logutils/logger.rb
+lib/logutils/version.rb

data/NOTES.md

@@ -0,0 +1,81 @@
+# Dev Notes
+
+## todo add name, level
+
+    LogUtils[ name ] or
+    LogUtils.logger( name )  e.g. LogUtils[ self ]
+
+add logger to logger repo
+
+## todo support
+
+    logger.debug?
+    logger.warn?
+    etc.
+    
+## todo support blocks for conditional evaluation
+
+    logger.debug { ruby code here }
+
+
+### How to get process id (pid)?
+
+* Yell uses   Process.pid
+* Logging ???
+* Log4r
+
+### How to get thread id (tid)?
+
+* Yell uses   Thread.current.object_id
+* Logging ???
+* Log4r ???
+
+### How to get timestamp (ts)?
+
+* Yell uses   Time.now
+
+### How to get filename, line, method?
+
+use caller ?
+
+
+### Notes on logging levels/serverity
+
+todo/check: use int constants or strings? 
+
+There are two things you should know about log levels/severity:
+- syslog defines levels from 0 (Emergency) to 7 (Debug).
+      0 (Emergency) and 1 (Alert) levels are reserved for OS kernel.
+- Ruby default Logger defines levels from 0 (DEBUG) to 4 (FATAL) and 5 (UNKNOWN).
+      Note that order is inverted.
+   For compatibility we define our constants as Ruby Logger, and convert values before
+   generating GELF message, using defined mapping.
+
+  module Levels
+    DEBUG   = 0
+    INFO    = 1
+    WARN    = 2
+    ERROR   = 3
+    FATAL   = 4
+    UNKNOWN = 5
+  end
+
+  include Levels
+
+  Maps Ruby Logger levels to syslog levels as SyslogLogger and syslogger gems. This one is default.
+  LOGGER_MAPPING = {DEBUG   => 7, # Debug
+                    INFO    => 6, # Info
+                    WARN    => 5, # Notice
+                    ERROR   => 4, # Warning
+                    FATAL   => 3, # Error
+                    UNKNOWN => 1} # Alert � shouldn't be used
+
+  Maps Ruby Logger levels to syslog levels as is.
+  DIRECT_MAPPING = {DEBUG   => 7, # Debug
+                    INFO    => 6, # Info
+                    # skip 5 Notice
+                    WARN    => 4, # Warning
+                    ERROR   => 3, # Error
+                    FATAL   => 2, # Critical
+                    UNKNOWN => 1} # Alert � shouldn't be used
+end

data/README.md

@@ -0,0 +1,35 @@
+# logutils
+
+Another Logger in Ruby
+
+* [github.com/geraldb/logutils](https://github.com/geraldb/logutils)
+
+## Usage
+
+Logging levels:
+
+DEBUG < INFO < WARN < ERROR < FATAL
+
+use methods e.g.
+
+    logger = LoggerUtils::Logger.new
+    
+    logger.debug "msg"
+    logger.info "another msg"
+    logger.warn "another msg"
+    logger.error "another msg"
+    logger.fatal "another msg"
+
+
+## Alternatives
+
+* [Ruby Toolbox Logging Category](https://www.ruby-toolbox.com/categories/Logging)
+* [log4r]()
+* [slf4r](https://www.ruby-toolbox.com/projects/slf4r)
+* [yell]()
+* [logging](https://rubygems.org/gems/logging)
+
+## License
+
+The `logutils` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'hoe'
+require './lib/logutils/version.rb'
+
+
+Hoe.spec 'logutils' do
+  
+  self.version = LogUtils::VERSION
+  
+  self.summary = 'Another Logger'
+  self.description = summary
+
+  self.urls    = ['https://github.com/geraldb/logutils']
+  
+  self.author  = 'Gerald Bauer'
+  self.email   = 'opensport@googlegroups.com'
+    
+  # switch extension to .markdown for gihub formatting
+  #  -- NB: auto-changed when included in manifest
+  self.readme_file  = 'README.md'
+  self.history_file = 'History.md'
+  
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   :required_ruby_version => '>= 1.9.2'
+  }
+  
+end

data/lib/logutils.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+###
+# NB: for local testing run like:
+#
+# 1.9.x: ruby -Ilib lib/logutils.rb
+
+# core and stlibs
+
+require 'yaml'
+require 'pp'
+require 'logger'
+require 'fileutils'
+
+
+# rubygems / 3rd party libs
+
+require 'active_record'   ## todo: add sqlite3? etc.
+
+
+# our own code
+
+require 'logutils/version'
+
+require 'logutils/db/models'
+require 'logutils/db/schema'
+require 'logutils/db/deleter'
+
+require 'logutils/logger'
+
+
+module LogUtils
+
+end  # module LogUtils
+
+
+module LogDB
+
+  def self.banner
+    "logdb #{LogUtils::VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
+  end
+
+  def self.config_path
+    "#{root}/config"
+  end
+
+  def self.create
+    CreateDB.up
+  end
+
+  # delete ALL records (use with care!)
+  def self.delete!
+    puts '*** deleting log table records/data...'
+    Deleter.new.run
+  end # method delete!
+
+
+  def self.stats
+    # to be done
+  end
+
+
+end # module LogDB
+
+## say hello
+puts LogDB.banner

data/lib/logutils/db/deleter.rb

@@ -0,0 +1,15 @@
+
+module LogDB
+
+  class Deleter    
+    include LogDB::Models
+
+    def run( args=[] )
+      # for now delete all tables
+      
+      Log.delete_all
+    end
+    
+  end # class Deleter
+  
+end # module LogDB

data/lib/logutils/db/models.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module LogDB
+  module Models
+
+
+class Log < ActiveRecord::Base
+  
+end # class Log
+
+
+  end # module Models
+end # module LogDB

data/lib/logutils/db/schema.rb

@@ -0,0 +1,44 @@
+
+module LogDB
+
+class CreateDB   ## fix/todo: change to ActiveRecord::Migration why? why not?
+
+def self.up
+
+  ActiveRecord::Schema.define do
+
+create_table :logs do |t|
+  t.string  :msg,    :null => false
+  t.string  :level,  :null => false  # e.g. fatal, error, warn, info, debug
+  t.string  :app
+  t.string  :tag       # e.g. class name w/ namespace e.g. SportDB.Reader etc. # NB: change to name?
+  t.integer :pid
+  t.string  :tid     # NB: thread_id  - change to integer ??
+  t.string  :ts      # timestamp - change to datetime?
+  # add filename, line, method ??
+  t.timestamps
+end
+
+#####################################
+# todo: add more fields ?? e.g.
+#
+# %m : The message to be logged
+# %d : The ISO8601 Timestamp
+# %L : The log level, e.g INFO, WARN
+# %l : The log level (short), e.g. I, W
+# %p : The PID of the process from where the log event occured
+# %t : The Thread ID from where the log event occured
+# %h : The hostname of the machine from where the log event occured
+# %f : The filename from where the log event occured
+# %n : The line number of the file from where the log event occured
+# %F : The filename with path from where the log event occured
+# %M : The method where the log event occured
+
+
+  end # block Schema.define
+
+end # method up
+
+end # class CreateDB
+
+end # module LogDB

data/lib/logutils/logger.rb

@@ -0,0 +1,74 @@
+
+module LogUtils
+  
+  module Level
+    DEBUG = 'debug'
+    INFO  = 'info'
+    WARN  = 'warn'
+    ERROR = 'error'
+    FATAL = 'fatal'
+  end
+  
+  class Event
+    def initialize( level, msg )
+      @level = level
+      @msg   = msg
+      
+      @pid   = Process.pid
+      @tid   = Thread.current.object_id
+      
+      @ts    = Time.now
+    end
+
+    attr_reader :level
+    attr_reader :msg
+    attr_reader :pid   # process_id
+    attr_reader :tid   # thread_id
+    attr_reader :ts    # timestamp
+
+
+    def to_s()
+      "[#{level}-#{pid}.#{tid}] #{msg}"
+    end
+
+  end # class Event
+  
+  
+  class Logger
+    include LogDB::Models
+    include Level
+    
+    def debug( msg )
+      write( Event.new( DEBUG, msg ) )
+    end
+    
+    def info( msg )
+      write( Event.new( INFO, msg ) )
+    end
+    
+    def warn( msg )
+      write( Event.new( WARN, msg ) )
+    end
+    
+    def error( msg )
+      write( Event.new( ERROR, msg ) )
+    end
+    
+    def fatal( msg )
+      write( Event.new( FATAL, msg ) )
+    end
+
+  private
+
+    def write( ev )
+      puts ev.to_s
+      
+      if( [FATAL, ERROR, WARN].include?( ev.level ) )
+        ## create log entry in db table (logs)
+        Log.create!( level: ev.level, msg: ev.msg, pid: ev.pid, tid: ev.tid, ts: ev.ts )
+      end
+    end
+    
+  end # class Logger
+  
+end # module LogUtils

data/lib/logutils/version.rb

@@ -0,0 +1,5 @@
+
+module LogUtils
+  VERSION = '0.1.0'
+end  # module LogUtils
+

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: logutils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &21073536 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: *21073536
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &21072828 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: *21072828
+description: Another Logger
+email: opensport@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Manifest.txt
+files:
+- History.md
+- Manifest.txt
+- NOTES.md
+- README.md
+- Rakefile
+- lib/logutils.rb
+- lib/logutils/db/deleter.rb
+- lib/logutils/db/models.rb
+- lib/logutils/db/schema.rb
+- lib/logutils/logger.rb
+- lib/logutils/version.rb
+homepage: https://github.com/geraldb/logutils
+licenses:
+- Public Domain
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: logutils
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Another Logger
+test_files: []