steno 1.0.3 → 1.0.4

data/README.md

@@ -11,19 +11,67 @@ ultimate destination for log records. They transform a structured record into
 a string via a formatter and then typically write the transformed string to
 another transport.
 
-## Getting started
+## Configuration
+
+To use steno, you must configure one or more 'sinks', a 'codec' and a 'context'.
+If you don't provide a codec, steno will encode your logs as JSON.
+
+For example:
+
     config = Steno::Config.new(
       :sinks   => [Steno::Sink::IO.new(STDOUT)],
       :codec   => Steno::Codec::Json.new,
       :context => Steno::Context::ThreadLocal.new)
 
-    Steno.init(config)
+### from YAML file
+
+Alternatively, Steno can read its configuration from a YAML file in the following format:
+
+```yaml
+# config.yml
+---
+logging:
+  file: /some/path            # Optional - path a log file
+  max_retries: 3              # Optional - number of times to retry if a file write fails.
+  syslog: some_syslog.id      # Optional
+  fluentd:                    # Optional
+    host: fluentd.host
+    port: 9999
+  level: debug                # Optional - Minimum log level that will be written.
+                              # Defaults to 'info'
+```
+Then, in your code:
+```ruby
+config = Steno::Config.from_file("path/to/config.yml")
+```
 
-    logger = Steno.logger("test")
+With this configuration method, if neither `file`, `syslog` or `fluentd` are provided,
+steno will use its stdout as its sink. Also, note that the top-level field `logging` is required.
 
+### from Hash
+
+As a third option, steno can be configured using a hash with the same structure as the above
+YAML file (without the top-level `logging` key):
+```ruby
+config = Steno::Config.from_hash(config_hash)
+```
+
+## Usage
+
+    Steno.init(config)
+    logger = Steno.logger("test")  
     logger.info("Hello world!")
 
-## File a Bug
+### Log levels
+
+    LEVEL	NUMERIC RANKING 
+    off		0
+    fatal	1
+    error	5
+    warn	10
+    info	15
+    debug	16
+    debug1	17
+    debug2	18
+    all		30
 
