loggability 0.15.1 → 0.18.2

data/spec/loggability/log_device/file_spec.rb

@@ -0,0 +1,27 @@
+# -*- rspec -*-
+#encoding: utf-8
+
+require 'tempfile'
+require 'rspec'
+
+require 'loggability/logger'
+require 'loggability/log_device/file'
+
+
+describe Loggability::LogDevice::File do
+
+	let( :logfile ) { Tempfile.new( 'test.log' ) }
+	let( :logger ) { described_class.new( logfile.path ) }
+
+
+	it "The logger is an instance of Loggability::LogDevice::File" do
+		expect( logger ).to be_instance_of( Loggability::LogDevice::File )
+	end
+
+
+	it "The log device is delegated to Ruby's built-in log device" do
+		expect( logger.target ).to be_instance_of( ::Logger::LogDevice )
+	end
+
+end
+

data/spec/loggability/log_device/http_spec.rb

@@ -0,0 +1,217 @@
+# -*- rspec -*-
+
+require_relative '../../helpers'
+
+require 'tempfile'
+require 'rspec'
+
+require 'loggability/log_device/http'
+
+
+describe Loggability::LogDevice::Http do
+
+
+	let( :http_client ) { instance_double(Net::HTTP) }
+
+
+	it "can be created with defaults" do
+		result = described_class.new
+
+		expect( result ).to be_an_instance_of( described_class )
+		expect( result.batch_interval ).to eq( described_class::DEFAULT_BATCH_INTERVAL )
+		expect( result.write_timeout ).to eq( described_class::DEFAULT_WRITE_TIMEOUT )
+	end
+
+
+	it "doesn't start when created" do
+		result = described_class.new
+
+		expect( result ).to_not be_running
+	end
+
+
+	it "sends logs when a full batch is ready" do
+		device = described_class.new( max_batch_size: 3, executor_class: Concurrent::ImmediateExecutor )
+		device.instance_variable_set( :@http_client, http_client )
+
+		expect( http_client ).to receive( :request ) do |request|
+			expect( request ).to be_a( Net::HTTP::Post )
+			expect( request['Content-type'] ).to match( %r|application/json|i )
+			expect( request.body ).to match( /message 1/i )
+			expect( request.body ).to match( /message 2/i )
+			expect( request.body ).to match( /message 3/i )
+		end
+
+		device.write( "Message 1" )
+		device.write( "Message 2" )
+		device.write( "Message 3" )
+		device.write( "Message 4" )
+
+		expect( device.logs_queue ).to have_attributes( length: 1 )
+	end
+
+
+	it "sends logs when enough time has elapsed since the last message" do
+		device = described_class.new(
+			max_batch_size: 3, batch_interval: 0.1, executor_class: Concurrent::ImmediateExecutor )
+		device.instance_variable_set( :@http_client, http_client )
+		device.start
+		device.timer_task.shutdown # Don't let the timer fire
+
+		expect( http_client ).to receive( :request ) do |request|
+			expect( request ).to be_a( Net::HTTP::Post )
+			expect( request['Content-type'] ).to match( %r|application/json|i )
+			expect( request.body ).to match( /message 1/i )
+			expect( request.body ).to match( /message 2/i )
+		end
+
+		device.write( "Message 1" )
+
+		# Now wait for the batch interval to pass and send another
+		sleep device.batch_interval
+		expect( device ).to have_batch_ready
+		device.write( "Message 2" )
+
+		expect( device.logs_queue ).to have_attributes( length: 0 )
+	end
+
+
+	it "sends logs on the batch interval even when messages aren't arriving" do
+		device = described_class.new(
+			max_batch_size: 3, batch_interval: 0.1, executor_class: Concurrent::ImmediateExecutor )
+		device.instance_variable_set( :@http_client, http_client )
+
+		expect( http_client ).to receive( :request ) do |request|
+			expect( request ).to be_a( Net::HTTP::Post )
+			expect( request['Content-type'] ).to match( %r|application/json|i )
+			expect( request.body ).to match( /message 1/i )
+		end
+
+		device.write( "Message 1" )
+
+		# Now wait for the batch interval to pass and send another
+		sleep device.batch_interval * 2
+
+		expect( device.logs_queue ).to have_attributes( length: 0 )
+	end
+
+
+	it "limits messages to the configured byte size constraints" do
+		device = described_class.new(
+			max_batch_size: 3,
+			max_message_bytesize: 1024,
+			batch_interval: 0.1,
+			executor_class: Concurrent::ImmediateExecutor )
+		device.instance_variable_set( :@http_client, http_client )
+
+		expect( http_client ).to receive( :request ) do |request|
+			expect( request ).to be_a( Net::HTTP::Post )
+			expect( request['Content-type'] ).to match( %r|application/json|i )
+
+			data = JSON.parse( request.body )
+
+			expect( data ).to all( have_attributes(bytesize: a_value <= 1024) )
+		end.at_least( :once )
+
+		device.write( "message data" * 10 )  # 120 bytes
+		device.write( "message data" * 100 ) # 1200 bytes
+		device.write( "message data" * 85 )  # 1020 bytes
+		device.write( "message data" * 86 )  # 1032 bytes
+
+		sleep( 0.1 ) until device.logs_queue.empty?
+	end
+
+
+	it "limits the batch to the configured byte size constraints" do
+		device = described_class.new(
+			max_batch_bytesize: 1024,
+			batch_interval: 0.1,
+			executor_class: Concurrent::ImmediateExecutor )
+		device.instance_variable_set( :@http_client, http_client )
+
+		expect( http_client ).to receive( :request ) do |request|
+			expect( request ).to be_a( Net::HTTP::Post )
+			expect( request['Content-type'] ).to match( %r|application/json|i )
+
+			expect( request.body.bytesize ).to be <= 1024
+		end.at_least( :once )
+
+		20.times { device.write( "message data" * 10 )  } # 120 bytes
+		20.times { device.write( "message data" * 100 ) } # 1200 bytes
+		20.times { device.write( "message data" * 85 )  } # 1020 bytes
+		20.times { device.write( "message data" * 86 )  } # 1032 bytes
+
+		sleep( 0.1 ) until device.logs_queue.empty?
+	end
+
+
+	it "uses an HTTP client for the appropriate host and port" do
+		device = described_class.new(
+			'http://logs.example.com:12881/v1/log_ingester',
+			executor_class: Concurrent::ImmediateExecutor )
+		http = device.http_client
+
+		expect( http.address ).to eq( 'logs.example.com' )
+		expect( http.port ).to eq( 12881 )
+	end
+
+
+	it "verifies the peer cert if sending to an HTTPS endpoint" do
+		device = described_class.new(
+			'https://logs.example.com:12881/v1/log_ingester',
+			executor_class: Concurrent::ImmediateExecutor )
+		http = device.http_client
+
+		expect( http.use_ssl? ).to be_truthy
+		expect( http.verify_mode ).to eq( OpenSSL::SSL::VERIFY_PEER )
+	end
+
+
+	it "stops queuing more messages if max queue size is reached" do
+		device = described_class.new(
+			max_batch_bytesize: 1024,
+			batch_interval: 100,
+			max_queue_bytesize: 100,
+			executor_class: Concurrent::ImmediateExecutor )
+		device.instance_variable_set( :@http_client, http_client )
+
+		expect( device ).to receive( :send_logs ).at_least( :once )
+
+		msg = "test message"
+		device.write(msg)
+		expect( device.logs_queue_bytesize == msg.bytesize )
+
+		hash_msg = { message: "This is a test log message", tags: ["tag1", "tag2"] }
+		device.write( hash_msg )
+		previous_bytesize = device.logs_queue_bytesize - hash_msg.to_json.bytesize
+		expect( device.logs_queue_bytesize ).to eq( hash_msg.to_json.bytesize + previous_bytesize )
+
+		queue_current_bytesize = device.logs_queue_bytesize
+		hash_msg = { message: "This is a test log message", tags: ["tag1", "tag2"] }
+		device.write( hash_msg )
+		expect( device.logs_queue_bytesize ).to eq( queue_current_bytesize )
+	end
+
+
+	it "reduces the queue bytesize once messages are sent" do
+		device = described_class.new(
+			max_batch_bytesize: 1024,
+			batch_interval: 100,
+			max_queue_bytesize: 100,
+			executor_class: Concurrent::ImmediateExecutor )
+		device.instance_variable_set( :@http_client, http_client )
+
+		expect( device ).to receive( :send_logs ).at_least( :once )
+		msg = "test message"
+		device.write(msg)
+		expect( device.logs_queue_bytesize == msg.bytesize )
+
+		msg = "this is just a test message"
+		device.write( msg )
+		previous_bytesize = device.logs_queue_bytesize - msg.bytesize
+		expect( device.logs_queue_bytesize ).to eq( msg.bytesize + previous_bytesize )
+
+		expect { device.get_next_log_payload }.to change { device.logs_queue_bytesize }.to( 0 )
+	end
+
+end

