logstash-logger 1.0.0 → 1.1.0

data/spec/formatter/framing_spec.rb

@@ -0,0 +1,58 @@
+require 'logstash-logger'
+require_relative '../support/unserializable_value'
+require 'logger'
+require 'net/http'
+
+# A record that cannot be formatted must not change how its neighbours are
+# framed on the wire.
+describe 'Record framing when a record cannot be formatted' do
+  let(:failing) { { 'message' => 'x', 'n' => UnserializableValue.new } }
+  let(:bad_timestamp) { %q({"message":"y","@timestamp":"not-a-time"}) }
+
+  before do
+    LogStashLogger.configure { |c| c.default_error_logger = ::Logger.new(IO::NULL) }
+  end
+
+  after { LogStashLogger.configure { |c| c.default_error_logger = ::Logger.new($stderr) } }
+
+  it 'keeps every line of a json_lines stream parseable' do
+    io = StringIO.new
+    logger = LogStashLogger.new(type: :io, io: io, sync: true)
+    logger.info(failing)
+    logger.info(bad_timestamp)
+    logger.info('next record')
+
+    lines = io.string.lines
+    expect(lines.size).to eq(3)
+    parsed = lines.map { |l| JSON.parse(l) }
+    expect(parsed[0]['tags']).to eq([LogStashLogger::Formatter::Base::FAILED_TO_FORMAT_TAG])
+    expect(parsed[1]['message']).to eq('y')
+    expect(parsed[2]['message']).to eq('next record')
+  end
+
+  it 'keeps every record of a cee_syslog stream on its own line' do
+    io = StringIO.new
+    logger = LogStashLogger.new(type: :io, io: io, sync: true, formatter: :cee_syslog)
+    logger.info(failing)
+    logger.info(%q({"message":"z","host":{"hostname":"web1\n<13>forged"}}))
+    logger.info('next record')
+
+    lines = io.string.lines
+    expect(lines.size).to eq(3)
+    lines.each { |l| expect(l).to start_with("#{Socket.gethostname}:@cee:") }
+  end
+
+  it 'keeps an HTTP batch a valid JSON array' do
+    formatter = LogStashLogger::Formatter.new(:json_lines)
+    messages = [failing, 'next record'].map { |m| formatter.call('INFO', Time.now, nil, m) }
+    device = LogStashLogger::Device.new(type: :http, url: 'http://localhost', sync: true)
+    body = nil
+    allow(Net::HTTP).to receive(:post) { |_url, b, _h| body = b; Net::HTTPOK.new('1.1', '200', 'OK') }
+
+    device.write_batch(messages)
+
+    batch = JSON.parse(body)
+    expect(batch.size).to eq(2)
+    expect(batch[1]['message']).to eq('next record')
+  end
+end

data/spec/formatter/json_lines_spec.rb

@@ -1,4 +1,5 @@
 require 'logstash-logger'
+require_relative '../support/unserializable_value'
 
 describe LogStashLogger::Formatter::JsonLines do
   include_context "formatter"
@@ -34,4 +35,21 @@ describe LogStashLogger::Formatter::JsonLines do
       expect(json_message["message"]).to eq(message.force_encoding(Encoding::UTF_8).scrub)
     end
   end
+
+  context 'when the record cannot be serialized' do
+    let(:message) { { 'message' => 'x', 'n' => UnserializableValue.new } }
+
+    before do
+      allow(subject).to receive(:error_logger).and_return(Logger.new(IO::NULL))
+    end
+
+    it 'emits a JSON placeholder line instead of a bare string' do
+      expect(formatted_message).to end_with("\n")
+      expect(formatted_message.count("\n")).to eq(1)
+      data = JSON.parse(formatted_message)
+      expect(data['message']).to eq(LogStashLogger::Formatter::Base::FAILED_TO_FORMAT_MSG)
+      expect(data['tags']).to eq([LogStashLogger::Formatter::Base::FAILED_TO_FORMAT_TAG])
+      expect(data['error']).to eq('JSON::GeneratorError')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,11 @@ require 'pry'
 require 'securerandom'
 
 require 'simplecov'
+require 'simplecov-cobertura'
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::CoberturaFormatter
+]
 SimpleCov.start
 
 RSpec.configure do |config|

data/spec/support/tls_helper.rb

@@ -0,0 +1,30 @@
+require 'openssl'
+require 'tempfile'
+
+# Builds throwaway self-signed certificates for TLS specs. Nothing is written
+# outside Tempfile, and the keys never leave the test process.
+module TLSHelper
+  def self.self_signed(common_name: 'localhost', dns: ['localhost'], ips: ['127.0.0.1'])
+    key = OpenSSL::PKey::RSA.new(2048)
+    cert = OpenSSL::X509::Certificate.new
+    cert.version = 2
+    cert.serial = rand(2**64)
+    cert.subject = cert.issuer = OpenSSL::X509::Name.parse("/CN=#{common_name}")
+    cert.public_key = key.public_key
+    cert.not_before = Time.now - 60
+    cert.not_after = Time.now + 3600
+    ef = OpenSSL::X509::ExtensionFactory.new(cert, cert)
+    cert.add_extension(ef.create_extension('basicConstraints', 'CA:TRUE', true))
+    sans = dns.map { |d| "DNS:#{d}" } + ips.map { |i| "IP:#{i}" }
+    cert.add_extension(ef.create_extension('subjectAltName', sans.join(','))) unless sans.empty?
+    cert.sign(key, OpenSSL::Digest.new('SHA256'))
+    [cert, key]
+  end
+
+  def self.cert_file(cert)
+    Tempfile.new(['logstash-logger-test', '.crt']).tap do |f|
+      f.write(cert.to_pem)
+      f.flush
+    end
+  end
+end

data/spec/support/unserializable_value.rb

@@ -0,0 +1,10 @@
+# A value whose JSON conversion always raises, with or without ActiveSupport
+class UnserializableValue
+  def to_json(*)
+    raise JSON::GeneratorError, 'cannot serialize'
+  end
+
+  def as_json(*)
+    raise JSON::GeneratorError, 'cannot serialize'
+  end
+end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - David Butler
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -99,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -271,7 +272,6 @@ files:
 - docs/ssl.md
 - docs/troubleshooting.md
 - docs/usage.md
-- gemfiles/rails_7.2.gemfile
 - gemfiles/rails_8.0.gemfile
 - gemfiles/rails_8.1.gemfile
 - lib/logstash-logger.rb
@@ -321,6 +321,7 @@ files:
 - samples/unix.conf
 - spec/configuration_spec.rb
 - spec/constructor_spec.rb
+- spec/device/aws_stream_limits_spec.rb
 - spec/device/balancer_spec.rb
 - spec/device/connectable_spec.rb
 - spec/device/file_spec.rb
@@ -335,12 +336,14 @@ files:
 - spec/device/stderr_spec.rb
 - spec/device/stdout_spec.rb
 - spec/device/tcp_spec.rb
+- spec/device/tcp_tls_integration_spec.rb
 - spec/device/udp_spec.rb
 - spec/device/unix_spec.rb
 - spec/device_spec.rb
 - spec/formatter/base_spec.rb
 - spec/formatter/cee_spec.rb
 - spec/formatter/cee_syslog_spec.rb
+- spec/formatter/framing_spec.rb
 - spec/formatter/json_lines_spec.rb
 - spec/formatter/json_spec.rb
 - spec/formatter/logstash_event_spec.rb
@@ -350,12 +353,15 @@ files:
 - spec/rails_spec.rb
 - spec/silenced_logging_spec.rb
 - spec/spec_helper.rb
+- spec/support/tls_helper.rb
+- spec/support/unserializable_value.rb
 - spec/syslog_spec.rb
 - spec/tagged_logging_spec.rb
 homepage: http://github.com/dwbutler/logstash-logger
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -363,19 +369,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: LogStash Logger for ruby
 test_files:
 - spec/configuration_spec.rb
 - spec/constructor_spec.rb
+- spec/device/aws_stream_limits_spec.rb
 - spec/device/balancer_spec.rb
 - spec/device/connectable_spec.rb
 - spec/device/file_spec.rb
@@ -390,12 +398,14 @@ test_files:
 - spec/device/stderr_spec.rb
 - spec/device/stdout_spec.rb
 - spec/device/tcp_spec.rb
+- spec/device/tcp_tls_integration_spec.rb
 - spec/device/udp_spec.rb
 - spec/device/unix_spec.rb
 - spec/device_spec.rb
 - spec/formatter/base_spec.rb
 - spec/formatter/cee_spec.rb
 - spec/formatter/cee_syslog_spec.rb
+- spec/formatter/framing_spec.rb
 - spec/formatter/json_lines_spec.rb
 - spec/formatter/json_spec.rb
 - spec/formatter/logstash_event_spec.rb
@@ -405,5 +415,7 @@ test_files:
 - spec/rails_spec.rb
 - spec/silenced_logging_spec.rb
 - spec/spec_helper.rb
+- spec/support/tls_helper.rb
+- spec/support/unserializable_value.rb
 - spec/syslog_spec.rb
 - spec/tagged_logging_spec.rb

data/gemfiles/rails_7.2.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "codeclimate-test-reporter", group: :test, require: nil
-gem "rails", "~> 7.2.0"
-
-gemspec path: "../"