gelf 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 204c030f01e64d6980fe343a5d53144c3f31c894
-  data.tar.gz: 7ae8e4d33e55764f191692a396f950e87118f359
+  metadata.gz: 7e1c02912c99651ae9b78b3d80a254b39e44b880
+  data.tar.gz: 0723b767126b56dbe6d86bcb2ae77da7024eb128
 SHA512:
-  metadata.gz: d3dfbe2d3d722a53de17c4a46edf93ffb4d17105b1f481f07bfaad598d9a29a070d1cdc5c8160e05c11bc1d373ee95c1de7997b676981826169a191f507c324e
-  data.tar.gz: c4d5d7fbf18e55096ae640af049c7e508a718a88c8e321b901bf7765f5da85c421ca3bb76d037534c5844cb1ae85534adda4648b3c9a601228246c7b54f21e17
+  metadata.gz: fa809d0a268591b148822d58bf1f32d703b18ba8c1149e0c70d160cd30e49b834ddb2ef4d9bc206bd0650a6432e9021823d299bb760bfaa126dfd34d6960dc42
+  data.tar.gz: 99f27da7b54e6a0e19713ae4c926a2005a7c94236c0b4d28a322cf78db81361e3cb4504a93c138cce9bcbc0025e71956adc86b3eb5b1e341f028c79f07703509

data/.travis.yml

@@ -1,12 +1,16 @@
 rvm:
-  - 1.8.7
-  - ree
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - jruby-19mode
-
-notifications:
-  irc: "irc.freenode.org#graylog2"
+- 1.9.3
+- 2.0.0
+- 2.1.0
+- 2.2.0
+- 2.3.0
+- jruby-19mode
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Pm1yAqo2ldet/Fd2jK5dKZkDNmyx5KkYtViL+eOR4Rxs82dwqOcCSyrBL6BOzuRfJtpjgXUX6FDapKgLDYW/2EDW8mmiciOL0WLzxYQsmJXcerJeUl2tTeFKpyEf+8aaDQpAlsK0m1dPmQjCJF9MWsa7m3oshm3mJ1VITY90chM=
+  gem: gelf
+  gemspec: gelf.gemspec
+  on:
+    tags: true
+    repo: Graylog2/gelf-rb

data/CHANGELOG

@@ -1,5 +1,13 @@
+3.0.0, 2016-08-21
+ + Overhaul TCP support
+ + Include automatic support for Celluloid::IO if available
+ + Add TLS support to TCP transport
+ - Remove support for ancient Rubygems versions
+ - Remove support for Ruby 1.9.2 (1.9.3 works!)
+ - Remove already-deprecated `host` and `port` methods on GELF::Notifier
+
 2.0.0, 2016-02-02
- * Added GELF support
+ + Added GELF TCP support.
 
 1.3.2, 2011-12-02:
  * support for rubygems-test.

data/Gemfile

@@ -2,7 +2,10 @@ source "https://rubygems.org"
 
 group :development do
   gem "shoulda", "~> 2.11.3"
-  gem "jeweler", "~> 1.8.7"
-  gem "mocha", "~> 0.14.0"
-  gem "test-unit", "~> 3.0.8"
+  gem "jeweler", "~> 2.1.1"
+  # Because of a dependency chain jeweler->github_api->oauth2->rack,
+  # pin the version: Rack 2.0.x doesn't work on < Ruby 2.2
+  gem 'rack', '< 2.0'
+  gem "mocha", "~> 1.1.0"
+  gem "test-unit", "~> 3.2.0"
 end

data/Gemfile.lock

@@ -1,61 +1,70 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
+    addressable (2.4.0)
     builder (3.2.2)
-    faraday (0.8.8)
-      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.0.5)
-    highline (1.6.19)
-    httpauth (0.2.0)
-    jeweler (1.8.7)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.14.5)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2 (~> 1.0)
+    hashie (3.4.4)
+    highline (1.7.8)
+    jeweler (2.1.1)
       builder
-      bundler (~> 1.0)
+      bundler (>= 1.0)
       git (>= 1.2.5)
-      github_api (= 0.10.1)
+      github_api
       highline (>= 1.6.15)
-      nokogiri (= 1.5.10)
+      nokogiri (>= 1.5.10)
       rake
       rdoc
