logging-logstash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47cda14544b36f3fc8530e81e4bf310ebc6f6905
+  data.tar.gz: 73ed0b9d9541f09ae2a08fb29a8cb04b1839308f
+SHA512:
+  metadata.gz: d4fecaa072fc33f6f020b8a2057364f50a19a12dd19547c26fcbb8844d5b13cd435e0717fbf1e7ab8013103ba43b1bd323a7190124f54b8a94827f526c8e4ce9
+  data.tar.gz: cd7f1e7930649ef8d2da7a84f1d9d176db947db11a89c4a030be5bd889cad37ced37360df97e733f00d9623385f3a2ca12c4feffb47fac21a91794cf4f4b5112

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+
+group :development do
+  gem "rspec", "3.1.0"
+  gem "logging", "1.8.1"
+  gem "timecop", "~> 0.7.1"
+end
+# Specify your gem's dependencies in logging-logstash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Schrammel
+
+MIT License
+
+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,51 @@
+# Logging::Logstash
+
+This is a Logstash appender for the Logging framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logging-logstash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logging-logstash
+
+## Usage
+
+Configure it as an appender:
+
+    logger=Logging.logger["test"]
+    logger.add_appenders(Logging::Appenders.logstash('mylog',{:uri => 'tcp://localhost:5229'}))
+
+then log hashes or strings:
+
+    Logging.root.info("string")
+
+String messages will be logged like a {:message => message} hash.
+
+    Logging.root.info(:my => "string", :app => "myappname")
+
+The given hash will be enhanced by the following keys:
+ * @timestamp
+ * @version
+ * @severity (uppercase name of log level)
+ * @host (host of the logger)
+ * @log_name (the name you have given the appender)
+ * everything from the mdc (Mapped Diagnostic Context) hash
+ * everything from the ndc (Nested Diagnostic Context) array
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/logging-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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/logging/appenders/logstash.rb

@@ -0,0 +1,96 @@
+module Logging
+  module Appenders
+    def self.logstash(*args)
+      return Logging::Appenders::Logstash if args.empty?
+      Logging::Appenders::Logstash.new(*args)
+    end
+
+    # This class provides an Appender that can write to remote syslog.
+    #
+    class Logstash < Logging::Appender
+
+      def self.num_to_level(level_num)
+        @level_nums ||= Loggin::LEVELS..inject({}) do |hash, kv|
+          hash[kv[1]] = kv[0]; hash
+        end
+        @level_nums[level_num]
+      end
+
+      # call:
+      #    Logstash.new( name, opts = {} )
+      #
+      # Create an appender that will log messages to logstash. The
+      # options that can be used to configure the appender are as follows:
+      #
+      # it accepts all options of logstash logger: https://github.com/dwbutler/logstash-logger
+      #
+      def initialize(name, opts = {})
+        @host=opts.delete(:host) || Socket.gethostname
+        @logstash_device=LogStashLogger::Device.new(opts)
+        super
+      end
+
+
+      private
+
+      # to have a good entry point for testing
+      attr_reader :logstash_device
+
+      # call:
+      #    write( event )
+      #
+      # The trick is, that logging accepts all kind of objects to be logged. They are in
+      # the event.data and are raw (not turned into strings).
+      #
+      def write(event)
+        ls_event= data2logstash_event(event)
+
+        logstash_device.write(ls_event.to_json+"\n")
+        logstash_device.flush
+        self
+      end
+
+      def data2logstash_event(logging_event)
+        stash_event=if logging_event.data.kind_of?(Hash)
+                      LogStash::Event.new(logging_event.data.dup)
+                    else
+                      LogStash::Event.new("message" => msg2str(logging_event.data))
+                    end
+
+        stash_event['@severity'] ||= ::Logging::LNAMES[logging_event.level]
+        stash_event['@host'] ||= @host
+        stash_event['@log_name'] ||= @name
+
+        Logging.mdc.context.each do |key, value|
+          stash_event[key] ||= value #we don't overrdide given things
+        end
+
+        Logging.ndc.context.each do |ctx|
+          ctx.each do |key, value|
+            stash_event[key] ||= value #we don't overrdide given things
+          end
+        end
+
+# In case Time#to_json has been overridden
+        if stash_event.timestamp.is_a?(Time)
+          stash_event.timestamp = stash_event.timestamp.iso8601(3)
+        end
+        stash_event
+      end
+
+      def msg2str(msg)
+        case msg
+          when ::String
+            msg
+          when ::Exception
+            "#{ msg.message } (#{ msg.class })\n" <<
+                (msg.backtrace || []).join("\n")
+          else
+            msg.inspect
+        end
+      end
+
+
+    end # Logstash
+  end # Appenders
+end #Logging

data/lib/logging/logstash.rb

