md-logstasher 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6d718c5b30fe09e6735c5da021eda006340fdef09dc6a5b251ab6d8a273429b
-  data.tar.gz: 35bf7d80f1ce2d8d736de8d47bdd8f00e2ea3579992f057e10e651d9290e1f28
+  metadata.gz: 2a3ecf9c0501945ebb201adb054bcb8e419ab6282e4373fcc5f83c141f0fe606
+  data.tar.gz: 52acbb7139d4f00775f0ad88115a0237dee699aa8ce42fc8b9c0aabdd9786438
 SHA512:
-  metadata.gz: c7e667ea8187888cc4c7662b6868584a1d829ef878f9c0a949e716cf59093141a9f8f29bd659a933ee1c6ce69f422142f351125515be264cfb32de33e9164994
-  data.tar.gz: e167c08b5eaef0ea61e63df8e666974617684ea6a938fb13f44e62aafd9a5d157de4e1d2f3b05568e1186aa4be5160130a479fa0449a6169ffec98ea7bad905e
+  metadata.gz: 074e9580a2b16e2d9d25c948559a43c74d03ea3de65854b20c36fbaeb2f921d77ea11206533bebe6b9ed490d1ffc5e5f0951db1ed83f9275c5309c39cb9a78b6
+  data.tar.gz: 8353c5595d42b6da680afbc7cf4b673bf23b5b2ba9f784e7bb9c1e5b34c5fe0faa3d9ba9c648cd449e50299691a7bb91f69b3ee46458d85f8074558146801c07

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/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "1.4.1"
+  VERSION = "1.5.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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Devin Christensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-01-27 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