gelf_redux 3.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12a992294a97a00260cb881e3070cb3d47017fd7c60159d1795eb6fee4806514
+  data.tar.gz: 99b6aa9c799b284f231017d8d9b6bafee12ab5a81b68ab5611069349defac6d7
+SHA512:
+  metadata.gz: b3b6eba5fc81cfeec6e306e24632568768102b4b395e603801c5c6cf45d560ba1bc7e437ae15f5dd5836dc9781eaa14b70007ba0b0caed1a0299438a93ba0eb9
+  data.tar.gz: d9e2658d0d6a1bc293875f401aaf2d8deffc37436242131ff2c400f6edac4e3cbb43256ea79d04c7440cd12181397c6c8c0e30d8545163e32072c7b9e8f79e94

data/CHANGELOG

@@ -0,0 +1,54 @@
+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 TCP support.
+
+1.3.2, 2011-12-02:
+ * support for rubygems-test.
+ * rescue from more network errors.
+
+1.3.1, 2011-10-28:
+ + allow to rescue from network errors.
+
+1.3.0, 2011-07-27:
+ + allow to set timestamp manually.
+
+1.2.0.beta1, 2011-05-23:
+ + compatibility with GELF specification 1.0:
+   * requires modern graylog2-server and graylog2-web-interface;
+ + Notifier#default_options, Notifier#default_options=;
+ + severity (level) threshold;
+ + automatically set 'file', 'line' and 'timestamp' fields;
+ + wrappers for GELF::Notifier#notify with severity:
+   + GELF::Notifier.debug
+   + GELF::Notifier.info
+   + GELF::Notifier.warn
+   + GELF::Notifier.error
+   + GELF::Notifier.fatal
+   + GELF::Notifier.unknown
+ + full compatibility with Ruby Logger and other loggers:
+   + GELF::Logger#fatal { "Argument 'foo' not given." }
+   + GELF::Logger#error "Argument #{ @foo } mismatch."
+   + GELF::Logger#info('initialize') { "Initializing..." }
+   + GELF::Logger#add(GELF::FATAL) { 'Fatal error!' }
+   + GELF::Logger#close
+   + GELF::Logger#level = GELF::INFO
+ + allow to change severity mapping;
+ + send messages to receivers in round-robin;
+   * GELF::Notifier#host and #port are attr_readers now and deprecated (were attr_accessor);
+ + allow to disable file and line collection (GELF::Notifier#collect_file_and_line = false);
+ - deprecated Gelf class removed.
+
+1.0.2, 2010-11-29:
+1.0.1, 2010-11-29:
+ - added more tests for chunking in attempt to locate not existing bug.
+
+1.0.0, 2010-11-10:
+ + initial stable version;
+ * deprecated Gelf class is still there.

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+Please follow [the instructions on graylog.org](https://www.graylog.org/contributing-to-graylog/).

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+group :development do
+  gem "shoulda", "~> 2.11.3"
+  # 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

@@ -0,0 +1,24 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    metaclass (0.0.4)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    power_assert (0.3.0)
+    rack (1.6.4)
+    shoulda (2.11.3)
+    test-unit (3.2.1)
+      power_assert
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  mocha (~> 1.1.0)
+  rack (< 2.0)
+  shoulda (~> 2.11.3)
+  test-unit (~> 3.2.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2016 Lennart Koopmann, Alexey Palazhchenko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+## GELF (anew) Ruby library
+This gem is intended to replace the existing and unmaintained gelf-rb https://github.com/graylog-labs/gelf-rb - since
+the project went silent for a few years and there seems to be no intention in continuing any kind of support
+(https://github.com/graylog-labs/gelf-rb/issues/93). So we decided to not just fork but set up a new gem.
+Since we needed support for http(s) transports as well we are mirroring this fork (https://github.com/christianrolle/gelf-rb) instead
+of the original project because we wanted to keep all of the projects and maintainers history.
+
+## Versioning
+
+- 3.1.1 is the latest original gelf-rb version ()
+- 3.2.0 is the first http(s) supporting version from here https://github.com/christianrolle/gelf-rb
+- 4.0.0 we do start from here with our versioning, improvements and updates
+
+
+
+## Usage
+### Gelf::Notifier
+
+This allows you to sent arbitary messages via UDP to Graylog.
+
+    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)
+
+The recommended default is to send via UDP but you can choose to send via TCP like this:
+
+    n = GELF::Notifier.new("127.0.0.1", 12201, "LAN", { :protocol => GELF::Protocol::TCP })
+
+Note that the `LAN` or `WAN` option is ignored for TCP because no chunking happens. (Read below for more information.)
+
+### 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 Graylog.
+
+    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"
+
+Then `WAN` or `LAN` option influences the UDP chunk size depending on if you send in your own
+network (LAN) or on a longer route (i.e. through the internet) and should be set accordingly.
+
+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.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010-2016 Lennart Koopmann and Alexey Palazhchenko. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+
+begin
+  require 'ci/reporter/rake/test_unit'
+rescue LoadError
+  # nothing
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.rcov_opts << '--exclude gem'
+    test.verbose = true
+  end
+rescue LoadError => e
+  task :rcov do
+    puts e
+    abort "rcov is not available. Run: gem install rcov"
+  end
+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

data/VERSION

@@ -0,0 +1 @@
+3.1.0

data/benchmarks/notifier.rb

@@ -0,0 +1,39 @@
+#! /usr/bin/env ruby
+
+puts "Loading..."
+
+require 'benchmark'
+require 'rubygems'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gelf'
+
+puts "Generating random data..."
+srand(1)
+RANDOM_DATA = ('A'..'z').to_a
+k3_message = (1..3*1024).map { RANDOM_DATA[rand(RANDOM_DATA.count)] }.join
+
+TARGET_HOST = 'localhost'
+TARGET_PORT = 12201
+DEFAULT_OPTIONS = { '_host' => 'localhost' }
+TIMES = 5000
+
+SHORT_HASH = { 'short_message' => 'message' }
+LONG_HASH  = { 'short_message' => 'message', 'long_message' => k3_message }
+
+
+notifier_lan = GELF::Notifier.new(TARGET_HOST, TARGET_PORT, 'LAN', DEFAULT_OPTIONS)
+notifier_wan = GELF::Notifier.new(TARGET_HOST, TARGET_PORT, 'WAN', DEFAULT_OPTIONS)
+
+# to create mongo collections, etc.
+notifier_lan.notify!(LONG_HASH)
+sleep(5)
+
+puts "Sending #{TIMES} notifications...\n"
+tms = Benchmark.bm(25) do |b|
+  b.report('lan, short data, 1 chunk ') { TIMES.times { notifier_lan.notify!(SHORT_HASH) } }
+  sleep(5)
+  b.report('lan,  long data, 1 chunk ') { TIMES.times { notifier_lan.notify!(LONG_HASH) } }
+  sleep(5)
+  b.report('wan,  long data, 2 chunks') { TIMES.times { notifier_wan.notify!(LONG_HASH) } }
+end

data/gelf.gemspec

@@ -0,0 +1,70 @@
+Gem::Specification.new do |s|
+  s.name = "gelf_redux"
+  s.version = "3.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = ">= 1.9"
+  s.require_paths = ["lib"]
+  s.authors = ["Alexey Palazhchenko", "Lennart Koopmann", "Zac Sprackett", "Marcus Ilgner", "Sebastian Seidel"]
+  s.date = "2023-06-19"
+  s.description = "Library to send GELF messages to Graylog logging server. Supports plain-text, GELF messages and exceptions via UDP and TCP."
+  s.email = "admins@manet-marketing.de"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".gemtest",
+    "CHANGELOG",
+    "CONTRIBUTING.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "benchmarks/notifier.rb",
+    "gelf.gemspec",
+    "lib/gelf.rb",
+    "lib/gelf/logger.rb",
+    "lib/gelf/notifier.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",
+    "test/test_ruby_sender.rb",
+    "test/test_severity.rb"
+  ]
+  s.homepage = "https://github.com/manet-marketing/gelf_redux"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "Library to send GELF messages to Graylog logging server."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    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<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<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<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/logger.rb

@@ -0,0 +1,64 @@
+module GELF
+  # Methods for compatibility with Ruby Logger.
+  module LoggerCompatibility
+
+    attr_accessor :formatter
+
+    # Use it like Logger#add... or better not to use at all.
+    def add(level, message = nil, progname = nil, &block)
+      progname ||= default_options['facility']
+      message ||= block.call unless block.nil?
+
+      if message.nil?
+        message = progname
+        progname = default_options['facility']
+      end
+
+      message_hash = { 'facility' => progname }
+
+      if message.is_a?(Hash)
+        message.each do |key, value|
+          message_hash[key.to_s] = value.to_s
+        end
+      else
+        message_hash['short_message'] = message.to_s
+      end
+
+      if message.is_a?(Exception)
+        message_hash.merge!(self.class.extract_hash_from_exception(message))
+      end
+
+      if message_hash.key?('short_message') && !message_hash['short_message'].empty?
+        notify_with_level(level, message_hash)
+      end
+    end
+
+    # Redefines methods in +Notifier+.
+    GELF::Levels.constants.each do |const|
+      method_name = const.downcase
+
+      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)
+      notify_with_level(GELF::UNKNOWN, 'short_message' => 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
+  class Logger < Notifier
+    include LoggerCompatibility
+  end
+
+end