md-logstasher 1.0.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4563d96cf88d8a5e5fa8c1a263ed5e79c2fa2acc
-  data.tar.gz: edbcb27c41a3068d29fb1d896131a81035391c3d
+SHA256:
+  metadata.gz: 5f6a2e729c225c8fb2cf06174d9fc5282ae0b2ee660fd89d675a30e7fcd19eb3
+  data.tar.gz: 9a8dea2258d1ed2c0fb1c01227bf7ea6b78421ca342ba122a32cc8f1351b7440
 SHA512:
-  metadata.gz: f2bcdf71a918cbed00947a631abbd3a444dee9918afd8eb3d1947e4f092fc8569327ee088bb5aa890d5900fc959879dc3e9da3fcac96d675d36a6ea2db66e08f
-  data.tar.gz: 77f0394fb5e701c380176ae702412d07c8b24faa31d6f67ec60969ad3e5f42499c763bcd4e6d78efbb19ba1750750619d074e9e4e011e65d306b1d50a231c3cc
+  metadata.gz: d23d146376ea21233a2b1189366586cbecc46f4a5694ffb1b7cae480881098828f7e9e79f171cf7f1c52372b793f53aff40d86dd444a4aee4e8a12e9334e2e7a
+  data.tar.gz: f6a8c91e937935dac803868c098e8b6826cb0b27f72fe5718bf8fcebad2685acdeb899e8055d6ee6cc2a4420bcf3465a7e3557e99875b8b2fbf8fbccd5c90618

data/lib/logstasher/device/redis.rb

@@ -59,7 +59,7 @@ module LogStasher
 
       def validate_options
         unless ['list', 'channel'].include?(options['data_type'])
-          fail 'Expected data_type to be either "list" or "channel"'
+          fail RuntimeError, 'Expected data_type to be either "list" or "channel"'
         end
       end
     end

data/lib/logstasher/device/syslog.rb

@@ -2,34 +2,27 @@
 
 require 'logstasher/device'
 require 'syslog'
-require 'thread'
 
 module LogStasher
   module Device
     class Syslog
       include ::LogStasher::Device
 
-      SEMAPHORE = Mutex.new
-
       attr_reader :options
 
       def initialize(options = {})
         raw_options = default_options.merge(stringify_keys(options))
 
         @options = parse_options(raw_options)
-        @closed  = false
+        open_syslog
       end
 
       def close
-        SEMAPHORE.synchronize do
-          ::Syslog.close if ::Syslog.opened?
-        end
-
-        @closed = true
+        ::Syslog.close rescue nil
       end
 
       def closed?
-        @closed
+        !::Syslog.opened?
       end
 
       def facility
@@ -49,11 +42,10 @@ module LogStasher
       end
 
       def write(log)
-        fail ::RuntimeError, 'Cannot write. The device has been closed.' if closed?
+        fail ::RuntimeError, 'Syslog has been closed.' if closed?
+        fail ::RuntimeError, 'Syslog re-configured unexpectedly.' if syslog_config_changed?
 
-        with_syslog_open do
-          ::Syslog.log(priority, '%s', log)
-        end
+        ::Syslog.log(priority, '%s', log)
       end
 
       private
@@ -63,10 +55,18 @@ module LogStasher
           'identity' => 'logstasher',
           'facility' => ::Syslog::LOG_LOCAL0,
           'priority' => ::Syslog::LOG_INFO,
-          'flags'    => ::Syslog::LOG_PID | ::Syslog::LOG_CONS
+          'flags'    => ::Syslog::LOG_PID | ::Syslog::LOG_CONS,
         }
       end
 
+      def open_syslog
+        if ::Syslog.opened?
+          ::Syslog.reopen(identity, flags, facility)
+        else
+          ::Syslog.open(identity, flags, facility)
+        end
+      end
+
       def parse_option(value)
         case value
         when ::String
@@ -85,20 +85,8 @@ module LogStasher
         options
       end
 
-      def syslog_configured?
-        ::Syslog.ident == identity && ::Syslog.options == flags && ::Syslog.facility == facility
-      end
-
-      def with_syslog_open
-        SEMAPHORE.synchronize do
-          if ::Syslog.opened?
-            ::Syslog.reopen(identity, flags, facility) unless syslog_configured?
-          else
-            ::Syslog.open(identity, flags, facility)
-          end
-
-          yield
-        end
+      def syslog_config_changed?
+        ::Syslog.ident != identity || ::Syslog.options != flags || ::Syslog.facility != facility
       end
     end
   end

