loggability 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 657ddfb25b87eccec0c814690fcc32056a5f0864d8e662f313b50a98cc44342e
-  data.tar.gz: 0653afb117c71ef19153a1f4f2440436ad427c6b74c64d1d7d1d0edb2cde5b0b
+  metadata.gz: 5c0f3a12e9663d82cb709b0bf7f5aea24f9a49dba2435f5c63e289b7c731aa3e
+  data.tar.gz: cf7da9a50c5890505b96d2c1609f487a6ddb8c73c7deed602eb7508174613de2
 SHA512:
-  metadata.gz: 10c6bc903e01021b38fcdabe55081e09c693ce54ebe388aef44752a17fec3e4e86a34d1bc40e7ae4c634f3d2a2ebf8c1be8e1813bdf9236b6eb29a6b5d50405e
-  data.tar.gz: 642857455ee0f09e90278308c9fe3da3c19e07dbe0e9a9a4ad30671075d71bfdc292a23df2dc2cc2a2c22f0cc452283216f14beac16deb4fe8ee76a95938df80
+  metadata.gz: e18c0c2891d2b0094dafa8b50b9b7d7ed8ba655e3f2f88105a279a655319041e39231417d0041eed2b29bed8b7fa956097f4d5f330a3a62122efd4de5d8d5435
+  data.tar.gz: b9a3fc6f3181e3e63d00d85709598601c3e266e19f471fb0456f7169c2acc2ea350235e480ce8adbbb16b713e234acfe6f9f76d951c4231e3847a48f6149419f

data/History.rdoc

@@ -1,6 +1,16 @@
 = Release History for loggability
 
 ---
+== v0.18.0 [2020-12-24] Michael Granger <ged@faeriemud.org>
+
+Improvements:
+
+- Add memory management to the http log device
+- Add a dead-simple log server example
+- Update for Ruby 3, add my updated gem cert
+
+Thanks again to Mahmood Khan <mkhan1484@gmail.com> for the patch.
+
 
 == v0.17.0 [2020-02-27] Michael Granger <ged@faeriemud.org>
 

data/Rakefile

@@ -3,7 +3,7 @@
 require 'rake/deveiate'
 
 Rake::DevEiate.setup( 'loggability' ) do |project|
-	project.required_ruby_version = '~> 2.5'
+	project.required_ruby_version = ['~> 2.5', '~> 3.0']
 	project.publish_to = 'deveiate:/usr/local/www/public/code'
 end
 

data/lib/loggability.rb

@@ -9,7 +9,7 @@ require 'date'
 module Loggability
 
 	# Package version constant
-	VERSION = '0.17.0'
+	VERSION = '0.18.0'
 
 	# The key for the global logger (Loggability's own logger)
 	GLOBAL_KEY = :__global__

data/lib/loggability/log_device.rb

@@ -38,9 +38,9 @@ class Loggability::LogDevice
 	### * "data_dog_api_key" is the argument that will be passed onto the datadog
 	###   log device's constructor
 	def self::parse_device_spec( target_spec )
-		targets = target_spec.split( ':' ).compact
+		targets = target_spec.split( ';' ).compact
 		return targets.map do |t|
-			target_subclass = t[ DEVICE_TARGET_REGEX, 1 ]&.strip().to_sym
+			target_subclass = t[ DEVICE_TARGET_REGEX, 1 ]&.strip.to_sym
 			target_subclass_args = t[ DEVICE_TARGET_REGEX, 2 ]
 
 			self.create( target_subclass, target_subclass_args )

data/lib/loggability/log_device/http.rb

@@ -33,6 +33,9 @@ class Loggability::LogDevice::Http < Loggability::LogDevice
 	# The default Executor class to use for asynchronous tasks
 	DEFAULT_EXECUTOR_CLASS = Concurrent::SingleThreadExecutor
 
+	# The default for the maximum bytesize of the queue (1 GB)
+	DEFAULT_MAX_QUEUE_BYTESIZE = ( 2 ** 10 ) * ( 2 ** 10 ) * ( 2 ** 10 )
+
 	# The default options for new instances
 	DEFAULT_OPTIONS = {
 		execution_interval: DEFAULT_BATCH_INTERVAL,
@@ -69,6 +72,8 @@ class Loggability::LogDevice::Http < Loggability::LogDevice
 		@endpoint             = URI( endpoint ).freeze
 		@logs_queue           = Queue.new
 
+		@logs_queue_bytesize  = 0
+		@max_queue_bytesize   = opts[:max_queue_bytesize] || DEFAULT_MAX_QUEUE_BYTESIZE
 		@batch_interval       = opts[:batch_interval] || DEFAULT_BATCH_INTERVAL
 		@write_timeout        = opts[:write_timeout] || DEFAULT_WRITE_TIMEOUT
 		@max_batch_size       = opts[:max_batch_size] || DEFAULT_MAX_BATCH_SIZE
@@ -97,6 +102,14 @@ class Loggability::LogDevice::Http < Loggability::LogDevice
 	# logging service.
 	attr_reader :logs_queue
 
+	##
+	# The max bytesize of the queue. Will not queue more messages if this threshold is hit
+	attr_reader :max_queue_bytesize
+
+	##
+	# The size of +logs_queue+ in bytes
+	attr_accessor :logs_queue_bytesize
+
 	##
 	# The monotonic clock time when the last batch of logs were sent
 	attr_accessor :last_send_time
@@ -133,6 +146,13 @@ class Loggability::LogDevice::Http < Loggability::LogDevice
 	### LogDevice API -- write a message to the HTTP device.
 	def write( message )
 		self.start unless self.running?
+		if message.is_a?( Hash )
+			message_size = message.to_json.bytesize
+		else
+			message_size = message.bytesize
+		end
+		return if ( self.logs_queue_bytesize + message_size ) >= self.max_queue_bytesize
+		self.logs_queue_bytesize += message_size
 		self.logs_queue.enq( message )
 		self.send_logs
 	end
@@ -246,7 +266,9 @@ class Loggability::LogDevice::Http < Loggability::LogDevice
 		max_size = self.max_batch_bytesize - self.max_message_bytesize - 2 # for the outer Array
 
 		while count < self.max_batch_size && bytes < max_size && !self.logs_queue.empty?
-			formatted_message = self.format_log_message( self.logs_queue.deq )
+			message = self.logs_queue.deq
+			formatted_message = self.format_log_message( message )
+			self.logs_queue_bytesize -= message.bytesize
 
 			count += 1
 			bytes += formatted_message.bytesize + 3 # comma and delimiters

data/spec/loggability/log_device/http_spec.rb

@@ -166,4 +166,52 @@ describe Loggability::LogDevice::Http do
 		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

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: loggability
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 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-02-27 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-deveiate
@@ -167,8 +166,13 @@ 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
@@ -177,14 +181,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - "~>"
     - !ruby/object:Gem::Version
       version: '2.5'
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: A composable logging system built on the standard Logger library.
 test_files: []