memory-leak 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b50558351a2324cdddac0369f5b4f81d8787a1b9cee2d92206c997777637ae4
+  data.tar.gz: 7091170b19d36840768f145dbba9bd8f805724af1a2332b60f8ac3df40bb5ed3
+SHA512:
+  metadata.gz: 4edd0b28026f560e48717721f7f6afcb10798710654758637320ed8dabcd6af8306d68f69d825ab901c78eca027e1172e54e1c970204f2cc7a5e5ac8a0686d0b
+  data.tar.gz: 959f65bc8f7e403cd482d0519d1768e5226b0ed95995dc52a0dca3c9fbc03893e9df7a54b4ad32b49273e1d3919911d93c8965d5e5927157b67c06b80c8da99d

checksums.yaml.gz.sig

@@ -0,0 +1,4 @@
+eiM�zK�a�d��]<,�k��.-WZ8V����v*����]/|�P��dž��F��T�y�� ���J�B˰
+Q+�:��9�a�����#~x����W�����'�Ӧp��H4��V�#=��d,���$���ۨ�<hjN��<�aó����Gk�O��5�[4���{��
+��p�(l�%5��X����l���z�>��iKv�L�uF{{b�L�+[���
+�
háD������Ǽ�,��4�D�1~��H�u8�=��V��������z������l	�'���}��;�]�\��d�'(,� �]�%�\/5+��ڜ���	����}塥H_��6����Ra0J������1e!�1*��&�PK���`��g^9��

data/lib/memory/leak/detector.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "console"
+
+module Memory
+	module Leak
+		# Detects memory leaks by tracking heap size increases.
+		#
+		# A memory leak is characterised by the memory usage of the application continuing to rise over time. We can detect this by sampling memory usage and comparing it to the previous sample. If the memory usage is higher than the previous sample, we can say that the application has allocated more memory. Eventually we expect to see this stabilize, but if it continues to rise, we can say that the application has a memory leak.
+		#
+		# We should be careful not to filter historical data, as some memory leaks may only become apparent after a long period of time. Any kind of filtering may prevent us from detecting such a leak.
+		class Detector
+			# We only track heap size changes greater than this threshold (KB), across the DEFAULT_INTERVAL.
+			# True memory leaks will eventually hit this threshold, while small fluctuations will not.
+			DEFAULT_THRESHOLD = 1024*10
+			
+			# We track the last N heap size increases.
+			# If the heap size is not stabilizing within the specified limit, we can assume there is a leak.
+			# With a default interval of 10 seconds, this will track the last ~3 minutes of heap size increases.
+			DEFAULT_LIMIT = 20
+			
+			# Create a new detector.
+			#
+			# @parameter maximum [Numeric] The initial maximum heap size, from which we willl track increases, in KiB.
+			# @parameter threshold [Numeric] The threshold for heap size increases, in KiB.
+			# @parameter limit [Numeric] The limit for the number of heap size increases, before we assume a memory leak.
+			# @pid [Integer] The process ID to monitor.
+			def initialize(maximum: nil, threshold: DEFAULT_THRESHOLD, limit: DEFAULT_LIMIT, pid: Process.pid)
+				@maximum = maximum
+				@threshold = threshold
+				@limit = limit
+				@pid = pid
+				
+				# The number of increasing heap size samples.
+				@count = 0
+			end
+			
+			# @attribute [Numeric] The current maximum heap size.
+			attr :maximum
+			
+			# @attribute [Numeric] The threshold for heap size increases.
+			attr :threshold
+			
+			# @attribute [Numeric] The limit for the number of heap size increases, before we assume a memory leak.
+			attr :limit
+			
+			# @attribute [Integer] The number of increasing heap size samples. 
+			attr :count
+			
+			# The current resident set size (RSS) of the process.
+			#
+			# Even thought the absolute value of this number may not very useful, the relative change is useful for detecting memory leaks, and it works on most platforms.
+			#
+			# @returns [Numeric] Memory usage size in KiB.
+			def memory_usage(pid = @pid)
+				IO.popen(["ps", "-o", "rss=", pid.to_s]) do |io|
+					return Integer(io.readlines.last)
+				end
+			end
+			
+			# Indicates whether a memory leak has been detected.
+			#
+			# If the number of increasing heap size samples is greater than or equal to the limit, a memory leak is assumed.
+			#
+			# @returns [Boolean] True if a memory leak has been detected.
+			def memory_leak_detected?
+				@count >= @limit
+			end
+			
+			# Capture a memory usage sample and yield if a memory leak is detected.
+			#
+			# @yields {|sample, detector| ...} If a memory leak is detected.
+			def capture_sample
+				sample = memory_usage
+				
+				if @maximum
+					delta = sample - @maximum
+					Console.debug(self, "Heap size captured.", sample: sample, delta: delta, threshold: @threshold, maximum: @maximum)
+					
+					if delta > @threshold
+						@maximum = sample
+						@count += 1
+						
+						Console.debug(self, "Heap size increased.", maximum: @maximum, count: @count)
+					end
+				else
+					Console.debug(self, "Initial heap size captured.", sample: sample)
+					@maximum = sample
+				end
+				
+				return sample
+			end
+		end
+	end
+end

data/lib/memory/leak/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module Memory
+	module Leak
+		VERSION = "0.1.0"
+	end
+end

data/lib/memory/leak.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "leak/version"
+require_relative "leak/detector"
+
+# @namespace
+module Memory
+	# @namespace
+	module Leak
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2025, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,35 @@
+# Memory::Leak
+
+Detects memory leaks in Ruby applications.
+
+[![Development Status](https://github.com/socketry/memory-leak/workflows/Test/badge.svg)](https://github.com/socketry/memory-leak/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/memory-leak/) for more details.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/memory-leak/releases/index) for all releases.
+
+### v0.1.0
+
+  - Initial implementation.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.1.0
+
+  - Initial implementation.

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: memory-leak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/memory/leak.rb
+- lib/memory/leak/detector.rb
+- lib/memory/leak/version.rb
+- license.md
+- readme.md
+- releases.md
+homepage: https://github.com/socketry/memory-leak
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/memory-leak/
+  source_code_uri: https://github.com/socketry/memory-leak.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A memory leak detector.
+test_files: []