data/lib/logstasher/device/udp.rb

@@ -0,0 +1,40 @@
+# simple UDP logger
+
+require 'logstasher/device'
+require 'socket'
+
+
+module LogStasher
+  module Device
+    class UDP
+      include ::LogStasher::Device
+
+      attr_reader :options, :socket
+
+      def initialize(options = {})
+        @options = default_options.merge(stringify_keys(options))
+        @socket = UDPSocket.new
+      end
+
+      def close
+        @socket.close
+      end
+
+      def write(log)
+        @socket.send(log, 0, options['hostname'], options['port'])
+      end
+
+      private
+
+      def default_options
+        {
+          'hostname' => '127.0.0.1',
+          'port'     => 31459,
+        }
+      end
+    end
+  end
+end
+
+
+

data/lib/logstasher/device.rb

@@ -11,6 +11,9 @@ module LogStasher
       when "syslog", :syslog then
         require 'logstasher/device/syslog'
         ::LogStasher::Device::Syslog.new(config)
+      when "udp", :udp then
+        require 'logstasher/device/udp'
+        ::LogStasher::Device::UDP.new(config)
       else
         fail ArgumentError, "Unknown type: #{type}"
       end

data/lib/logstasher/log_subscriber.rb

@@ -21,7 +21,6 @@ module LogStasher
       payload = event.payload
       tags    = extract_tags(payload)
       fields  = extract_request(payload)
-
       fields.merge! extract_status(payload)
       fields.merge! runtimes(event)
       fields.merge! location
@@ -52,15 +51,19 @@ module LogStasher
     end
 
     def extract_request(payload)
-      {
+      result = {
         :action     => payload[:action],
         :controller => payload[:controller],
         :format     => extract_format(payload),
         :ip         => request.remote_ip,
+        :request_id => request.env["action_dispatch.request_id"],
         :method     => payload[:method],
         :path       => extract_path(payload),
         :route      => "#{payload[:controller]}##{payload[:action]}"
       }
+      metadata = ::LogStasher.metadata
+      result.merge!(:metadata => metadata) unless metadata&.empty?
+      result
     end
 
     # Monkey patching to enable exception logging
@@ -86,7 +89,6 @@ module LogStasher
     def extract_parameters(payload)
       if LogStasher.include_parameters?
         external_params = payload[:params].except(*INTERNAL_PARAMS)
-
         if LogStasher.serialize_parameters?
           { :params => JSON.generate(external_params) }
         else

data/lib/logstasher/railtie.rb

@@ -8,6 +8,7 @@ module LogStasher
     config.logstasher.logger = nil
     config.logstasher.log_level = ::Logger::INFO
 
+    config.logstasher.metadata  = {}
     config.before_initialize do
       options = config.logstasher
 
@@ -17,6 +18,7 @@ module LogStasher
       ::LogStasher.silence_standard_logging = options.silence_standard_logging
       ::LogStasher.logger                   = options.logger || default_logger
       ::LogStasher.logger.level             = options.log_level
+      ::LogStasher.metadata                 = options.metadata
     end
 
     initializer 'logstasher.load' do

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "1.0.5"
+  VERSION = "1.4.0"
 end

data/lib/logstasher.rb

@@ -8,6 +8,7 @@ module LogStasher
     attr_writer :include_parameters
     attr_writer :serialize_parameters
     attr_writer :silence_standard_logging
+    attr_accessor :metadata
 
     def append_fields(&block)
       @append_fields_callback = block

data/spec/lib/logstasher/device/redis_spec.rb

@@ -40,7 +40,7 @@ describe LogStasher::Device::Redis do
   it 'does not allow unsupported data types' do
     expect {
       device = LogStasher::Device::Redis.new(data_type: 'blargh')
-    }.to raise_error()
+    }.to raise_error(::RuntimeError)
   end
 
   it 'quits the redis connection on #close' do

data/spec/lib/logstasher/device/syslog_spec.rb

@@ -14,9 +14,9 @@ describe LogStasher::Device::Syslog do
   before { allow(::Syslog).to receive(:log) }
 
   around do |example|
-    ::Syslog.close if ::Syslog.opened?
+    ::Syslog.close rescue nil
     example.run
-    ::Syslog.close if ::Syslog.opened?
+    ::Syslog.close rescue nil
   end
 
   it 'has default options' do