-    json (1.8.2)
-    jwt (0.1.8)
-      multi_json (>= 1.5)
-    metaclass (0.0.1)
-    mocha (0.14.0)
+      semver
+    json (1.8.3)
+    jwt (1.5.4)
+    metaclass (0.0.4)
+    mini_portile2 (2.1.0)
+    mocha (1.1.0)
       metaclass (~> 0.0.1)
-    multi_json (1.7.9)
+    multi_json (1.12.1)
     multi_xml (0.5.5)
-    multipart-post (1.2.0)
-    nokogiri (1.5.10)
-    oauth2 (0.9.2)
-      faraday (~> 0.8)
-      httpauth (~> 0.2)
-      jwt (~> 0.1.4)
-      multi_json (~> 1.0)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    power_assert (0.2.3)
-    rack (1.5.2)
-    rake (10.1.0)
-    rdoc (4.0.1)
+      rack (>= 1.2, < 3)
+    pkg-config (1.1.7)
+    power_assert (0.3.0)
+    rack (1.6.4)
+    rake (11.2.2)
+    rdoc (4.2.2)
       json (~> 1.4)
+    semver (1.0.1)
     shoulda (2.11.3)
-    test-unit (3.0.9)
+    test-unit (3.2.1)
       power_assert
+    thread_safe (0.3.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler (~> 1.8.7)
-  mocha (~> 0.14.0)
+  jeweler (~> 2.1.1)
+  mocha (~> 1.1.0)
+  rack (< 2.0)
   shoulda (~> 2.11.3)
-  test-unit (~> 3.0.8)
+  test-unit (~> 3.2.0)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -2,9 +2,9 @@
 
 This is the new GELF gem written by Alexey Palazhchenko. It is based on the old gem by Lennart Koopmann and allows you to send GELF messages to Graylog2 server instances. See [http://www.graylog2.org/about/gelf](http://www.graylog2.org/about/gelf) for more information about GELF and [http://rdoc.info/github/Graylog2/gelf-rb/master/frames](http://rdoc.info/github/Graylog2/gelf-rb/master/frames) for API documentation.
 
-Tested with Ruby 1.8.7, 1.9.x. and 2.0.x.
+Tested with Ruby 1.9, 2.0, 2.1, 2.2 and 2.3.
 
-![](https://travis-ci.org/Graylog2/gelf-rb.png?branch=master)
+![](https://travis-ci.org/Graylog2/gelf-rb.png?branch=master) [![Code Climate](https://codeclimate.com/github/Graylog2/gelf-rb/badges/gpa.svg)](https://codeclimate.com/github/Graylog2/gelf-rb)
 
 ## Usage
 ### Gelf::Notifier

data/Rakefile

@@ -13,9 +13,9 @@ begin
     gem.name = "gelf"
     gem.summary = 'Library to send GELF messages to Graylog logging server.'
     gem.description = 'Library to send GELF messages to Graylog logging server. Supports plain-text, GELF messages and exceptions via UDP and TCP.'
-    gem.email = "lennart@graylog.com"
+    gem.email = "mail@marcusilgner.com"
     gem.homepage = "http://github.com/Graylog2/gelf-rb"
-    gem.authors = ["Alexey Palazhchenko", "Lennart Koopmann", "Zac Sprackett"]
+    gem.authors = ["Alexey Palazhchenko", "Lennart Koopmann", "Zac Sprackett", "Marcus Ilgner"]
     gem.add_dependency "json"
     gem.licenses = ["MIT"]
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-2.0.0
+3.0.0

data/gelf.gemspec

@@ -2,20 +2,19 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: gelf 2.0.0 ruby lib
+# stub: gelf 3.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gelf"
-  s.version = "2.0.0"
+  s.version = "3.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
-  s.authors = ["Alexey Palazhchenko", "Lennart Koopmann", "Zac Sprackett"]
-  s.date = "2016-02-03"
+  s.authors = ["Alexey Palazhchenko", "Lennart Koopmann", "Zac Sprackett", "Marcus Ilgner"]
+  s.date = "2016-08-21"
   s.description = "Library to send GELF messages to Graylog logging server. Supports plain-text, GELF messages and exceptions via UDP and TCP."
-  s.email = "lennart@graylog.com"
+  s.email = "mail@marcusilgner.com"
   s.extra_rdoc_files = [
-    "CHANGELOG",
     "LICENSE",
     "README.md"
   ]
@@ -35,8 +34,10 @@ Gem::Specification.new do |s|
     "lib/gelf.rb",
     "lib/gelf/logger.rb",
     "lib/gelf/notifier.rb",
-    "lib/gelf/ruby_sender.rb",
     "lib/gelf/severity.rb",
+    "lib/gelf/transport/tcp.rb",
+    "lib/gelf/transport/tcp_tls.rb",
+    "lib/gelf/transport/udp.rb",
     "test/helper.rb",
     "test/test_logger.rb",
     "test/test_notifier.rb",
@@ -45,7 +46,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/Graylog2/gelf-rb"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.5.1"
+  s.rubygems_version = "2.5.1"
   s.summary = "Library to send GELF messages to Graylog logging server."
 
   if s.respond_to? :specification_version then
@@ -53,22 +54,25 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_development_dependency(%q<mocha>, ["~> 0.14.0"])
-      s.add_development_dependency(%q<test-unit>, ["~> 3.0.8"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.1.1"])
+      s.add_development_dependency(%q<rack>, ["< 2.0"])
+      s.add_development_dependency(%q<mocha>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<test-unit>, ["~> 3.2.0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-      s.add_dependency(%q<mocha>, ["~> 0.14.0"])
-      s.add_dependency(%q<test-unit>, ["~> 3.0.8"])
+      s.add_dependency(%q<jeweler>, ["~> 2.1.1"])
+      s.add_dependency(%q<rack>, ["< 2.0"])
+      s.add_dependency(%q<mocha>, ["~> 1.1.0"])
+      s.add_dependency(%q<test-unit>, ["~> 3.2.0"])
       s.add_dependency(%q<json>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
-    s.add_dependency(%q<mocha>, ["~> 0.14.0"])
-    s.add_dependency(%q<test-unit>, ["~> 3.0.8"])
+    s.add_dependency(%q<jeweler>, ["~> 2.1.1"])
+    s.add_dependency(%q<rack>, ["< 2.0"])
+    s.add_dependency(%q<mocha>, ["~> 1.1.0"])
+    s.add_dependency(%q<test-unit>, ["~> 3.2.0"])
     s.add_dependency(%q<json>, [">= 0"])
   end
 end

data/lib/gelf.rb

@@ -12,6 +12,5 @@ module GELF
 end
 
 require 'gelf/severity'
-require 'gelf/ruby_sender'
 require 'gelf/notifier'
 require 'gelf/logger'

data/lib/gelf/logger.rb

@@ -5,7 +5,7 @@ module GELF
     attr_accessor :formatter
 
     # Use it like Logger#add... or better not to use at all.
-    def add(level, message = nil, progname = nil, &block)
+    def add(level, message = nil, progname = nil)
       progname ||= default_options['facility']
 
       if message.nil?
@@ -21,11 +21,11 @@ module GELF
 
       if message.is_a?(Hash)
         # Stringify keys.
-        message.each do |k,v|
-          message_hash[k.to_s] = message[k]
+        message.each do |key, value|
+          message_hash[key.to_s] = value
         end
       else
-        message_hash['short_message'] = message
+        message_hash['short_message'] = message.to_s
       end
 
       if message.is_a?(Exception)
@@ -37,15 +37,17 @@ module GELF
 
     # Redefines methods in +Notifier+.
     GELF::Levels.constants.each do |const|
-      class_eval <<-EOT, __FILE__, __LINE__ + 1
-        def #{const.downcase}(progname = nil, &block)   # def debug(progname = nil, &block)
-          add(GELF::#{const}, nil, progname, &block)    #   add(GELF::DEBUG, nil, progname, &block)
-        end                                             # end
+      method_name = const.downcase
 
-        def #{const.downcase}?                          # def debug?
-          GELF::#{const} >= level                       #   GELF::DEBUG >= level
-        end                                             # end
-      EOT
+      define_method(method_name) do |progname=nil, &block|
+        const_level = GELF.const_get(const)
+        add(const_level, nil, progname, &block)
+      end
+
+      define_method("#{method_name}?") do
+        const_level = GELF.const_get(const)
+        const_level >= level
+      end
     end
 
     def <<(message)

data/lib/gelf/notifier.rb

@@ -1,10 +1,14 @@
+require 'gelf/transport/udp'
+require 'gelf/transport/tcp'
+require 'gelf/transport/tcp_tls'
+
 module GELF
   # Graylog2 notifier.
   class Notifier
-    @last_chunk_id = 0
-    class << self
-      attr_accessor :last_chunk_id
-    end
+    # Maximum number of GELF chunks as per GELF spec
+    MAX_CHUNKS = 128
+    MAX_CHUNK_SIZE_WAN = 1420
+    MAX_CHUNK_SIZE_LAN = 8154
 
     attr_accessor :enabled, :collect_file_and_line, :rescue_network_errors
     attr_reader :max_chunk_size, :level, :default_options, :level_mapping
@@ -15,24 +19,21 @@ module GELF
     def initialize(host = 'localhost', port = 12201, max_size = 'WAN', default_options = {})
       @enabled = true
       @collect_file_and_line = true
+      @random = Random.new
 
       self.level = GELF::DEBUG
       self.max_chunk_size = max_size
       self.rescue_network_errors = false
 
-      self.default_options = default_options
+      self.default_options = default_options.dup
       self.default_options['version'] = SPEC_VERSION
       self.default_options['host'] ||= Socket.gethostname
       self.default_options['level'] ||= GELF::UNKNOWN
       self.default_options['facility'] ||= 'gelf-rb'
       self.default_options['protocol'] ||= GELF::Protocol::UDP
 
-      if self.default_options['protocol'] == GELF::Protocol::TCP
-        @sender = RubyTcpSender.new([[host, port]])
-      else
-        @sender = RubyUdpSender.new([[host, port]])
-      end
       self.level_mapping = :logger
+      @sender = create_sender(host, port)
     end
 
     # Get a list of receivers.
@@ -47,24 +48,14 @@ module GELF
       @sender.addresses = addrs
     end
 
-    def host
-      warn "GELF::Notifier#host is deprecated. Use #addresses instead."
-      self.addresses.first[0]
-    end
-
-    def port
-      warn "GELF::Notifier#port is deprecated. Use #addresses instead."
-      self.addresses.first[1]
-    end
-
     # +size+ may be a number of bytes, 'WAN' (1420 bytes) or 'LAN' (8154).
     # Default (safe) value is 'WAN'.
     def max_chunk_size=(size)
       case size.to_s.downcase
         when 'wan'
-          @max_chunk_size = 1420
+          @max_chunk_size = MAX_CHUNK_SIZE_WAN
         when 'lan'
-          @max_chunk_size = 8154
+          @max_chunk_size = MAX_CHUNK_SIZE_LAN
         else
           @max_chunk_size = size.to_int
       end
@@ -129,18 +120,32 @@ module GELF
     end
 
     GELF::Levels.constants.each do |const|
-      class_eval <<-EOT, __FILE__, __LINE__ + 1
-        def #{const.downcase}(*args)                          # def debug(*args)
-          notify_with_level(GELF::#{const}, *args)            #   notify_with_level(GELF::DEBUG, *args)
-        end                                                   # end
-      EOT
+      define_method(const.downcase) do |*args|
+        level = GELF.const_get(const)
+        notify_with_level(level, *args)
+      end
     end
 
   private
+
+    def create_sender(host, port)
+      addresses = [[host, port]]
+      if default_options['protocol'] == GELF::Protocol::TCP
+        if default_options.key?('tls')
+          tls_options = default_options.delete('tls')
+          GELF::Transport::TCPTLS.new(addresses, tls_options)
+        else
+          GELF::Transport::TCP.new(addresses)
+        end
+      else
+        GELF::Transport::UDP.new(addresses)
+      end
+    end
+
     def notify_with_level(message_level, *args)
       notify_with_level!(message_level, *args)
     rescue SocketError, SystemCallError
-      raise unless self.rescue_network_errors
+      raise unless rescue_network_errors
     rescue Exception => exception
       notify_with_level!(GELF::UNKNOWN, exception)
     end
@@ -150,7 +155,7 @@ module GELF
       extract_hash(*args)
       @hash['level'] = message_level unless message_level.nil?
       if @hash['level'] >= level
-        if self.default_options['protocol'] == GELF::Protocol::TCP
+        if default_options['protocol'] == GELF::Protocol::TCP
           validate_hash
           @sender.send(@hash.to_json + "\0")
         else
@@ -180,7 +185,10 @@ module GELF
 
     def self.extract_hash_from_exception(exception)
       bt = exception.backtrace || ["Backtrace is not available."]
-      { 'short_message' => "#{exception.class}: #{exception.message}", 'full_message' => "Backtrace:\n" + bt.join("\n") }
+      {
+        'short_message' => "#{exception.class}: #{exception.message}",
+        'full_message' => "Backtrace:\n" + bt.join("\n")
+      }
     end
 
     # Converts Hoptoad-specific keys in +@hash+ to Graylog2-specific.
@@ -197,9 +205,7 @@ module GELF
 
     def set_file_and_line
       stack = caller
-      begin
-        frame = stack.shift
-      end while frame.include?(LIB_GELF_PATTERN)
+      frame = stack.find { |f| !f.include?(LIB_GELF_PATTERN) }
       match = CALLER_REGEXP.match(frame)
       @hash['file'] = match[1]
       @hash['line'] = match[2].to_i
@@ -223,9 +229,12 @@ module GELF
 
       # Maximum total size is 8192 byte for UDP datagram. Split to chunks if bigger. (GELF v1.0 supports chunking)
       if data.count > @max_chunk_size
-        id = GELF::Notifier.last_chunk_id += 1
+        id = @random.bytes(8)
         msg_id = Digest::MD5.digest("#{Time.now.to_f}-#{id}")[0, 8]
         num, count = 0, (data.count.to_f / @max_chunk_size).ceil
+        if count > MAX_CHUNKS
+          raise ArgumentError, "Data too big (#{data.count} bytes), would create more than #{MAX_CHUNKS} chunks!"
+        end
         data.each_slice(@max_chunk_size) do |slice|
           datagrams << "\x1e\x0f" + msg_id + [num, count, *slice].pack('C*')
           num += 1
@@ -239,7 +248,6 @@ module GELF
 
     def validate_hash
       raise ArgumentError.new("Hash is empty.") if @hash.nil? || @hash.empty?
-
       @hash['level'] = @level_mapping[@hash['level']]
     end
 
@@ -252,7 +260,8 @@ module GELF
     def self.stringify_keys(hash)
       hash.keys.each do |key|
         value, key_s = hash.delete(key), key.to_s
-        raise ArgumentError.new("Both #{key.inspect} and #{key_s} are present.") if hash.has_key?(key_s)
+        raise ArgumentError.new("Both #{key.inspect} and #{key_s} are present.") if hash.key?(key_s)
+        value = stringify_keys(value) if value.is_a?(Hash)
         hash[key_s] = value
       end
       hash

data/lib/gelf/transport/tcp.rb

@@ -0,0 +1,63 @@
+module GELF
+  module Transport
+    class TCP
+      attr_reader :addresses
+
+      # `addresses` Array of [host, port] pairs
+      def initialize(addresses)
+        @sockets = []
+        self.addresses = addresses
+      end
+
+      def addresses=(addresses)
+        @addresses = addresses.dup.freeze.tap do |addrs|
+          @sockets.each(&:close)
+          @sockets = addrs.map { |peer| connect(*peer) }
+        end
+      end
+
+      def send(message)
+        return if @addresses.empty?
+        loop do
+          connected = @sockets.reject(&:closed?)
+          reconnect_all if connected.empty?
+          break if write_any(connected, message)
+        end
+      end
+
+      private
+
+      def connect(host, port)
+        socket_class.new(host, port)
+      end
+
+      def reconnect_all
+        @sockets = @sockets.each_with_index.map do |old_socket, index|
+          old_socket.closed? ? connect(*@addresses[index]) : old_socket
+        end
+      end
+
+      def socket_class
+        if defined?(Celluloid::IO::TCPSocket)
+          Celluloid::IO::TCPSocket
+        else
+          ::TCPSocket
+        end
+      end
+
+      def write_any(sockets, message)
+        sockets.shuffle.each do |socket|
+          return true if write_socket(socket, message)
+        end
+        false
+      end
+
+      def write_socket(socket, message)
+        socket.write(message) > 0
+      rescue IOError, SystemCallError
+        socket.close unless socket.closed?
+        false
+      end
+    end
+  end
+end

data/lib/gelf/transport/tcp_tls.rb

@@ -0,0 +1,112 @@
+require 'openssl'
+
+module GELF
+  module Transport
+    # Provides encryption capabilities for TCP connections
+    class TCPTLS < TCP
+      # Supported tls_options:
+      #   'no_default_ca' [Boolean] prevents OpenSSL from using the systems CA store.
+      #   'tls_version' [Symbol] any of :TLSv1, :TLSv1_1, :TLSv1_2 (default)
+      #   'cert' [String, IO] the client certificate file
+      #   'key' [String, IO] the key for the client certificate
+      #   'all_ciphers' [Boolean] allows any ciphers to be used, may be insecure
+      def initialize(addresses, tls_options={})
+        @tls_options = tls_options
+        super(addresses)
+      end
+
+      protected
+
+      def write_socket(socket, message)
+        super(socket, message)
+      rescue OpenSSL::SSL::SSLError
+        socket.close unless socket.closed?
+        false
+      end
+
+      def connect(host, port)
+        plain_socket = super(host, port)
+        start_tls(plain_socket)
+      rescue OpenSSL::SSL::SSLError
+        plain_socket.close unless plain_socket.closed?
+        nil
+      end
+
+      # Initiates TLS communication on the socket
+      def start_tls(plain_socket)
+        ssl_socket_class.new(plain_socket, ssl_context).tap do |ssl_socket|
+          ssl_socket.sync_close = true
+          ssl_socket.connect
+        end
+      end
+
+      def ssl_socket_class
+        if defined?(Celluloid::IO::SSLSocket)
+          Celluloid::IO::SSLSocket
+        else
+          OpenSSL::SSL::SSLSocket
+        end
+      end
+
+      def ssl_context
+        @ssl_context ||= OpenSSL::SSL::SSLContext.new.tap do |ctx|
+          ctx.cert_store = ssl_cert_store
+          ctx.ssl_version = tls_version
+          ctx.verify_mode = verify_mode
+          set_certificate_and_key(ctx)
+          restrict_ciphers(ctx) unless @tls_options['all_ciphers']
+        end
+      end
+
+      def set_certificate_and_key(context)
+        return unless @tls_options['cert'] && @tls_options['key']
+        context.cert = OpenSSL::X509::Certificate.new(resource(@tls_options['cert']))
+        context.key = OpenSSL::PKey::RSA.new(resource(@tls_options['key']))
+      end
+
+      # checks whether {resource} is a filename and tries to read it
+      # otherwise treats it as if it already contains certificate/key data
+      def resource(data)
+        if data.is_a?(String) && File.exist?(data)
+          File.read(data)
+        else
+          data
+        end
+      end
+
+      # These are A-level ciphers as reported from Graylog 2.0.1
+      # which were also available on Ruby using OpenSSL 1.0.2h
+      # A lot of AES-128-CBC based ciphers were not available
+      SECURE_CIPHERS = %w(
+                           AES128-GCM-SHA256
+                           ECDHE-RSA-AES128-GCM-SHA256
+                           DHE-RSA-AES128-GCM-SHA256
+                         ).freeze
+      def restrict_ciphers(ctx)
+        ctx.ciphers = SECURE_CIPHERS
+      end
+
+      def verify_mode
+        @tls_options['no_verify'] ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+      end
+
+      # SSL v2&3 are insecure, forces at least TLS v1.0 and defaults to v1.2
+      def tls_version
+        if @tls_options.key?('version') &&
+            OpenSSL::SSL::SSLContext::METHODS.include?(@tls_options['version']) &&
+            @tls_options['version'] =~ /\ATLSv/
+          @tls_options['version']
+        else
+          :TLSv1_2
+        end
+      end
+
+      def ssl_cert_store
+        OpenSSL::X509::Store.new.tap do |store|
+          # TODO: allow passing in expected server certificate and disabling system CAs
+          store.set_default_paths
+        end
+      end
+    end
+  end
+end

data/lib/gelf/transport/udp.rb

@@ -0,0 +1,41 @@
+module GELF
+  module Transport
+    class UDP
+      attr_accessor :addresses
+
+      def initialize(addresses)
+        @addresses = addresses
+      end
+
+      def send_datagrams(datagrams)
+        socket = get_socket
+        idx = get_address_index
+
+        host, port = @addresses[idx]
+        set_address_index((idx + 1) % @addresses.length)
+        datagrams.each do |datagram|
+          socket.send(datagram, 0, host, port)
+        end
+      end
+
+      def close
+        socket = get_socket
+        socket.close if socket
+      end
+
+      private
+
+      def get_socket
+        Thread.current[:gelf_udp_socket] ||= UDPSocket.open
+      end
+
+      def get_address_index
+        Thread.current[:gelf_udp_address_idx] ||= 0
+      end
+
+      def set_address_index(value)
+        Thread.current[:gelf_udp_address_idx] = value
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'mocha'
+require 'mocha/setup'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_notifier.rb

@@ -7,7 +7,7 @@ class TestNotifier < Test::Unit::TestCase
     Socket.expects(:gethostname).returns('default_hostname')
     n = GELF::Notifier.new
     assert_equal [[['localhost', 12201]], 1420], [n.addresses, n.max_chunk_size]
-    assert_equal( { 'version' => '1.0', 'level' => GELF::UNKNOWN,
+    assert_equal( { 'version' => '1.0', 'level' => GELF::UNKNOWN, 'protocol' => 0,
                     'host' => 'default_hostname', 'facility' => 'gelf-rb' },
                   n.default_options )
     n.addresses, n.max_chunk_size, n.default_options = [['graylog2.org', 7777]], :lan, {:host => 'grayhost'}
@@ -52,14 +52,14 @@ class TestNotifier < Test::Unit::TestCase
         e.set_backtrace(caller)
         hash = @notifier.__send__(:extract_hash, e)
         assert_equal 'RuntimeError: message', hash['short_message']
-        assert_match /Backtrace/, hash['full_message']
+        assert_match(/Backtrace/, hash['full_message'])
         assert_equal GELF::ERROR, hash['level']
       end
 
       should "work with exception without backtrace" do
         e = RuntimeError.new('message')
         hash = @notifier.__send__(:extract_hash, e)
-        assert_match /Backtrace is not available/, hash['full_message']
+        assert_match(/Backtrace is not available/, hash['full_message'])
       end
 
       should "work with exception and hash" do
@@ -108,7 +108,7 @@ class TestNotifier < Test::Unit::TestCase
       should "set file and line" do
         line = __LINE__
         hash = @notifier.__send__(:extract_hash, { 'version' => '1.0', 'short_message' => 'message' })
-        assert_match /test_notifier.rb/, hash['file']
+        assert_match(/test_notifier.rb/, hash['file'])
         assert_equal line + 1, hash['line']
       end
 
@@ -153,7 +153,7 @@ class TestNotifier < Test::Unit::TestCase
         asserted = "\x78\x9c"
         if RUBY_VERSION[0,1].to_i >= 2
           puts "I'm a Ruby > 2.0.0. Enforcing ASCII-8BIT. (#{RUBY_VERSION}/#{RUBY_VERSION[0,1].to_i})"
-          # lol well yeah, Rubby. 
+          # lol well yeah, Rubby.
           # http://stackoverflow.com/questions/15843684/binary-string-literals-in-ruby-2-0
           asserted = asserted.b
         end
@@ -200,6 +200,17 @@ class TestNotifier < Test::Unit::TestCase
           assert_equal datagrams.count, datagram[11].ord
         end
       end
+
+      should "throw an error if more than MAX_CHUNKS will be created" do
+        srand(1) # for stable tests
+        hash = { 'version' => '1.0', 'short_message' => 'message' }
+        hash.merge!('something' => (0..3000).map { RANDOM_DATA[rand(RANDOM_DATA.count)] }.join) # or it will be compressed too good
+        @notifier.max_chunk_size = 10
+        @notifier.instance_variable_set('@hash', hash)
+        assert_raise(ArgumentError) do
+          @notifier.__send__(:datagrams_from_hash)
+        end
+      end
     end
 
     context "level threshold" do

data/test/test_ruby_sender.rb

@@ -4,7 +4,7 @@ class TestRubyUdpSender < Test::Unit::TestCase
   context "with ruby sender" do
     setup do
       @addresses = [['localhost', 12201], ['localhost', 12202]]
-      @sender = GELF::RubyUdpSender.new(@addresses)
+      @sender = GELF::Transport::UDP.new(@addresses)
       @datagrams1 = %w(d1 d2 d3)
       @datagrams2 = %w(e1 e2 e3)
     end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: gelf
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Alexey Palazhchenko
 - Lennart Koopmann
 - Zac Sprackett
+- Marcus Ilgner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -32,42 +33,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: 2.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.8
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -84,11 +99,10 @@ dependencies:
         version: '0'
 description: Library to send GELF messages to Graylog logging server. Supports plain-text,
   GELF messages and exceptions via UDP and TCP.
-email: lennart@graylog.com
+email: mail@marcusilgner.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGELOG
 - LICENSE
 - README.md
 files:
@@ -107,8 +121,10 @@ files:
 - lib/gelf.rb
 - lib/gelf/logger.rb
 - lib/gelf/notifier.rb
-- lib/gelf/ruby_sender.rb
 - lib/gelf/severity.rb
+- lib/gelf/transport/tcp.rb
+- lib/gelf/transport/tcp_tls.rb
+- lib/gelf/transport/udp.rb
 - test/helper.rb
 - test/test_logger.rb
 - test/test_notifier.rb
@@ -134,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Library to send GELF messages to Graylog logging server.

data/lib/gelf/ruby_sender.rb

@@ -1,147 +0,0 @@
-module GELF
-  # Plain Ruby UDP sender.
-  class RubyUdpSender
-    attr_accessor :addresses
-
-    def initialize(addresses)
-      @addresses = addresses
-      @i = 0
-      @socket = UDPSocket.open
-    end
-
-    def send_datagrams(datagrams)
-      host, port = @addresses[@i]
-      @i = (@i + 1) % @addresses.length
-      datagrams.each do |datagram|
-        @socket.send(datagram, 0, host, port)
-      end
-    end
-
-    def close
-      @socket.close
-    end
-  end
-
-  class RubyTcpSocket
-    attr_accessor :socket
-
-    def initialize(host, port)
-      @host = host
-      @port = port
-      connect
-    end
-
-    def connected?
-      if not @connected
-        begin
-          if @socket.nil?
-            @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
-          end
-          sockaddr = Socket.sockaddr_in(@port, @host)
-          @socket.connect_nonblock(sockaddr)
-        rescue Errno::EISCONN
-          @connected = true
-        rescue Errno::EINPROGRESS, Errno::EALREADY
-          @connected = false
-        rescue SystemCallError
-          @socket = nil
-          @connected = false
-        end
-      end
-      return @connected
-    end
-
-    def connect
-      @connected = false
-      socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
-      sockaddr = Socket.sockaddr_in(@port, @host)
-      begin
-        socket.connect_nonblock(sockaddr)
-      rescue Errno::EISCONN
-        @connected = true
-      rescue SystemCallError
-        return false
-      end
-      @socket = socket
-      return true
-    end
-
-    def matches?(host, port)
-      if @host == host and @port == port
-        true
-      else
-        false
-      end
-    end
-  end
-
-  class RubyTcpSender
-    attr_reader :addresses
-
-    def initialize(addresses)
-      @sockets = []
-      addresses.each do |address|
-        s = RubyTcpSocket.new(address[0], address[1])
-        @sockets.push(s)
-      end
-    end
-
-    def addresses=(addresses)
-      addresses.each do |address|
-        found = false
-        # handle pre existing sockets
-        @sockets.each do |socket|
-          if socket.matches?(address[0], address[1])
-            found = true
-            break
-          end
-        end
-        if not found
-          s = RubyTcpSocket.new(address[0], address[1])
-          @sockets.push(s)
-        end
-      end
-    end
-
-    def send(message)
-      while true do
-        sent = false
-        sockets = @sockets.map { |s|
-          if s.connected?
-            s.socket
-          end
-        }
-        sockets.compact!
-        next unless not sockets.empty?
-        begin
-          result = select( nil, sockets, nil, 1)
-          if result
-            writers = result[1]
-            sent = write_any(writers, message)
-          end
-          break if sent
-        rescue SystemCallError, IOError
-        end
-      end
-    end
-
-    private
-    def write_any(writers, message)
-      writers.shuffle.each do |w|
-        begin
-          w.write(message)
-          return true
-        rescue Errno::EPIPE
-          @sockets.each do |s|
-            if s.socket == w
-              s.socket.close
-              s.socket = nil
-              s.connect
-            end
-          end
-        end
-      end
-      return false
-    end
-  end
-end