data/spec/loggability/logger_spec.rb

@@ -106,6 +106,7 @@ describe Loggability::Logger do
 			expect( logger.level ).to eq( :warn )
 		end
 
+
 		it "defaults to :debug level when $DEBUG is true" do
 			begin
 				$DEBUG = true
@@ -115,6 +116,7 @@ describe Loggability::Logger do
 			end
 		end
 
+
 		it "allows its levels to be set with integers like Logger" do
 			newlevel = Logger::DEBUG
 			$stderr.puts "Setting newlevel to %p" % [ newlevel ]
@@ -122,11 +124,13 @@ describe Loggability::Logger do
 			expect( logger.level ).to eq( :debug )
 		end
 
+
 		it "allows its levels to be set with Symbolic level names" do
 			logger.level = :info
 			expect( logger.level ).to eq( :info )
 		end
 
+
 		it "allows its levels to be set with Stringish level names" do
 			logger.level = 'fatal'
 			expect( logger.level ).to eq( :fatal )
@@ -141,12 +145,14 @@ describe Loggability::Logger do
 			expect( logger.logdev.dev ).to be( $stderr )
 		end
 
+
 		it "can be told to log to a file" do
 			tmpfile = Tempfile.new( 'loggability-device-spec' )
 			logger.output_to( tmpfile.path )
 			expect( logger.logdev.dev ).to be_a( File )
 		end
 