@@ -64,25 +64,37 @@ describe LogStasher::Device::Syslog do
     expect(device.flags).to eq(::Syslog::LOG_NOWAIT | ::Syslog::LOG_ODELAY)
   end
 
-  describe '#write' do
-    subject { LogStasher::Device::Syslog.new }
+  it 'opens syslog when it is closed' do
+    expect(::Syslog).to receive(:open).with(
+      default_options['identity'],
+      default_options['flags'],
+      default_options['facility'],
+    )
 
-    it 'opens syslog when syslog is closed' do
-      expect(::Syslog).to receive(:open).with(subject.identity, subject.flags, subject.facility)
-      subject.write('a log')
-    end
+    LogStasher::Device::Syslog.new
+  end
 
-    it 'does not re-open syslog when its config is in sync' do
-      ::Syslog.open(subject.identity, subject.flags, subject.facility)
-      expect(::Syslog).not_to receive(:open)
-      expect(::Syslog).not_to receive(:reopen)
-      subject.write('a log')
-    end
+  it 're-opens syslog when it is already opened' do
+    ::Syslog.open('temp', ::Syslog::LOG_NDELAY, ::Syslog::LOG_AUTH)
 
-    it 're-opens syslog when its config is out of sync' do
-      ::Syslog.open('temp', ::Syslog::LOG_NDELAY, ::Syslog::LOG_AUTH)
-      expect(::Syslog).to receive(:reopen).with(subject.identity, subject.flags, subject.facility)
-      subject.write('a log')
+    expect(::Syslog).to receive(:reopen).with(
+      default_options['identity'],
+      default_options['flags'],
+      default_options['facility'],
+    )
+
+    LogStasher::Device::Syslog.new
+  end
+
+  describe '#write' do
+    subject { LogStasher::Device::Syslog.new }
+
+    it 'fails when the syslog config is out of sync' do
+      subject
+      ::Syslog.reopen('temp', ::Syslog::LOG_NDELAY, ::Syslog::LOG_AUTH)
+      expect {
+        subject.write('a log')
+      }.to raise_error(::RuntimeError, 'Syslog re-configured unexpectedly.')
     end
 
     it 'writes the log to syslog' do
@@ -94,7 +106,7 @@ describe LogStasher::Device::Syslog do
       subject.close
       expect {
         subject.write('a log')
-      }.to raise_error(::RuntimeError, 'Cannot write. The device has been closed.')
+      }.to raise_error(::RuntimeError, 'Syslog has been closed.')
     end
   end
 
@@ -106,15 +118,9 @@ describe LogStasher::Device::Syslog do
       expect(subject).to be_closed
     end
 
-    it 'closes syslog when syslog is open' do
-      ::Syslog.open(subject.identity, subject.flags, subject.facility)
+    it 'closes syslog' do
       expect(::Syslog).to receive(:close)
       subject.close
     end
-
-    it 'does not close syslog if it is already closed' do
-      expect(::Syslog).not_to receive(:close)
-      subject.close
-    end
   end
 end

data/spec/lib/logstasher/device/udp_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require 'logstasher/device/udp'
+
+describe LogStasher::Device::UDP do
+
+  let(:default_options) {{
+                           'hostname' => '127.0.0.1',
+                           'port' => 31459
+                         }}
+
+  it 'has default options' do
+    device = LogStasher::Device::UDP.new
+    expect(device.options).to eq(default_options)
+  end
+
+  it 'closes the udp socket on #close' do
+    device = LogStasher::Device::UDP.new
+    expect(device.socket).to receive(:close)
+    device.close
+  end
+
+  it 'works as a logger device' do
+    device = LogStasher::Device::UDP.new
+    expect(device).to receive(:write).with('foo')
+    logger = Logger.new(device)
+    logger << 'foo'
+  end
+
+  describe '#write' do
+    subject { LogStasher::Device::UDP.new }
+    it 'writes the log to the the socket' do
+      expect(subject.socket).to receive(:send).with('a log', 0, default_options['hostname'], default_options['port'])
+      subject.write('a log')
+    end
+  end  
+end

data/spec/lib/logstasher/device_spec.rb

@@ -3,6 +3,7 @@ require "spec_helper"
 require "logstasher/device"
 require "logstasher/device/redis"
 require "logstasher/device/syslog"
+require "logstasher/device/udp"
 
 describe LogStasher::Device do
   describe ".factory" do