-To file a bug against Cloud Foundry Open Source and its components, sign up and use our
-bug tracking system: [http://cloudfoundry.atlassian.net](http://cloudfoundry.atlassian.net)

data/Rakefile

@@ -2,6 +2,8 @@
 require "ci/reporter/rake/rspec"
 require "rspec/core/rake_task"
 
+task :default => :spec
+
 desc "Run all specs"
 RSpec::Core::RakeTask.new("spec") do |t|
   t.rspec_opts = %w[--color --format documentation]

data/lib/steno/config.rb

@@ -52,6 +52,10 @@ class Steno::Config
         opts[:sinks] << Steno::Sink::Syslog.instance
       end
 
+      if hash[:fluentd]
+        opts[:sinks] << Steno::Sink::Fluentd.new(hash[:fluentd])
+      end
+
       if opts[:sinks].empty?
         opts[:sinks] << Steno::Sink::IO.new(STDOUT)
       end

data/lib/steno/http_handler.rb

@@ -7,7 +7,6 @@ end
 
 class Steno::HttpHandler < Grape::API
   format :json
-  error_format :json
 
   resource :loggers do
     get :levels do

data/lib/steno/logger.rb

@@ -104,7 +104,6 @@ class Steno::Logger
   # @return [true || false]
   def level_active?(level_name)
     level = self.class.lookup_level(level_name)
-
     @min_level_lock.synchronize { level <= @min_level }
   end
 
@@ -127,8 +126,6 @@ class Steno::Logger
   def log(level_name, message = nil, user_data = nil, &blk)
     return unless level_active?(level_name)
 
-    level = self.class.lookup_level(level_name)
-
     message = yield if block_given?
 
     callstack = caller

data/lib/steno/sink.rb

@@ -1,3 +1,5 @@
 require "steno/sink/base"
 require "steno/sink/io"
 require "steno/sink/syslog"
+require "steno/sink/fluentd"
+require "steno/sink/counter"

data/lib/steno/sink/counter.rb

@@ -0,0 +1,44 @@
+require "steno/sink/base"
+
+module Steno
+  module Sink
+  end
+end
+
+class Steno::Sink::Counter < Steno::Sink::Base
+
+  def initialize
+    # Map of String -> numeric count
+    @counts = {}
+    @mutex = Mutex.new
+  end
+
+  def add_record(record)
+    level = record.log_level.name.to_s
+
+    @mutex.synchronize do
+      unless @counts[level]
+        @counts[level] = 0
+      end
+      @counts[level] += 1
+    end
+  end
+
+  def flush
+  end
+
+  def to_json
+    hash = {}
+    @mutex.synchronize do
+      Steno::Logger::LEVELS.keys.each do |level_name|
+        hash[level_name] = @counts.fetch(level_name.to_s, 0)
+      end
+    end
+    Yajl::Encoder.encode(hash)
+  end
+
+  # Provide a map of string level -> count. This is thread-safe, the return value is a copy.
+  def counts
+    @mutex.synchronize { @counts.dup }
+  end
+end

data/lib/steno/sink/fluentd.rb

@@ -0,0 +1,31 @@
+require 'fluent-logger'
+#
+# Steno sink implementation for Fluentd
+#
+#   See fluentd at http://fluentd.org/
+#   and fluent-logger at https://github.com/fluent/fluent-logger-ruby
+#
+class Steno::Sink::Fluentd < Steno::Sink::Base
+
+  # @param [Hash] opts Key :tag_prefix tag prefix of fluent logs (default: steno)
+  #                    Key :host fluentd host (default: 127.0.0.1)
+  #                    Key :port fluentd port (deafult: 24224)
+  #                    Key :buffer_limit buffer limit of fluent-logger
+  def initialize(opts = {})
+    super
+
+    @fluentd = Fluent::Logger::FluentLogger.new(opts[:tag_prefix] || "steno",
+      :host => opts[:host] || "127.0.0.1",
+      :port => opts[:port] || 24224,
+      :buffer_limit => opts[:buffer_limit] || Fluent::Logger::FluentLogger::BUFFER_LIMIT)
+    @io_lock = Mutex.new
+  end
+
+  def add_record(record)
+    @fluentd.post(record.source, record)
+  end
+
+  def flush
+    nil
+  end
+end

data/lib/steno/version.rb

@@ -1,3 +1,3 @@
 module Steno
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/unit/log_level_spec.rb

@@ -15,4 +15,5 @@ describe Steno::LogLevel do
       info_level.to_s.should == "info"
     end
   end
+
 end

data/spec/unit/sink/counter_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Steno::Sink::Counter do
+  let(:level) do
+    Steno::Logger.lookup_level(:info)
+  end
+
+  let(:record) do
+    Steno::Record.new("source", level, "message")
+  end
+
+  describe "add_record" do
+    it "counts added records" do
+      expect(subject.counts).to be_empty
+      subject.add_record(record)
+      expect(subject.counts.size).to eq 1
+      expect(subject.counts['info']).to eq 1
+    end
+  end
+
+  describe "to_json" do
+    it "produces a valid json representation" do
+      subject.add_record(record)
+      expect(subject.to_json).to match '"info":1'
+    end
+  end
+end

data/spec/unit/sink/fluentd_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Steno::Sink::IO do
+  let(:level) do
+    Steno::Logger.lookup_level(:info)
+  end
+
+  let(:record) do
+    Steno::Record.new("source", level, "message")
+  end
+
+  describe "#initialize" do
+    it "should initialize FluentLogger with the default option" do
+      Fluent::Logger::FluentLogger.should_receive(:new).with("steno", {
+        :host => "127.0.0.1",
+        :port => 24224,
+        :buffer_limit => Fluent::Logger::FluentLogger::BUFFER_LIMIT,
+        }).and_return()
+      sink = Steno::Sink::Fluentd.new()
+    end
+
+    it "should initialize FliuentLogger with override options" do
+      Fluent::Logger::FluentLogger.should_receive(:new).with("vcap", {
+        :host => "localhost",
+        :port => 8080,
+        :buffer_limit => 1024,
+        }).and_return()
+      sink = Steno::Sink::Fluentd.new({
+        :tag_prefix => "vcap",
+        :host => "localhost",
+        :port => 8080,
+        :buffer_limit => 1024
+        })
+    end
+  end
+
+  describe "#add_record" do
+    it "should post an record with the correct tag" do
+      fluentd = mock("fluentd")
+      Fluent::Logger::FluentLogger.should_receive(:new).and_return(fluentd)
+      fluentd.should_receive(:post).with("source", record)
+      sink = Steno::Sink::Fluentd.new()
+      sink.add_record(record)
+    end
+  end
+end

data/steno.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("grape")
   gem.add_dependency("yajl-ruby", "~> 1.0")
+  gem.add_dependency("fluent-logger")
 
   gem.add_development_dependency("ci_reporter")
   gem.add_development_dependency("rack-test")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steno
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +145,8 @@ files:
 - lib/steno/logger.rb
 - lib/steno/record.rb
 - lib/steno/sink/base.rb
+- lib/steno/sink/counter.rb
+- lib/steno/sink/fluentd.rb
 - lib/steno/sink/io.rb
 - lib/steno/sink/syslog.rb
 - lib/steno/sink.rb
@@ -151,6 +169,8 @@ files:
 - spec/unit/log_level_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/record_spec.rb
+- spec/unit/sink/counter_spec.rb
+- spec/unit/sink/fluentd_spec.rb
 - spec/unit/sink/io_spec.rb
 - spec/unit/sink/syslog_spec.rb
 - spec/unit/steno_spec.rb
@@ -194,6 +214,8 @@ test_files:
 - spec/unit/log_level_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/record_spec.rb
+- spec/unit/sink/counter_spec.rb
+- spec/unit/sink/fluentd_spec.rb
 - spec/unit/sink/io_spec.rb
 - spec/unit/sink/syslog_spec.rb
 - spec/unit/steno_spec.rb