Adds tagged logging support and Logger::Formatter support

.travis.yml

@@ -4,10 +4,15 @@ rvm:
   - ree
   - 1.9.2
   - 1.9.3
+<<<<<<< HEAD
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode
   # - rbx-19mode
+=======
+  - 2.0.0
+  - jruby-19mode
+>>>>>>> master
 
 notifications:
   irc: "irc.freenode.org#graylog2"

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+Thank you very much for considering contributing to the Graylog2 project! We <3 our community.
+
+To make handling all the community contributions as easy as possible for us we ask you to follow these steps as good as possible:
+
+## Bug reports
+
+  1. Please sign the [TORCH Contributor Agreement](https://github.com/Graylog2/graylog2-web-interface/raw/0.20/ContributorAgreement.pdf) if your issue contains
+     any code. We cannot go on without this.
+  2. Search the issues of both the [graylog2-server](https://github.com/Graylog2/graylog2-server) and [graylog2-web-interface](https://github.com/Graylog2/graylog2-web-interface)
+     repositories for opened or closed issues to avoid duplicating effort.
+  3. Be clear about the issue. It is always better to include too much information than too little. Include screenshots explaining the problem if you can.
+  4. Always include the versions of affected Graylog2 components you are running.
+  5. Provide exact steps to reproduce the issue if at any possible.
+
+## Pull requests
+
+  1. Please sign the [TORCH Contributor Agreement](https://github.com/Graylog2/graylog2-web-interface/raw/0.20/ContributorAgreement.pdf) before sending pull requests.
+     We cannot accept code without this.
+  2. Search the issues of both the [graylog2-server](https://github.com/Graylog2/graylog2-server) and [graylog2-web-interface](https://github.com/Graylog2/graylog2-web-interface)
+     repositories for opened or closed issues to avoid duplicating effort.
+  3. Contact the [TORCH](http://www.torch.sh/) team via [any communication channel](http://graylog2.org/support) (contact form, mailing list, IRC, Github issue tracker) before working on a big change to make sure
+     that there are chances of acceptance.
+  4. Include tests if at any possible.
+  5. Submit the pull request.
+
+## Feature requests
+
+We are always happy about any feature request! Do not hesitate to create as many feature request issues as you want.
+
+  1. Please sign the [TORCH Contributor Agreement](https://github.com/Graylog2/graylog2-web-interface/raw/0.20/ContributorAgreement.pdf) if your issue contains
+     any code. We cannot go on without this.
+  2. Search the issues of both the [graylog2-server](https://github.com/Graylog2/graylog2-server) and [graylog2-web-interface](https://github.com/Graylog2/graylog2-web-interface)
+     repositories for opened or closed issues to avoid duplicating effort.
+  3. Explain exactly what feature you'd like to see and always include a use case for why you think it is useful.

Gemfile

@@ -1,11 +1,5 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem "json"
-
-group :development do
-  gem "bundler"
-  gem "jeweler"
-  gem "shoulda"
-  gem "mocha"
-  gem "rdoc"
-end
+gem "shoulda", "~> 2.11.3"
+gem "jeweler", "~> 1.8.7"
+gem "mocha", "~> 0.14.0"

Gemfile.lock

@@ -1,32 +1,55 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    git (1.2.5)
-    jeweler (1.8.3)
+    addressable (2.3.5)
+    builder (3.2.2)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.1.0)
+    highline (1.6.21)
+    jeweler (1.8.7)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.7.0)
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
     metaclass (0.0.1)
-    mocha (0.11.3)
+    mocha (0.14.0)
       metaclass (~> 0.0.1)
-    rake (0.9.2.2)
-    rdoc (3.12)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.2.2)
+    rdoc (4.0.1)
       json (~> 1.4)
-    shoulda (3.0.1)
-      shoulda-context (~> 1.0.0)
-      shoulda-matchers (~> 1.0.0)
-    shoulda-context (1.0.0)
-    shoulda-matchers (1.0.0)
+    shoulda (2.11.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  jeweler
-  json
-  mocha
-  rdoc
-  shoulda
+  jeweler (~> 1.8.7)
+  mocha (~> 0.14.0)
+  shoulda (~> 2.11.3)

README.rdoc

@@ -4,10 +4,45 @@ This is the new GELF gem written by Alexey Palazhchenko. It is based on the old
 
 Works with Ruby 1.8.7, 1.9.x and JRuby. 1.8.6 is not supported.
 
+{<img src="https://travis-ci.org/Graylog2/gelf-rb.png?branch=master" alt="Build Status" />}[https://travis-ci.org/Graylog2/gelf-rb]
+
 == Installation
 
   gem install gelf
 
+== Usage
+=== Gelf::Notifier
+
+This allows you to sent arbitary messages via UDP to your Graylog2 server.
+
+  n = GELF::Notifier.new("localhost", 12201)
+
+  # Send with custom attributes and an additional parameter "foo"
+  n.notify!(:short_message => "foo", :full_message => "something here\n\nbacktrace?!", :_foo => "bar")
+
+  # Pass any object that responds to .to_hash
+  n.notify!(Exception.new)
+
+=== Gelf::Logger
+
+The Gelf::Logger is compatible with the standard Ruby Logger interface and can be used interchangeably.
+Under the hood it uses Gelf::Notifier to send log messages via UDP to Graylog2.
+
+  logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })
+
+  logger.debug "foobar"
+  logger.info "foobar"
+  logger.warn "foobar"
+  logger.error "foobar"
+  logger.fatal "foobar"
+
+  logger << "foobar"
+
+Since it's compatible with the Logger interface, you can also use it in your Rails application:
+
+  # config/environments/production.rb
+  config.logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })
+
 == Note on Patches/Pull Requests
 
 * Fork the project.
@@ -19,4 +54,4 @@ Works with Ruby 1.8.7, 1.9.x and JRuby. 1.8.6 is not supported.
 
 == Copyright
 
-Copyright (c) 2010-2011 Lennart Koopmann and Alexey Palazhchenko. See LICENSE for details.
+Copyright (c) 2010-2013 Lennart Koopmann and Alexey Palazhchenko. See LICENSE for details.

Rakefile

@@ -34,6 +34,8 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
+task :default => :test
+
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
@@ -42,16 +44,19 @@ begin
     test.rcov_opts << '--exclude gem'
     test.verbose = true
   end
-rescue LoadError
-  # nothing
+rescue LoadError => e
+  task :rcov do
+    puts e
+    abort "rcov is not available. Run: gem install rcov"
+  end
 end
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "gelf #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+#require 'rake/rdoctask'
+#Rake::RDocTask.new do |rdoc|
+#  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+#
+#  rdoc.rdoc_dir = 'rdoc'
+#  rdoc.title = "gelf #{version}"
+#  rdoc.rdoc_files.include('README*')
+#  rdoc.rdoc_files.include('lib/**/*.rb')
+#end

VERSION

@@ -1 +1 @@
-1.4.0.beta1
+1.4.0.beta2

gelf.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "gelf"
-  s.version = "1.4.0.beta1"
+  s.version = "1.4.0.beta2"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexey Palazhchenko", "Lennart Koopmann"]
-  s.date = "2012-05-03"
+  s.date = "2014-04-21"
   s.description = "Library to send GELF messages to Graylog2 logging server. Supports plain-text, GELF messages and exceptions."
   s.email = "[email protected]"
   s.extra_rdoc_files = [

lib/gelf/logger.rb

@@ -1,6 +1,9 @@
 module GELF
   # Methods for compatibility with Ruby Logger.
   module LoggerCompatibility
+
+    attr_accessor :formatter
+
     # Does nothing.
     def close
     end
@@ -20,9 +23,30 @@ def add(level, *args)
                             [args[0], default_options['facility']]
                           end
 
-      hash = {'short_message' => message, 'facility' => progname}
+      if message.is_a?(Hash)
+        # Stringify keys.
+        hash = {}
+        message.each do |k,v|
+          hash[k.to_s] = message[k]
+        end
+
+        hash['facility'] = progname
+      else
+        hash = {'short_message' => message, 'facility' => progname}
+      end
+
+      hash['facility'] = default_options['facility'] unless progname
+
       hash.merge!(self.class.extract_hash_from_exception(message)) if message.is_a?(Exception)
-      notify_with_level(level, hash)
+
+      if default_options['tags']
+        tags = current_tags
+        default_options['tags'].each_with_index do |tag_name, index|
+          hash.merge!("_#{tag_name}" => tags[index]) if tags[index]
+        end
+      end
+
+      notify_with_level(level, format_message(level, Time.now, progname, hash))
     end
 
     # Redefines methods in +Notifier+.
@@ -42,13 +66,42 @@ def #{const.downcase}?                        # def debug?
     def <<(message)
       notify_with_level(GELF::UNKNOWN, 'short_message' => message)
     end
+
+    def tagged(*new_tags)
+      tags     = current_tags
+      new_tags = new_tags.flatten.reject(&:blank?)
+      tags.concat new_tags
+      yield self
+    ensure
+      tags.pop(new_tags.size)
+    end
+
+    def current_tags
+      Thread.current[:gelf_tagged_logging_tags] ||= []
+    end
+
+    def format_message(severity, datetime, progname, message)
+      return message if formatter.nil?
+      formatter.call(severity, datetime, progname, message)
+    end
+
   end
 
   # Graylog2 notifier, compatible with Ruby Logger.
   # You can use it with Rails like this:
   #     config.logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })
   #     config.colorize_logging = false
+  #
+  # Tagged logging (with tags from rack middleware) (order of tags is important)
+  # Adds custom gelf messages: { '_uuid_name' => <uuid>, '_remote_ip_name' => <remote_ip> }
+  #     config.log_tags = [:uuid, :remote_ip]
+  #     config.colorize_logging = false
+  #     config.logger = GELF::Logger.new("localhost", 12201, 'LAN', {
+  #       tags: [:uuid_name, :remote_ip_name], # same order as config.log_tags
+  #       facility: 'Jobmensa 2'
+  #     })
   class Logger < Notifier
     include LoggerCompatibility
   end
+
 end