@@ -47,7 +48,17 @@ describe LogStasher::Device do
       device = ::LogStasher::Device.factory(:type => "syslog")
       expect(device).to be_a_kind_of(::LogStasher::Device::Syslog)
     end
+    
+    it "can create udp devices" do
+      expect(
+        ::LogStasher::Device
+       ).to receive(:require).with("logstasher/device/udp")
+
+      device = ::LogStasher::Device.factory(:type => "udp")
+      expect(device).to be_a_kind_of(::LogStasher::Device::UDP)
+    end
 
+    
     it "fails to create unknown devices" do
       expect {
         ::LogStasher::Device.factory(:type => "unknown")

data/spec/lib/logstasher/log_subscriber_spec.rb

@@ -10,6 +10,12 @@ class MockController
 end
 
 class MockRequest
+  attr_accessor :env
+
+  def initialize
+    @env = { 'action_dispatch.request_id' => 1 }
+  end
+
   def remote_ip
     '127.0.0.1'
   end
@@ -19,6 +25,7 @@ describe LogStasher::LogSubscriber do
   subject { described_class.new }
 
   let(:logger) { ::Logger.new('/dev/null') }
+
   let(:mock_controller) { MockController.new }
   let(:mock_request) { MockRequest.new }
   let(:context) {{ :controller => mock_controller, :request => mock_request }}
@@ -46,10 +53,12 @@ describe LogStasher::LogSubscriber do
       :path       => '/users/1',
       :status     => 200
     }}
+    let(:data) { { "namespace" => "test", "appversion" => "v1" } }
 
     let(:event) { double(:payload => payload, :duration => duration) }
 
     it 'logs the event in logstash format' do
+      ::LogStasher.metadata = data
       expect(logger).to receive(:<<) do |json|
         expect(JSON.parse(json)).to eq({
           '@timestamp' => timestamp,
@@ -64,7 +73,9 @@ describe LogStasher::LogSubscriber do
           'path'       => payload[:path],
           'route'      => "#{payload[:controller]}##{payload[:action]}",
           'status'     => payload[:status],
-          'runtime'    => { 'total' => duration }
+          'runtime'    => { 'total' => duration },
+          'request_id' => 1,
+          'metadata'   => data
         })
       end
 

data/spec/lib/logstasher/railtie_spec.rb

@@ -19,12 +19,6 @@ describe ::LogStasher::Railtie do
   let(:config) { described_class.config.logstasher }
 
   describe 'logstasher.configure' do
-    subject do
-      described_class.instance.initializers.find do |initializer|
-        initializer.name == 'logstasher.configure'
-      end
-    end
-
     it 'should configure LogStasher' do
       config.logger                   = ::Logger.new('/dev/null')
       config.log_level                = "log_level"
@@ -40,7 +34,7 @@ describe ::LogStasher::Railtie do
       expect(::LogStasher).to receive(:logger=).with(config.logger).and_call_original
       expect(config.logger).to receive(:level=).with("log_level")
 
-      subject.run
+      ActiveSupport.run_load_hooks(:before_initialize)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Devin Christensen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -85,6 +85,7 @@ files:
 - lib/logstasher/device.rb
 - lib/logstasher/device/redis.rb
 - lib/logstasher/device/syslog.rb
+- lib/logstasher/device/udp.rb
 - lib/logstasher/log_subscriber.rb
 - lib/logstasher/railtie.rb
 - lib/logstasher/silent_logger.rb
@@ -96,6 +97,7 @@ files:
 - logstasher.gemspec
 - spec/lib/logstasher/device/redis_spec.rb
 - spec/lib/logstasher/device/syslog_spec.rb
+- spec/lib/logstasher/device/udp_spec.rb
 - spec/lib/logstasher/device_spec.rb
 - spec/lib/logstasher/log_subscriber_spec.rb
 - spec/lib/logstasher/railtie_spec.rb
@@ -105,7 +107,7 @@ homepage: https://github.com/moneydesktop/logstasher
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,14 +122,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.28
+signing_key:
 specification_version: 4
 summary: Awesome rails logs
 test_files:
 - spec/lib/logstasher/device/redis_spec.rb
 - spec/lib/logstasher/device/syslog_spec.rb
+- spec/lib/logstasher/device/udp_spec.rb
 - spec/lib/logstasher/device_spec.rb
 - spec/lib/logstasher/log_subscriber_spec.rb
 - spec/lib/logstasher/railtie_spec.rb