log4r-logstash 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2E5YWU1NjBiYTY5ZTJlYzYzNjkxZWQ5ZjZhNTY0MWUzZjNjN2I5MQ==
+  data.tar.gz: !binary |-
+    ZWVhNjc5NGIxZjQzMmFlMDUzODJlMzZiZDllZDM0NGRiMjBkNmRlNw==
+SHA512:
+  metadata.gz: !binary |-
+    NmE1NWZlNmExMTQyZGJkZTgzYTJlZDBjYjY2YjRiMTNlYWZmYWQ2ZjRhZGFj
+    MzlkODAxMDQ4MjM4NDE0OTk0ODU3ZWY0OTUxNWQ2ZWZhMmMyMjJmMzdmMDAy
+    M2JlNzYxMTkwNTMzNDJiY2E5YjAyMjY1YTBkZDI3MjQ1NDg0MjI=
+  data.tar.gz: !binary |-
+    OGNkMDVlOGRmZTk1NGVkYmM3M2QxNzcwNTJiNjIyMjBmYjJiYjkzNmU4MDI2
+    MDcxYTE2NmRkNDk4NzhmZTc3NGYxMGYyNTg3ZWQ4YWI3NmJkNThhYjkyOGU3
+    MjJkNzhmZDJlN2UzOTZmOWUxYzNmNzdiNTdlOWY1Y2Q5YmMxNjQ=

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.vagrant/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'Vagrantfile'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+deploy:
+  provider: rubygems
+  gem: log4r-logstash
+  api_key:
+    secure: X5VNoys5YafYfpx2nuC8kjKqOSwFAKCFWizEsuaD77WtXXpgwYbhvuGxdkBqaRrV2fw+24V+ZnwibiuCbPdfd6rwgLEsOWnQk3uf5JG+a2cegoklM5fX5jneZxE5uNEa8Il45GCTApWpknvejIKYyzzG8uknnautTAEIK/gh7Rw=
+  on:
+    tags: true
+    all_branches: true

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in log4r-logstash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2015 Cimpress
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,93 @@
+# log4r-logstash
+
+log4r-logstash allows you to send Log4r logevents to Logstash with json encoding.
+It currently only supports a redis transport, but could easily be extended to other
+transports based on need.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log4r-logstash'
+```
+
+And then execute:
+
+    $ bundled
+
+Or install it yourself as:
+
+    $ gem install log4r-logstash
+
+## Usage
+
+```ruby
+Log = Log4r::Logger.new("outofthebox")        # create a logger
+Log.add Log4r::Logstash::RedisOutputter.new("redis")
+Log.debug("test")
+# : Sends the following json to 127.0.0.1:6379
+# {
+#   "type":"Log4r::LogEvent",
+#   "index":"logstash",
+#   "level":"DEBUG",
+#   "data":"test",
+#   "timestamp":"2015-01-27T19:44:29Z"
+# }
+```
+Send to redis running on another host
+
+```ruby
+Log.add Log4r::Logstash::RedisOutputter.new("redis", host: "myredisserver.mydomain.com")
+```
+
+Specify an index name
+```ruby
+Log.add Log4r::Logstash::RedisOutputter.new("redis", index: "my_index")
+```
+
+You can override many of the default field names to match your conventions
+
+```ruby
+Log.add Log4r::Logstash::RedisOutputter.new("redis",
+                                            level_field_name: "LEVEL"
+                                            data_field_name: "MESSAGE")
+# {
+#   "type":"Log4r::LogEvent",
+#   "index":"logstash",
+#   "LEVEL":"DEBUG",
+#   "MESSAGE":"test",
+# }
+```
+
+Add extra fields as necessary for your application. These will be passed straight
+through in the json as top level key-value pairs.
+
+```ruby
+Log.add Log4r::Logstash::RedisOutputter.new("redis", additional_fields: {
+                                                       foo: "bar",
+                                                       goo: "baz"
+                                                       time: -> { Time.now.getutc.rfc822 }
+                                                     })
+# {
+#   "type":"Log4r::LogEvent",
+#   "index":"logstash",
+#   "level":"DEBUG",
+#   "data":"test",
+#   "timestamp":"2015-01-27T19:44:29Z"
+#   "foo":"bar"
+#   "goo":"baz"
+#   "time":"Wed, 27 Jan 2015 19:44:29 -000"
+# }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Cimpress-MCP/log4r-logstash/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+You can spin up a local redis instance in virtualbox by using the included Vagrantfile
+and typing `vagrant up`. Monitor incoming messages using `vagrant ssh -c "redis-cli monitor"`

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: :build
+task build: [:rubocop, :spec]

data/Vagrantfile

@@ -0,0 +1,18 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+$script = <<SCRIPT
+apt-get update
+apt-get install -y redis-server
+sed -i '/bind 127.0.0.1/c\\#bind 127.0.0.1' /etc/redis/redis.conf
+redis-server &
+SCRIPT
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.network :forwarded_port, host: 6379, guest: 6379
+  config.vm.provision "shell", inline: $script
+  config.vm.box = "ubuntu/trusty64"
+end

data/examples/redis.rb

@@ -0,0 +1,35 @@
+# Here's how to start using log4r right away
+$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "/lib")
+require "log4r"
+require "log4r/logstash"
+require "securerandom"
+
+Log = Log4r::Logger.new("outofthebox")        # create a logger
+Log.add Log4r::Outputter.stderr               # which logs to stdout
+
+r = SecureRandom.uuid
+
+additional_fields = {}
+additional_fields["foo"] = "bar"
+additional_fields["goo"] = "baz"
+additional_fields["random"] = -> { r }
+
+Log.add Log4r::Logstash::RedisOutputter.new("redis",
+                                            data_field_name: "Message",
+                                            level_field_name: "Level",
+                                            additional_fields: additional_fields)
+
+# do some logging
+def do_logging
+  Log.debug "debugging"
+  Log.info "a piece of info"
+  Log.warn "Danger, Will Robinson, danger!"
+  Log.error "I dropped my Wookie! :("
+  Log.fatal "kaboom!"
+end
+do_logging
+
+# now let's filter anything below WARN level (DEBUG and INFO)
+puts "-= Changing level to WARN =-"
+Log.level = Log4r::WARN
+do_logging

data/lib/log4r/logstash/formatter/json_formatter.rb

@@ -0,0 +1,28 @@
+require "json"
+require "time"
+
+module Log4r
+  module Logstash
+    class JsonFormatter
+      def self.format(logevent, index,
+                     data_field_name = "data", level_field_name = "level",
+                     additional_fields = {})
+        data = {}
+        data["type"] = "#{logevent.class}"
+        data["index"] = "#{index}"
+        data["timestamp"] = Time.now.getutc.iso8601
+        data[level_field_name] = LNAMES[logevent.level]
+        data[data_field_name] = logevent.data
+        data.merge! eval_map_proc_values(additional_fields)
+        data.to_json
+      end
+
+      def self.eval_map_proc_values(map)
+        map.each do |key, value|
+          map[key] = value.call if value.class == Proc
+        end
+        map
+      end
+    end
+  end
+end

data/lib/log4r/logstash/outputter/redis_outputter.rb

@@ -0,0 +1,46 @@
+require "log4r/outputter/outputter"
+require "redis"
+require "retryable"
+
+require_relative "../formatter/json_formatter"
+
+module Log4r
+  module Logstash
+    class RedisOutputter < Log4r::Outputter
+      def initialize(name, hash = {})
+        super(name, hash)
+
+        @index = hash[:index] || "logstash"
+        @additional_fields = hash[:additional_fields] || {}
+        @data_field_name = hash[:data_field_name] || "data"
+        @level_field_name = hash[:level_field_name] || "level"
+        @timestamp_field_name = hash[:timestamp_field_name] || "timestamp"
+
+        init_redis(hash[:host], hash[:port])
+      end
+
+      private
+
+      def init_redis(host, port)
+        host ||= "127.0.0.1"
+        port = (port || 6379).to_i
+        @redis = Redis.new(host: host, port: port)
+      end
+
+      def canonical_log(logevent)
+        json = JsonFormatter.format(logevent, @index, @data_field_name,
+                                    @level_field_name,
+                                    @additional_fields)
+        tries = 3
+        begin
+          Retryable.retryable(tries: tries, sleep: ->(n) { 2**n }) do
+            @redis.rpush @index, json
+          end
+        rescue
+          raise "Unable to connect to #{@redis.inspect} after #{tries} tries. \
+Please confirm your ability to connect to that redis instance."
+        end
+      end
+    end
+  end
+end

