md-logstasher 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3ecf9c0501945ebb201adb054bcb8e419ab6282e4373fcc5f83c141f0fe606
-  data.tar.gz: 52acbb7139d4f00775f0ad88115a0237dee699aa8ce42fc8b9c0aabdd9786438
+  metadata.gz: 69eb9914c59b6fdde645a4c54c51785fbe677f287c18e462f4283dac2af7ef70
+  data.tar.gz: c5a6066a51d68cbfa123c8bd1e30138ee90efac02a8a19cf7ed1da56e68d09f7
 SHA512:
-  metadata.gz: 074e9580a2b16e2d9d25c948559a43c74d03ea3de65854b20c36fbaeb2f921d77ea11206533bebe6b9ed490d1ffc5e5f0951db1ed83f9275c5309c39cb9a78b6
-  data.tar.gz: 8353c5595d42b6da680afbc7cf4b673bf23b5b2ba9f784e7bb9c1e5b34c5fe0faa3d9ba9c648cd449e50299691a7bb91f69b3ee46458d85f8074558146801c07
+  metadata.gz: 89642d029ce8980eeb786953c580ab5574122a3bec77c096611c9a0c380b6230924375bf972b48f36af28134ac1474945a6c53983368eb0184d3246cb18b2ca2
+  data.tar.gz: b38aced68aa13148b72539aac1aeca810bd10b34558e776c06a0400195675ab387b86c19b463b572a59c6704cb24280db7c38c06dfa3ffc17d295e2bed075387

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.5.0"
+  VERSION = "1.7.0"
 end

data/lib/logstasher.rb

@@ -46,18 +46,20 @@ module LogStasher
 
     def log_as_json(payload, as_logstash_event: false)
       payload = payload.dup
-      payload.merge!(:metadata => metadata) if !metadata&.empty? && payload.is_a?(::Hash)
+
+      # Merge in metadata if configured. This supports a Hash and a fully formed
+      # LogStash::Event.
+      if !metadata.empty?
+        payload.merge!(:metadata => metadata) if payload.is_a?(::Hash)
+        payload.append(:metadata => metadata) if payload.is_a?(::LogStash::Event)
+      end
 
       # 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
+      payload = ::LogStash::Event.new(payload) if as_logstash_event
 
-      logger << json_payload + $INPUT_RECORD_SEPARATOR
+      logger << payload.to_json + $INPUT_RECORD_SEPARATOR
     end
 
     def logger

data/spec/lib/logstasher/logstasher_spec.rb

@@ -36,6 +36,14 @@ describe ::LogStasher do
         ::LogStasher.log_as_json(:yolo => :brolo)
       end
 
+      it "merges metadata for LogStash::Event types" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          expect(::JSON.parse(json)).to match(a_hash_including("yolo" => "brolo", "metadata" => { "namespace" => "cooldude" }))
+        end
+
+        ::LogStasher.log_as_json(::LogStash::Event.new(: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" }])

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.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Devin Christensen
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2023-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -108,7 +108,7 @@ homepage: https://github.com/moneydesktop/logstasher
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -123,8 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Awesome rails logs
 test_files: