md-logstasher 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 628b152041e0a0d8218761c1ab723f43b16ff6a9746fcf102e5b0a8d03aea76e
-  data.tar.gz: a3283254f14aef786d70dda74cae35d081d607e67a37522fff292ddab6119e80
+  metadata.gz: '0348868a167435982eb59967a93c089a748c0c186fd9e4047a64437e868b0023'
+  data.tar.gz: b5f0441ca7b83ce1a3aaf1bb0fab537fdab07a6d0c420f34ac75dbcbf426fbe4
 SHA512:
-  metadata.gz: 68806d2f4d08aa90a7c61487d2101e9cbfa2802d1021986dc39d1d9469196d8524d6e07cdcb63b3df104c0198beff6b9510f3f2d876ddc79b4c565b5f2d2fe1e
-  data.tar.gz: 38f876594090f8a545dcfcd5380142bbfb1d9b34c726b2d0cb6de96d547ee41aaf5463c245279adbe50d694f9ab6be0a30fd6cdc45ffd0ccf5efd1e66322065f
+  metadata.gz: d7b469e1c11272f3ebabdbf8b218068ca979342a9aa5d2a2e0ea5e7d20f723e369d2f4304fe72650e60af1b76dc8763fbb3764891453eb16622a5a7f6f563a4a
+  data.tar.gz: 84b8ca35715352709060707a86889dd3170985d2ed1224a55a583d478e73175b2d57f9d2b81c6a049d5801bbd56e92bbf7086b2c33f9e44f747c8627a20a4b9d

data/lib/logstasher/version.rb

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

data/lib/logstasher.rb

@@ -9,6 +9,28 @@ module LogStasher
     attr_writer :serialize_parameters
     attr_writer :silence_standard_logging
     attr_accessor :metadata
+    attr_accessor :default_device
+
+    def load_from_config(config)
+      ::LogStasher.logger = ::Logger.new("/dev/null")
+
+      config.each do |key,value|
+        key = key.to_s
+        case key
+        when 'metadata'
+          ::LogStasher.metadata = value
+        when 'device'
+          ::LogStasher.default_device = ::LogStasher::Device.factory(value)
+          ::LogStasher.logger = ::Logger.new(::LogStasher.default_device)
+        when 'include_parameters'
+          ::LogStasher.include_parameters = value
+        when 'serialize_parameters'
+          ::LogStasher.serialize_parameters = value
+        when 'silence_standard_logging'
+          ::LogStasher.silence_standard_logging = value
+        end
+      end
+    end
 
     def append_fields(&block)
       @append_fields_callback = block
@@ -46,18 +68,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" }])
@@ -45,4 +53,83 @@ describe ::LogStasher do
       end
     end
   end
+
+  describe "#load_from_config" do
+    before(:each) do
+      ::LogStasher.metadata = {}
+      ::LogStasher.serialize_parameters = true
+      ::LogStasher.silence_standard_logging = false
+    end
+
+    it "loads with multiple config keys" do
+      config = {
+        metadata: {
+          namespace: 'kirby',
+          logged_via: 'logstasher',
+        },
+        device: {
+          type: 'stdout'
+        }
+      }
+
+      ::LogStasher.load_from_config(config)
+      expect(::LogStasher.metadata).to eq({:namespace => 'kirby', :logged_via => 'logstasher'})
+      expect(::LogStasher.default_device).to eq(STDOUT)
+    end
+
+    it "loads metadata" do
+      config = {
+        metadata: {
+          namespace: 'kirby',
+          logged_via: 'logstasher',
+        }
+      }
+
+      ::LogStasher.load_from_config(config)
+      expect(::LogStasher.metadata).to eq({:namespace => 'kirby', :logged_via => 'logstasher'})
+    end
+
+    it "loads parameters" do
+      config = {
+        include_parameters: false,
+        serialize_parameters: false,
+        silence_standard_logging: true,
+        silence_creation_message: false
+      }
+
+      ::LogStasher.load_from_config(config)
+      expect(::LogStasher.instance_variable_get(:@include_parameters)).to be false
+      expect(::LogStasher.instance_variable_get(:@serialize_parameters)).to be false
+      expect(::LogStasher.instance_variable_get(:@silence_standard_logging)).to be true
+    end
+
+    it "loads with a stdout device" do
+      config = {
+        metadata: {
+          namespace: 'kirby',
+          logged_via: 'logstasher',
+        }
+      }
+
+      ::LogStasher.load_from_config(config)
+      expect(::LogStasher.metadata).to eq({:namespace => 'kirby', :logged_via => 'logstasher'})
+    end
+
+    it "loads with a syslog device" do
+      config = {
+        device:
+          {
+            type: 'syslog',
+            identity: 'logstasher',
+            facility: 'LOG_LOCAL1',
+            priority: 'LOG_INFO',
+            flags: ['LOG_PID', 'LOG_CONS']
+          }
+      }
+      ::LogStasher.load_from_config(config)
+      expect(::LogStasher.metadata).to eq({})
+      expect(::LogStasher.default_device).to be_a ::LogStasher::Device::Syslog
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Devin Christensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Awesome rails logs