data/lib/log4r/logstash/version.rb

@@ -0,0 +1,5 @@
+module Log4r
+  module Logstash
+    VERSION = "0.1.0"
+  end
+end

data/lib/log4r/logstash.rb

@@ -0,0 +1,7 @@
+require "log4r/logstash/version"
+
+module Log4r
+  module Logstash
+    autoload :RedisOutputter, "log4r/logstash/outputter/redis_outputter.rb"
+  end
+end

data/log4r-logstash.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log4r/logstash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log4r-logstash"
+  spec.version       = Log4r::Logstash::VERSION
+  spec.authors       = ["Christopher Baldauf"]
+  spec.email         = ["cbaldauf@cimpress.com"]
+  spec.summary       = %q{Ship json encoded log4r messages to logstash.}
+  spec.homepage      = "http://github.com/Cimpress-MCP/log4r-logstash"
+  spec.license       = "Apache 2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rubocop", "~> 0.28"
+
+  spec.add_runtime_dependency "log4r", "~> 1.1"
+  spec.add_runtime_dependency "redis", "~> 3.2"
+  spec.add_runtime_dependency "retryable", "~> 2.0"
+end

data/spec/log4r/logstash/formatter/json_formatter_spec.rb

@@ -0,0 +1,54 @@
+require "log4r/logstash/formatter/json_formatter"
+require "log4r/logger"
+require "log4r/logevent"
+require "securerandom"
+
+describe Log4r::Logstash::JsonFormatter do
+  let(:logevent) do
+    logger = Log4r::Logger.new("my test logger")
+    Log4r::LogEvent.new(1, logger, nil, "my test log message")
+  end
+  let(:index) { "my_index_name" }
+
+  describe "basic formatting" do
+    it "handles a log event" do
+      json = Log4r::Logstash::JsonFormatter.format(logevent, index)
+      expect(json).to include('"type":"Log4r::LogEvent"')
+      expect(json).to include('"index":"my_index_name"')
+      expect(json).to include('"timestamp":')
+      expect(json).to include('"level":"DEBUG"')
+      expect(json).to include('"data":"my test log message"')
+    end
+  end
+
+  describe "data field name" do
+    it "can be overridden" do
+      expect(Log4r::Logstash::JsonFormatter.format(logevent, index, "DATA")).to include('"DATA":"my test log message"')
+    end
+  end
+
+  describe "level field name" do
+    it "can be overridden" do
+      expect(Log4r::Logstash::JsonFormatter.format(logevent, index, nil, "LEVEL")).to include('"LEVEL":"DEBUG"')
+    end
+  end
+
+  describe "additional fields" do
+    it "include literals" do
+      additional_fields = {}
+      additional_fields["foo"] = "bar"
+      additional_fields["goo"] = "baz"
+      json = Log4r::Logstash::JsonFormatter.format(logevent, index, nil, nil, additional_fields)
+      expect(json).to include('"foo":"bar"')
+      expect(json).to include('"goo":"baz"')
+    end
+
+    it "evaluates lambdas" do
+      r = SecureRandom.uuid
+      additional_fields = {}
+      additional_fields["foo"] = -> { r }
+      json = Log4r::Logstash::JsonFormatter.format(logevent, index, nil, nil, additional_fields)
+      expect(json).to include('"foo":"' + r + '"')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  #   # For more details, see:
+  #   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: log4r-logstash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Baldauf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- cbaldauf@cimpress.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- examples/redis.rb
+- lib/log4r/logstash.rb
+- lib/log4r/logstash/formatter/json_formatter.rb
+- lib/log4r/logstash/outputter/redis_outputter.rb
+- lib/log4r/logstash/version.rb
+- log4r-logstash.gemspec
+- spec/log4r/logstash/formatter/json_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Cimpress-MCP/log4r-logstash
+licenses:
+- Apache 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ship json encoded log4r messages to logstash.
+test_files:
+- spec/log4r/logstash/formatter/json_formatter_spec.rb
+- spec/spec_helper.rb