md-logstasher 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c18dc1deb3c464f76519b0d3ee05ba7d53c0f27
-  data.tar.gz: 2ed90acab2250ff497c14636f0bb45995d83dcd0
+SHA256:
+  metadata.gz: 2a3ecf9c0501945ebb201adb054bcb8e419ab6282e4373fcc5f83c141f0fe606
+  data.tar.gz: 52acbb7139d4f00775f0ad88115a0237dee699aa8ce42fc8b9c0aabdd9786438
 SHA512:
-  metadata.gz: 1aba3381d4c2bcfbc9d1d2d640246098a0a2f676a7675cc8b21997ea09151b1c3c9e1672972a1e771762253532bfc22cf9b647164844d7ac84b3d82b9701dc03
-  data.tar.gz: 7603f411836c855ec467122d243cd0e430894ccdc53aa8080ad6f064e1df7e6b36addd0f0d4aee9e7fa7bfca9aab0ba3669422c63fc421f772f320e9026b210e
+  metadata.gz: 074e9580a2b16e2d9d25c948559a43c74d03ea3de65854b20c36fbaeb2f921d77ea11206533bebe6b9ed490d1ffc5e5f0951db1ed83f9275c5309c39cb9a78b6
+  data.tar.gz: 8353c5595d42b6da680afbc7cf4b673bf23b5b2ba9f784e7bb9c1e5b34c5fe0faa3d9ba9c648cd449e50299691a7bb91f69b3ee46458d85f8074558146801c07

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,11 @@ 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)
+      when "stdout", :stdout then
+        $stdout
       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
@@ -29,9 +28,7 @@ module LogStasher
       fields.merge! extract_parameters(payload)
       fields.merge! appended_fields
 
-      event = LogStash::Event.new(fields.merge('tags' => tags))
-
-      LogStasher.logger << event.to_json + "\n"
+      LogStasher.log_as_json(fields.merge('tags' => tags), :as_logstash_event => true)
     end
 
     def redirect_to(event)
@@ -87,7 +84,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.2.0"
+  VERSION = "1.5.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
@@ -43,6 +44,22 @@ module LogStasher
       end
     end
 
+    def log_as_json(payload, as_logstash_event: false)
+      payload = payload.dup
+      payload.merge!(:metadata => metadata) if !metadata&.empty? && payload.is_a?(::Hash)
+
+      # Wrap the hash in a logstash event if the caller wishes for a specific
+      # formatting applied to the hash. This is used by log subscriber, for
+      # example.
+      json_payload = if as_logstash_event
+                       ::LogStash::Event.new(payload).to_json
+                     else
+                       payload.to_json
+                     end
+
+      logger << json_payload + $INPUT_RECORD_SEPARATOR
+    end
+
     def logger
       @logger ||= initialize_logger
     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,21 @@ 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 "can create stdout devices" do
+      device = ::LogStasher::Device.factory(:type => "stdout")
+      expect(device).to eq $stdout
+    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,9 +53,13 @@ describe LogStasher::LogSubscriber do
       :path       => '/users/1',
       :status     => 200
     }}
+    let(:data) { { "namespace" => "test", "appversion" => "v1" } }
 
     let(:event) { double(:payload => payload, :duration => duration) }
 
+    before { ::LogStasher.metadata = data }
+    after { ::LogStasher.metadata = {} }
+
     it 'logs the event in logstash format' do
       expect(logger).to receive(:<<) do |json|
         expect(JSON.parse(json)).to eq({
@@ -64,7 +75,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/logstasher_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe ::LogStasher do
+  describe "#log_as_json" do
+    it "calls the logger with the payload" do
+      expect(::LogStasher.logger).to receive(:<<) do |json|
+        expect(::JSON.parse(json)).to eq("yolo" => "brolo")
+      end
+
+      ::LogStasher.log_as_json(:yolo => :brolo)
+    end
+
+    context "with event" do
+      it "calls logger with a logstash event" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          payload = ::JSON.parse(json)
+
+          expect(payload["@timestamp"]).to_not be_nil
+          expect(payload["@version"]).to eq("1")
+          expect(payload["yolo"]).to eq("brolo")
+        end
+
+        ::LogStasher.log_as_json({:yolo => :brolo}, :as_logstash_event => true)
+      end
+    end
+
+    context "with metadata" do
+      before { ::LogStasher.metadata = { :namespace => :cooldude } }
+      after { ::LogStasher.metadata = {} }
+
+      it "calls logger with the metadata" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          expect(::JSON.parse(json)).to eq("yolo" => "brolo", "metadata" => { "namespace" => "cooldude" })
+        end
+
+        ::LogStasher.log_as_json(:yolo => :brolo)
+      end
+
+      it "does not merge metadata on an array" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          expect(::JSON.parse(json)).to eq([{ "yolo" => "brolo" }])
+        end
+
+        ::LogStasher.log_as_json([{:yolo => :brolo}])
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Devin Christensen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2022-01-27 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,8 +97,10 @@ 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/logstasher_spec.rb
 - spec/lib/logstasher/railtie_spec.rb
 - spec/lib/logstasher_spec.rb
 - spec/spec_helper.rb
@@ -105,7 +108,7 @@ homepage: https://github.com/moneydesktop/logstasher
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,16 +123,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-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/logstasher_spec.rb
 - spec/lib/logstasher/railtie_spec.rb
 - spec/lib/logstasher_spec.rb
 - spec/spec_helper.rb