+
 		it "supports log-rotation arguments for logfiles" do
 			tmpfile = Tempfile.new( 'loggability-device-spec' )
 			logger.output_to( tmpfile.path, 5, 125000 )
@@ -156,16 +162,45 @@ describe Loggability::Logger do
 			expect( logger.logdev.instance_variable_get(:@shift_size) ).to eq( 125000 )
 		end
 
+
+		it "can be told to log to a file and delegate to ruby's built-in logger log device" do
+			logfile = double( "logfile.log" )
+			expect( Loggability::LogDevice ).to receive( :create ).
+				with( :file, 'log_file.log' ).
+				and_return( logfile )
+
+			logfile = Loggability::LogDevice.create( :file, 'log_file.log' )
+			expect( logger ).to receive( :output_to ).
+				with( logfile ).
+				and_return( nil )
+
+			logger.output_to( logfile )
+
+			expect( logger.logdev ).to be_a( Logger::LogDevice )
+		end
+
+
+		it "can be told to log to a custom log device type" do
+			logger.output_to( :http, 'https://logapi.example.com:41133/v1/logintake' )
+
+			device = logger.logdev
+
+			expect( device ).to be_a( Loggability::LogDevice::Http )
+			expect( device.endpoint.to_s ).to eq( 'https://logapi.example.com:41133/v1/logintake' )
+		end
+
+
 		it "can be told to log to an Array" do
 			logmessages = []
 			logger.output_to( logmessages )
-			expect( logger.logdev ).to be_a( Loggability::Logger::AppendingLogDevice )
+			expect( logger.logdev ).to be_a( Loggability::LogDevice::Appending )
 			logger.level = :debug
 			logger.info( "Something happened." )
 			expect( logmessages.size ).to eq(  1  )
 			expect( logmessages.first ).to match( /something happened/i )
 		end
 
+
 		it "doesn't re-wrap a Logger::LogDevice" do
 			tmpfile = Tempfile.new( 'loggability-device-spec' )
 			logger.output_to( tmpfile.path, 5, 125000 )
@@ -176,7 +211,8 @@ describe Loggability::Logger do
 			expect( logger.logdev ).to be( original_logdev )
 		end
 
