md-logstasher 1.7.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69eb9914c59b6fdde645a4c54c51785fbe677f287c18e462f4283dac2af7ef70
-  data.tar.gz: c5a6066a51d68cbfa123c8bd1e30138ee90efac02a8a19cf7ed1da56e68d09f7
+  metadata.gz: 1fe9fbb482168a2c0e95473e02f2b219cbf116ee4f2006fe6ed15a6cde16bb44
+  data.tar.gz: 9735b52eae692c0b08205949cc65f894a3351e4e6e0275f25cc8a1663d1076eb
 SHA512:
-  metadata.gz: 89642d029ce8980eeb786953c580ab5574122a3bec77c096611c9a0c380b6230924375bf972b48f36af28134ac1474945a6c53983368eb0184d3246cb18b2ca2
-  data.tar.gz: b38aced68aa13148b72539aac1aeca810bd10b34558e776c06a0400195675ab387b86c19b463b572a59c6704cb24280db7c38c06dfa3ffc17d295e2bed075387
+  metadata.gz: db9a456790e5bf911c52f135cc1c9ce8f1486f6e47ed1aad91de52ccb9347cf6c86a83f453f8abd774be7836cfb91641f4911be017cfc23dc5463de52788e694
+  data.tar.gz: 4b2e935c1457a249a40297de6330ea991c5095539070acb75fe2f32d5b592039ad4c80b23b9e2ec7870a5211671a1cf188e4f568cc7b22dd207d81f85e941ed5

data/lib/logstasher/railtie.rb

@@ -8,6 +8,7 @@ module LogStasher
     config.logstasher.silence_creation_message = true
     config.logstasher.logger = nil
     config.logstasher.log_level = ::Logger::INFO
+    config.logstasher.dry_validation_contract = nil
 
     config.logstasher.metadata  = {}
     config.before_initialize do
@@ -20,6 +21,7 @@ module LogStasher
       ::LogStasher.logger                   = options.logger || default_logger
       ::LogStasher.logger.level             = options.log_level
       ::LogStasher.metadata                 = options.metadata
+      ::LogStasher.dry_validation_contract  = options.dry_validation_contract
     end
 
     initializer 'logstasher.load' do

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "1.7.0"
+  VERSION = "1.9.0"
 end

data/lib/logstasher.rb

@@ -9,11 +9,44 @@ 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
     end
 
+    def dry_validation_contract=(contract)
+      if contract && !contract.is_a?(::Dry::Validation::Contract)
+        raise ArgumentError, "Expected a Dry::Validation::Contract, got #{contract.class}"
+      end
+      @dry_validation_contract = contract
+    end
+
+    def dry_validation_contract
+      @dry_validation_contract
+    end
+
     def enabled?
       if @enabled.nil?
         @enabled = false
@@ -59,6 +92,9 @@ module LogStasher
       # example.
       payload = ::LogStash::Event.new(payload) if as_logstash_event
 
+      # Validate payload if a dry_validation_contract is configured
+      validate_payload(payload) if dry_validation_contract
+
       logger << payload.to_json + $INPUT_RECORD_SEPARATOR
     end
 
@@ -77,6 +113,22 @@ module LogStasher
 
       @silence_standard_logging
     end
+
+  private
+
+    def validate_payload(payload)
+      return unless payload.is_a?(::LogStash::Event) || payload.is_a?(::Hash)
+
+      validation = dry_validation_contract.call(payload.to_hash)
+
+      validation_payload = {
+        dry_validation_success: validation.success?,
+        dry_validation_errors: validation.errors.to_h.to_json
+      }
+
+      return payload.append(validation_payload) if payload.is_a?(::LogStash::Event)
+      return payload.deep_merge!(validation_payload) if payload.is_a?(::Hash)
+    end
   end
 end
 

data/logstasher.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "logstash-event", "~> 1.2"
+  s.add_runtime_dependency "dry-validation", ">= 1.11.0"
 
   s.add_development_dependency "redis"
   s.add_development_dependency "rspec"

data/spec/lib/logstasher/logstasher_spec.rb

@@ -1,13 +1,19 @@
 require "spec_helper"
+require "dry-validation"
 
 describe ::LogStasher do
+  before(:each) do
+    # Reset state before each test
+    ::LogStasher.metadata = {}
+    ::LogStasher.dry_validation_contract = nil
+  end
   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)
+      ::LogStasher.log_as_json({"yolo" => "brolo"})
     end
 
     context "with event" do
@@ -20,7 +26,7 @@ describe ::LogStasher do
           expect(payload["yolo"]).to eq("brolo")
         end
 
-        ::LogStasher.log_as_json({:yolo => :brolo}, :as_logstash_event => true)
+        ::LogStasher.log_as_json({"yolo" => "brolo"}, :as_logstash_event => true)
       end
     end
 
@@ -33,7 +39,7 @@ describe ::LogStasher do
           expect(::JSON.parse(json)).to eq("yolo" => "brolo", "metadata" => { "namespace" => "cooldude" })
         end
 
-        ::LogStasher.log_as_json(:yolo => :brolo)
+        ::LogStasher.log_as_json({"yolo" => "brolo"})
       end
 
       it "merges metadata for LogStash::Event types" do
@@ -41,7 +47,7 @@ describe ::LogStasher do
           expect(::JSON.parse(json)).to match(a_hash_including("yolo" => "brolo", "metadata" => { "namespace" => "cooldude" }))
         end
 
-        ::LogStasher.log_as_json(::LogStash::Event.new(:yolo => :brolo))
+        ::LogStasher.log_as_json(::LogStash::Event.new("yolo" => "brolo"))
       end
 
       it "does not merge metadata on an array" do
@@ -49,8 +55,201 @@ describe ::LogStasher do
           expect(::JSON.parse(json)).to eq([{ "yolo" => "brolo" }])
         end
 
-        ::LogStasher.log_as_json([{:yolo => :brolo}])
+        ::LogStasher.log_as_json([{"yolo" => "brolo"}])
+      end
+    end
+
+    context "with dry validation contract" do
+      let(:validation_contract) do
+        Class.new(Dry::Validation::Contract) do
+          params do
+            required(:yolo).filled(:string)
+          end
+        end.new
+      end
+
+      before do
+        ::LogStasher.metadata = { :namespace => :cooldude }
+        ::LogStasher.dry_validation_contract = validation_contract
+      end
+
+      after do
+        ::LogStasher.metadata = {}
+        ::LogStasher.dry_validation_contract = nil
+      end
+
+      it "validates LogStash::Event payload and appends validation metadata on success" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          payload = ::JSON.parse(json)
+          expect(payload["dry_validation_errors"]).to eq("{}")
+          expect(payload["dry_validation_success"]).to be true
+          expect(payload["yolo"]).to eq("brolo")
+          expect(payload["metadata"]["namespace"]).to eq("cooldude")
+        end
+
+        ::LogStasher.log_as_json(::LogStash::Event.new("yolo" => "brolo"))
+      end
+
+      it "validates LogStash::Event payload and appends validation metadata on failure" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          payload = ::JSON.parse(json)
+          expect(payload["dry_validation_errors"]).to eq("{\"yolo\":[\"must be a string\"]}")
+          expect(payload["dry_validation_success"]).to be false
+          expect(payload["yolo"]).to eq(123)
+          expect(payload["metadata"]["namespace"]).to eq("cooldude")
+        end
+
+        ::LogStasher.log_as_json(::LogStash::Event.new("yolo" => 123))
+      end
+
+      it "validates hash payload and merges validation metadata on success" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          payload = ::JSON.parse(json)
+          expect(payload["dry_validation_errors"]).to eq("{}")
+          expect(payload["dry_validation_success"]).to be true
+          expect(payload["yolo"]).to eq("brolo")
+          expect(payload["metadata"]["namespace"]).to eq("cooldude")
+        end
+
+        ::LogStasher.log_as_json({"yolo" => "brolo"})
+      end
+
+      it "validates hash payload and merges validation metadata on failure" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          payload = ::JSON.parse(json)
+          expect(payload["dry_validation_errors"]).to eq("{\"yolo\":[\"must be a string\"]}")
+          expect(payload["dry_validation_success"]).to be false
+          expect(payload["yolo"]).to eq(123)
+          expect(payload["metadata"]["namespace"]).to eq("cooldude")
+        end
+
+        ::LogStasher.log_as_json({"yolo" => 123})
+      end
+
+      it "does not validate array payloads" do
+        expect(::LogStasher.logger).to receive(:<<) do |json|
+          payload = ::JSON.parse(json)
+          expect(payload).to eq([{ "yolo" => "brolo" }])
+        end
+
+        ::LogStasher.log_as_json([{"yolo" => "brolo"}])
       end
     end
   end
+
+  describe "#dry_validation_contract=" do
+    it "accepts a valid Dry::Validation::Contract" do
+      contract = Class.new(Dry::Validation::Contract) do
+        params do
+          required(:test).filled(:string)
+        end
+      end.new
+
+      expect { ::LogStasher.dry_validation_contract = contract }.not_to raise_error
+      expect(::LogStasher.dry_validation_contract).to eq(contract)
+    end
+
+    it "accepts nil" do
+      expect { ::LogStasher.dry_validation_contract = nil }.not_to raise_error
+      expect(::LogStasher.dry_validation_contract).to be_nil
+    end
+
+    it "raises ArgumentError for non-Contract objects" do
+      expect { ::LogStasher.dry_validation_contract = "not a contract" }.to raise_error(
+        ArgumentError, "Expected a Dry::Validation::Contract, got String"
+      )
+    end
+  end
+
+  describe "#dry_validation_contract" do
+    it "returns the stored contract" do
+      contract = double("contract")
+      ::LogStasher.instance_variable_set(:@dry_validation_contract, contract)
+      expect(::LogStasher.dry_validation_contract).to eq(contract)
+    end
+
+    it "returns nil when no contract is set" do
+      ::LogStasher.instance_variable_set(:@dry_validation_contract, nil)
+      expect(::LogStasher.dry_validation_contract).to be_nil
+    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

data/spec/lib/logstasher/railtie_spec.rb

@@ -44,11 +44,13 @@ describe ::LogStasher::Railtie do
       config.include_parameters       = "include_parameters"
       config.serialize_parameters     = "serialize_parameters"
       config.silence_standard_logging = "silence_standard_logging"
+      config.dry_validation_contract  = "dry_validation_contract"
 
       expect(::LogStasher).to receive(:enabled=).with("enabled")
       expect(::LogStasher).to receive(:include_parameters=).with("include_parameters")
       expect(::LogStasher).to receive(:serialize_parameters=).with("serialize_parameters")
       expect(::LogStasher).to receive(:silence_standard_logging=).with("silence_standard_logging")
+      expect(::LogStasher).to receive(:dry_validation_contract=).with("dry_validation_contract")
       expect(::LogStasher).to receive(:logger=).with(config.logger).and_call_original
       expect(config.logger).to receive(:level=).with("log_level")
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: md-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Devin Christensen
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -24,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +121,6 @@ homepage: https://github.com/moneydesktop/logstasher
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -123,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Awesome rails logs
 test_files: