md-logstasher 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f6a2e729c225c8fb2cf06174d9fc5282ae0b2ee660fd89d675a30e7fcd19eb3
-  data.tar.gz: 9a8dea2258d1ed2c0fb1c01227bf7ea6b78421ca342ba122a32cc8f1351b7440
+  metadata.gz: 628b152041e0a0d8218761c1ab723f43b16ff6a9746fcf102e5b0a8d03aea76e
+  data.tar.gz: a3283254f14aef786d70dda74cae35d081d607e67a37522fff292ddab6119e80
 SHA512:
-  metadata.gz: d23d146376ea21233a2b1189366586cbecc46f4a5694ffb1b7cae480881098828f7e9e79f171cf7f1c52372b793f53aff40d86dd444a4aee4e8a12e9334e2e7a
-  data.tar.gz: f6a8c91e937935dac803868c098e8b6826cb0b27f72fe5718bf8fcebad2685acdeb899e8055d6ee6cc2a4420bcf3465a7e3557e99875b8b2fbf8fbccd5c90618
+  metadata.gz: 68806d2f4d08aa90a7c61487d2101e9cbfa2802d1021986dc39d1d9469196d8524d6e07cdcb63b3df104c0198beff6b9510f3f2d876ddc79b4c565b5f2d2fe1e
+  data.tar.gz: 38f876594090f8a545dcfcd5380142bbfb1d9b34c726b2d0cb6de96d547ee41aaf5463c245279adbe50d694f9ab6be0a30fd6cdc45ffd0ccf5efd1e66322065f

data/lib/logstasher/device.rb

@@ -14,6 +14,8 @@ module LogStasher
       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

@@ -28,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)
@@ -51,7 +49,7 @@ module LogStasher
     end
 
     def extract_request(payload)
-      result = {
+      {
         :action     => payload[:action],
         :controller => payload[:controller],
         :format     => extract_format(payload),
@@ -61,9 +59,6 @@ module LogStasher
         :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

data/lib/logstasher/railtie.rb

@@ -5,6 +5,7 @@ module LogStasher
     config.logstasher.include_parameters = true
     config.logstasher.serialize_parameters = true
     config.logstasher.silence_standard_logging = false
+    config.logstasher.silence_creation_message = true
     config.logstasher.logger = nil
     config.logstasher.log_level = ::Logger::INFO
 
@@ -49,7 +50,9 @@ module LogStasher
     def default_logger
       unless @default_logger
         path = ::Rails.root.join('log', "logstash_#{::Rails.env}.log")
-        ::FileUtils.touch(path) # prevent autocreate messages in log
+        if config.logstasher.silence_creation_message
+          ::FileUtils.touch(path) # prevent autocreate messages in log
+        end
 
         @default_logger =  ::Logger.new(path)
       end

data/lib/logstasher/version.rb

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

data/lib/logstasher.rb

@@ -44,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_spec.rb

@@ -58,6 +58,10 @@ describe LogStasher::Device do
       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 {

data/spec/lib/logstasher/log_subscriber_spec.rb

@@ -57,8 +57,10 @@ describe LogStasher::LogSubscriber do
 
     let(:event) { double(:payload => payload, :duration => duration) }
 
+    before { ::LogStasher.metadata = data }
+    after { ::LogStasher.metadata = {} }
+
     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,

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

data/spec/lib/logstasher/railtie_spec.rb

@@ -18,6 +18,24 @@ end
 describe ::LogStasher::Railtie do
   let(:config) { described_class.config.logstasher }
 
+  describe 'logstasher should touch log file to prevent creation message by default' do
+    it 'should configure LogStasher' do
+      expect(::FileUtils).to receive(:touch)
+      ActiveSupport.run_load_hooks(:before_initialize)
+    end
+  end
+
+  describe 'logstasher should NOT touch log file if silence disabled' do
+    before { config.silence_creation_message = false }
+    after { config.silence_creation_message = true }
+
+    it 'should configure LogStasher' do
+      expect(::FileUtils).not_to receive(:touch)
+      ActiveSupport.run_load_hooks(:before_initialize)
+    end
+  end
+
+
   describe 'logstasher.configure' do
     it 'should configure LogStasher' do
       config.logger                   = ::Logger.new('/dev/null')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Devin Christensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -100,6 +100,7 @@ files:
 - 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
@@ -132,6 +133,7 @@ test_files:
 - 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