gelf.fitterpen 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c273e38f1b89ee4713dae4dde8a57aa057addcb693e8665d4636b548c4fe363
+  data.tar.gz: 790e29ccafba2ce08955729f6d53326f1e7b16db872a56da8ee4256b739f97c6
+SHA512:
+  metadata.gz: 03b34ca4e676b169a86b6918214a8b7560f953e348c98493a559d5ac3711b292397be41b1046482366ad03cef08d9b01cf10c94677e5ebd64a5624198ffc1d4b
+  data.tar.gz: 9411c770f4926769cb5f19473e2069be5a5dc9fc585dc86c2154fb6a0082e9ec120df430f6133d093ba3b4ad6c5266a073f57a4ed2a7fd0dd325ae4f8733fc31

data/.travis.yml

@@ -0,0 +1,17 @@
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.0
+- 2.2.0
+- 2.3.0
+- 2.4.0
+- jruby-19mode
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Pm1yAqo2ldet/Fd2jK5dKZkDNmyx5KkYtViL+eOR4Rxs82dwqOcCSyrBL6BOzuRfJtpjgXUX6FDapKgLDYW/2EDW8mmiciOL0WLzxYQsmJXcerJeUl2tTeFKpyEf+8aaDQpAlsK0m1dPmQjCJF9MWsa7m3oshm3mJ1VITY90chM=
+  gem: gelf
+  gemspec: gelf.gemspec
+  on:
+    tags: true
+    repo: graylog-labs/gelf-rb

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

@@ -0,0 +1,74 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.2)
+    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)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    json (1.8.6)
+    json (1.8.6-java)
+    jwt (1.5.4)
+    metaclass (0.0.4)
+    mini_portile2 (2.1.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    nokogiri (1.6.8-java)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      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.2.1)
+      power_assert
+    thread_safe (0.3.5)
+    thread_safe (0.3.5-java)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 2.1.1)
+  mocha (~> 1.1.0)
+  rack (< 2.0)
+  shoulda (~> 2.11.3)
+  test-unit (~> 3.2.0)
+
+BUNDLED WITH
+   1.14.6

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,63 @@
+## GELF Ruby library
+
+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 Graylog or Logstash instances. See the [GELF specification](http://docs.graylog.org/en/stable/pages/gelf.html) for more information about GELF and [RDoc](http://rdoc.info/github/graylog-labs/gelf-rb/master/frames) for API documentation.
+
+Tested with Ruby 1.9, 2.0, 2.1, 2.2, 2.3 and 2.4.
+
+[![Build Status](https://travis-ci.org/graylog-labs/gelf-rb.svg?branch=master)](https://travis-ci.org/graylog-labs/gelf-rb)
+[![Code Climate](https://codeclimate.com/github/graylog-labs/gelf-rb/badges/gpa.svg)](https://codeclimate.com/github/graylog-labs/gelf-rb)
+
+## 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,60 @@
+require 'rake'
+
+begin
+  require 'ci/reporter/rake/test_unit'
+rescue LoadError
+  # nothing
+end
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    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 = "mail@marcusilgner.com"
+    gem.homepage = "http://github.com/Graylog2/gelf-rb"
+    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
+  end
+rescue LoadError => e
+  puts e
+  abort "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+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,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: gelf 3.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "gelf.fitterpen"
+  s.version = "3.1.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", "Marcus Ilgner"]
+  s.date = "2018-09-05"
+  s.description = "Library to send GELF messages to Graylog logging server. Supports plain-text, GELF messages and exceptions via UDP and TCP."
+  s.email = "mail@marcusilgner.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".gemtest",
+    ".travis.yml",
+    "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/graylog-labs/gelf-rb"
+  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<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>, ["~> 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>, ["~> 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/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