spawning-logger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1c55f2d38055862dc3b2b585be3e1fc1f6e56a5
-  data.tar.gz: 12c9036eb7d86661e95db59efaf8fd69b92f4fd2
+  metadata.gz: 5780ad3f11ff125fb15075028a3f7ad487040610
+  data.tar.gz: 20087f952ef516872142d8922393fa46cd1f32ca
 SHA512:
-  metadata.gz: caf4a49ed5b233f8d8d8c38407c603008d8d874872402d96540ac0ce85c78d271ba403978839db43130b34be42e44e8ad4929e192a98899da12a6b224e20f4f3
-  data.tar.gz: 39aa7f7765c05342b43b6afa53f4618dabb0051cc7428a8cbc5eee2baf7b2f89b3b8abb4a6ab3ee53b1bda93de26588da067241b7277a254972e5b08e20c05c3
+  metadata.gz: 8781d2df8c8a947b376171b192c0dfd7a9f2da3b566479c30a7938a008f50ce55675df4dee379ed512cc70cd44090851a154c13a3ed850765756036be1d855a1
+  data.tar.gz: 3ddd6817ae776b5e46dbcd796df8ebee939eb21e3255c39770bd2e08982324ff7aae030db9066a65de842065d46046106b409edc9832072b488bfa2c17f33a79

data/README.md

@@ -1,4 +1,61 @@
-spawning_logger
-===============
+# SpawningLogger
 
-A logger that is able to spawn sub-loggers
+A Logger that is able to spawn sub-loggers.
+
+## General
+
+Example use case: you run a server and want to log different clients each into their own logfile (for example if you got a huge amount of clients connecting).
+
+This logger can spawn sub-loggers with different files, each of those file's name is derived from the main logger's file and the sub-logger's id.
+
+Also supports a preset logfile subdirectory in case you create many subloggers (for example you might be interested in splitting development, production, test logs into subdirectories).
+
+Only the constructor is modified and the spawning factory method added, everything else is delegated to the ruby stdlib ::Logger class.
+
+## Examples:
+
+### 1) usage same as ::Logger
+
+```ruby
+logger = SpawningLogger.new('server.log')
+
+# => creates ./server.log
+```
+
+### 2) spawn child logger
+
+```ruby
+logger = SpawningLogger.new('server.log')
+child_logger = logger.spawn('worker1')
+
+# => creates ./server_worker1.log
+# => returns a ::Logger instance logging into this file
+```
+
+### 3) spawn child logger with prefix
+
+```ruby
+SpawningLogger.configure do |config|
+  config.child_prefix = 'worker'
+end
+
+logger = SpawningLogger.new('server.log')
+child_logger = logger.spawn('1')
+
+# => creates ./server_worker_1.log
+# => returns a ::Logger instance logging into this file
+```
+
+### 4) create all logfiles inside subdir, injected into original path
+
+```ruby
+SpawningLogger.configure do |config|
+  config.subdir = 'production'
+end
+
+logger = SpawningLogger.new('log/server.log')
+child_logger = logger.spawn('1')
+
+# => creates ./log/production/server.log
+# => creates ./log/production/server_worker_1.log
+```

data/lib/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class SpawningLogger < ::Logger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spawning-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Markus Seeger