@@ -0,0 +1,10 @@
+# in case someone did a :require => false
+require "logging"
+require "logstash-logger"
+require "uri"
+require "socket"
+
+
+require 'logging/appender'
+require "logging/logstash/version"
+require 'logging/appenders/logstash'

data/lib/logging/logstash/version.rb

@@ -0,0 +1,5 @@
+module Logging
+  module Logstash
+    VERSION = "0.0.1"
+  end
+end

data/logging-logstash.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logging/logstash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logging-logstash"
+  spec.version       = Logging::Logstash::VERSION
+  spec.authors       = ["Peter Schrammel"]
+  spec.email         = ["peter.schrammel@gmx.de"]
+  spec.summary       = %q{A loggstash appender for the logging framework.}
+  spec.description   = %q{Allows you to log your mdc and hashes to logstash and keep the key-values for later analysis}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+  spec.add_dependency "logging", "~> 1.8.1"
+  spec.add_dependency "logstash-logger", "~> 0.7.0"
+end

data/spec/lib/logging/appenders/logstash_spec.rb

@@ -0,0 +1,86 @@
+RSpec.describe 'Logging::Appenders::Logstash' do
+  before do
+    FileUtils.rm_rf("/tmp/logstash.output")
+    Timecop.freeze(Time.local(2014, 12, 10, 10, 20, 19))
+    Logging.mdc.clear
+    Logging.ndc.clear
+  end
+
+  let(:appender) {
+    Logging::Appenders.logstash('logstash', :uri => "file:///tmp/logstash.output")
+  }
+
+  let(:logger) {
+    log = Logging.logger['example_logger']
+    log.add_appenders(appender)
+    log.level = :info
+    log
+  }
+
+  it "initializes via constructor Logging::Appenders.logstash" do
+    expect(appender).to be_instance_of(Logging::Appenders::Logstash)
+  end
+
+  it "writes a log with a string" do
+    logger.info("test")
+    expect(log_content).to eq({"message" => "test",
+                               "@timestamp" => "2014-12-10T10:20:19.000Z",
+                               "@version" => "1",
+                               "@severity" => "INFO",
+                               "@log_name" => "logstash",
+                               "@host" => "pa-dev"})
+  end
+
+  it "writes a log with a hash" do
+    logger.info("test" => 1, "test2" => "ok")
+    expect(log_content).to eq({"@timestamp" => "2014-12-10T10:20:19.000Z",
+                               "@version" => "1",
+                               "@severity" => "INFO",
+                               "@host" => "pa-dev",
+                               "@log_name" => "logstash",
+                               "test" => 1,
+                               "test2" => "ok"
+                              })
+  end
+
+  it "enhances the information with the mdc context" do
+    Logging.mdc["app"] = "core_api"
+    logger.happy("test" => 1, "test2" => "ok")
+    expect(log_content).to eq({"@timestamp" => "2014-12-10T10:20:19.000Z",
+                               "@version" => "1",
+                               "@severity" => "HAPPY",
+                               "@host" => "pa-dev",
+                               "@log_name" => "logstash",
+                               "test" => 1,
+                               "test2" => "ok",
+                               "app" => "core_api"
+                              })
+  end
+
+  it "enhances the information with the ndc context" do
+    Logging.ndc.push(:app => "myapp")
+    Logging.ndc.push(:subsystem => "sub1")
+
+    logger.happy("test" => 1, "test2" => "ok")
+    expect(log_content).to eq({"@timestamp" => "2014-12-10T10:20:19.000Z",
+                               "@version" => "1",
+                               "@severity" => "HAPPY",
+                               "@host" => "pa-dev",
+                               "@log_name" => "logstash",
+                               "test" => 1,
+                               "test2" => "ok",
+                               "app" => "myapp",
+                               "subsystem" => "sub1"
+                              })
+  end
+
+
+  it "escapes multilines correctly" do
+    logger.happy("test\ntest2")
+    expect(File.readlines("/tmp/logstash.output").size).to eq(1)
+  end
+
+  def log_content
+    JSON.parse(File.read("/tmp/logstash.output"))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# 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
+require 'timecop'
+require 'logging'
+require 'logging/logstash'
+
+#Have a undefined init error? run your specs without bundler (got a solution? -> Pull request)
+Logging.init(:DEBUG,:INFO,:HAPPY,:WARN,:FATAL)
+
+
+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,115 @@
+--- !ruby/object:Gem::Specification
+name: logging-logstash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Schrammel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: logstash-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Allows you to log your mdc and hashes to logstash and keep the key-values
+  for later analysis
+email:
+- peter.schrammel@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logging/appenders/logstash.rb
+- lib/logging/logstash.rb
+- lib/logging/logstash/version.rb
+- logging-logstash.gemspec
+- spec/lib/logging/appenders/logstash_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A loggstash appender for the logging framework.
+test_files:
+- spec/lib/logging/appenders/logstash_spec.rb
+- spec/spec_helper.rb