-		it "doesn't re-wrap an AppendingLogDevice" do
+
+		it "doesn't re-wrap an Appending log device" do
 			log_array = []
 			logger.output_to( log_array )
 			logger.output_to( logger.logdev )
@@ -193,11 +229,13 @@ describe Loggability::Logger do
 			expect( logger.formatter ).to be_a( Loggability::Formatter::Default )
 		end
 
+
 		it "can be told to use the default formatter explicitly" do
 			logger.format_as( :default )
 			expect( logger.formatter ).to be_a( Loggability::Formatter::Default )
 		end
 
+
 		it "can be told to use a block as a formatter" do
 			logger.format_with do |severity, datetime, progname, msg|
 				original_formatter.call(severity, datetime, progname, msg.dump)
@@ -206,11 +244,13 @@ describe Loggability::Logger do
 			expect( logger.formatter ).to be_a( Proc )
 		end
 
+
 		it "can be told to use the HTML formatter" do
 			logger.format_as( :html )
 			expect( logger.formatter ).to be_a( Loggability::Formatter::HTML )
 		end
 
+
 		it "supports formatting with ::Logger::Formatter, too" do
 			output = []
 			logger.output_to( output )
@@ -244,6 +284,7 @@ describe Loggability::Logger do
 			expect( messages.first ).to match( expected_format )
 		end
 
+
 		it "has a terse inspection format" do
 			object = Object.new
 			expect(

data/spec/loggability_spec.rb

@@ -161,6 +161,12 @@ describe Loggability do
 			expect( Loggability[loghost].logdev.dev ).to be( $stdout )
 		end
 
+		it "can propagate an outputter with arguments to every loghost" do
+			Loggability.output_to( :http, 'http://localhost:12771/v1/logs' )
+			expect( Loggability[loghost].logdev ).to be_a( Loggability::LogDevice )
+			expect( Loggability[loghost].logdev.endpoint ).to eq( URI('http://localhost:12771/v1/logs') )
+		end
+
 		it "can propagate a formatter to every loghost" do
 			Loggability.format_with( :color )
 			expect( Loggability[loghost].formatter ).to be_a( Loggability::Formatter::Color )
@@ -366,6 +372,13 @@ describe Loggability do
 			expect( result ).to eq([ 'info', 'html', '/usr/local/www/htdocs/log.html' ])
 		end
 
+		it 'can parse a logging confi spec with a severity, a http service name with its api key' do
+			result = Loggability.parse_config_spec('warn datadog[datadog_api_key]: (Color)')
+			expect( result[0] ).to eq( 'warn' )
+			expect( result[1] ).to eq( 'Color' )
+			expect( result[2].first ).to be_instance_of( Loggability::LogDevice::Datadog )
+		end
+
 		it "can configure loghosts via its ::configure method" do
 			config = {'class1' => 'debug (html)', 'class2' => 'error spec-error.log'}
 			Loggability.configure( config )

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: loggability
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.18.2
 platform: ruby
 authors:
 - Michael Granger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIENDCCApygAwIBAgIBATANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
-  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0xOTEwMDkwMDM2NTdaFw0yMDEwMDgwMDM2
-  NTdaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  MIID+DCCAmCgAwIBAgIBAzANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMDEyMjQyMDU1MjlaFw0yMTEyMjQyMDU1
+  MjlaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
   hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
   L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
   M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
@@ -21,20 +21,19 @@ cert_chain:
   vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
   dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
   ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
-  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYD
-  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DAcBgNVHREE
-  FTATgRFnZWRARmFlcmllTVVELm9yZzAcBgNVHRIEFTATgRFnZWRARmFlcmllTVVE
-  Lm9yZzANBgkqhkiG9w0BAQsFAAOCAYEAFqsr6o0SvQRgjQVmhbQvExRnCMCoW1yb
-  FJiN7A5RA2Iy2E61OG1Ul5nGmaDmx/PNB/6JIbIV3B9Uq8aTZx4uOjK7r8vMl1/t
-  ZfY7r6HejJfXlcO2m6JDMbpdyEVv916LncBkzZRz6vnnNCx+31f15FKddxujpAFd
-  qpn3JRQY+oj7ZkoccL/IUiDpxQWeS3oOoz9qr2kVTp8R50InZimt79FqCl/1m66W
-  kdOuf+wM3DDx7Rt4IVNHrhGlyfMr7xjKW1Q3gll+pMN1DT6Ajx/t3JDSEg7BnnEW
-  r7AciSO6J4ApUdqyG+coLFlGdtgFTgRHv7ihbQtDI7Z/LV7A4Spn1j2PK3j0Omri
-  kSl1hPVigRytfgdVGiLXzvkkrkgj9EknCaj5UHbac7XvVBrljXj9hsnnqTANaKsg
-  jBZSA+N+xUTgUWpXjjwsLZjzJkhWATJWq+krNXcqpwXo6HsjmdUxoFMt63RBb+sI
-  XrxOxp8o0uOkU7FdLSGsyqJ2LzsR4obN
+  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
+  9w0BAQsFAAOCAYEAMYegZanJi8zq7QKPT7wqXefX4C88I5JWeBHR3PvvWK0CwyMV
+  peyiu5I13w/lYX+HUZjE4qsSpJMJFXWl4WZCOo+AMprOcf0PxfuJpxCej5D4tavf
+  vRfhahSw7XJrcZih/3J+/UgoH7R05MJ+8LTcy3HGrB3a0vTafjm8OY7Xpa0LJDoN
+  JDqxK321VIHyTibbKeA1hWSE6ljlQDvFbTqiCj3Ulp1jTv3TOlvRl8fqcfhxUJI0
+  +5Q82jJODjEN+GaWs0V+NlrbU94cXwS2PH5dXogftB5YYA5Ex8A0ikZ73xns4Hdo
+  XxdLdd92F5ovxA23j/rKe/IDwqr6FpDkU3nPXH/Qp0TVGv9zZnVJc/Z6ChkuWj8z
+  pW7JAyyiiHZgKKDReDrA2LA7Zs3o/7KA6UtUH0FHf8LYhcK+pfHk6RtjRe65ffw+
+  MCh97sQ/Z/MOusb5+QddBmB+k8EicXyGNl4b5L4XpL7fIQu+Y96TB3JEJlShxFD9
+  k9FjI4d9EP54gS/4
   -----END CERTIFICATE-----
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-deveiate
@@ -70,14 +69,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +105,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: A composable logging system built on the standard Logger library.
 email:
 - ged@faeriemud.org
@@ -114,7 +127,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".simplecov"
-- ChangeLog
 - History.rdoc
 - Manifest.txt
 - README.md
@@ -126,6 +138,11 @@ files:
 - lib/loggability/formatter/default.rb
 - lib/loggability/formatter/html.rb
 - lib/loggability/formatter/structured.rb
+- lib/loggability/log_device.rb
+- lib/loggability/log_device/appending.rb
+- lib/loggability/log_device/datadog.rb
+- lib/loggability/log_device/file.rb
+- lib/loggability/log_device/http.rb
 - lib/loggability/logclient.rb
 - lib/loggability/logger.rb
 - lib/loggability/loghost.rb
@@ -137,6 +154,10 @@ files:
 - spec/loggability/formatter/html_spec.rb
 - spec/loggability/formatter/structured_spec.rb
 - spec/loggability/formatter_spec.rb
+- spec/loggability/log_device/appending_spec.rb
+- spec/loggability/log_device/datadog_spec.rb
+- spec/loggability/log_device/file_spec.rb
+- spec/loggability/log_device/http_spec.rb
 - spec/loggability/logger_spec.rb
 - spec/loggability/loghost_spec.rb
 - spec/loggability/override_spec.rb
@@ -145,14 +166,19 @@ files:
 homepage: https://hg.sr.ht/~ged/Loggability
 licenses:
 - BSD-3-Clause
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://hg.sr.ht/~ged/Loggability
+  documentation_uri: https://deveiate.org/code/loggability
+  changelog_uri: https://deveiate.org/code/loggability/History_md.html
+  source_uri: https://hg.sr.ht/~ged/Loggability/browse
+  bug_tracker_uri: https://todo.sr.ht/~ged/Loggability/browse
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -161,8 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A composable logging system built on the standard Logger library.
 test_files: []