leak_profiler 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +3 -0
  3. data/LICENSE +21 -0
  4. data/README.md +8 -0
  5. data/lib/leak_profiler/allocations.rb +0 -1
  6. data/lib/leak_profiler/leak_profiler.rb +1 -0
  7. data/lib/leak_profiler/memory_usage.rb +2 -0
  8. metadata +6 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b280edc6b1a2ec2bcdc27a20c729cfb4ea1471ba75d03162833a5e45f9d65b0b
4
- data.tar.gz: 6e9223a7cfeb182de905ee9a06041c6a07b9ce736703baf03f9c4c3ab1e0c72e
3
+ metadata.gz: 062abe3c1684ea42ac45baabb2b11ab19624fd461af76ee89aff981d0dec4cb4
4
+ data.tar.gz: e048e567ceae885b4ac91ff8b72b611144e131c9462ba1e33589c12e1fd392bc
5
5
  SHA512:
6
- metadata.gz: 8ff005aa3217cb7214fbce922b7b92d5acfb354ec2cc2df0bec01b1727aeabe9fcdb62630a645fe3b5c1f462c860a65e53e86d205119b10bc76306b12842de50
7
- data.tar.gz: 319dd0a47ef8a5987c779c578a4850849fb3f4de899022369e0aa774970c01b02f7f689e7fe6c7ca9e7ef50dcd51c44ae97b11bc4db6a0a5527ee5451b60b145
6
+ metadata.gz: f023bc3f7a64638d2e63d7a9262a59b61b16459c22dca2d1a1bb5a3c846deb0758ffd525f504863107f0d3a1611f243fea0f55f6e2cdfbb801c8e75b51492b0d
7
+ data.tar.gz: 47fe07ea97905182c7656f9557efee004906a15ffcd8e56d465ad39eb3fe57cfc7878e3cc094b6779d6fb33dc143dfcc1b420c55cbbeb8fc2cea3f8ed03950c0
data/.rubocop.yml CHANGED
@@ -14,6 +14,9 @@ Metrics:
14
14
  Style/Copyright:
15
15
  Enabled: false
16
16
 
17
+ Style/ImplicitRuntimeError:
18
+ Enabled: false
19
+
17
20
  Style/MissingElse:
18
21
  Enabled: false
19
22
 
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Watson
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -66,6 +66,10 @@ Referrers ----------------------------------------------------------------------
66
66
  * `max_referrers` (default `3`): Outputs the number of references in order of the amount of memory used.
67
67
  * `report` (defalut `nil`): Specify the logger object if you want to use custom logger.
68
68
 
69
+ > [!WARNING]
70
+ > This uses `ObjectSpace.allocation_sourcefile` method to measurement.
71
+ > It can't get an object allocated information in Ruby core API / C extension library API.
72
+
69
73
  ### `LeakProfiler#report_rss`
70
74
  This method outputs the RSS (Resident Set Size) of the process with CSV format, like:
71
75
 
@@ -80,6 +84,10 @@ elapsed [sec],memory usage (rss) [MB]
80
84
  * Arguments:
81
85
  * `interval` (default `1`): The interval in seconds for report.
82
86
 
87
+ > [!WARNING]
88
+ > This uses this uses `ps` command for measurement.
89
+ > So, this is not supported Windows platform.
90
+
83
91
  ## Contributing
84
92
 
85
93
  Bug reports and pull requests are welcome on GitHub at https://github.com/Watson1978/leak_profiler.
data/lib/leak_profiler/allocations.rb CHANGED
@@ -1,7 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require 'objspace'
4
- require 'logger'
5
4
 
6
5
  class LeakProfiler
7
6
  class Allocations
data/lib/leak_profiler/leak_profiler.rb CHANGED
@@ -3,6 +3,7 @@
3
3
  require_relative 'allocations'
4
4
  require_relative 'memory_usage'
5
5
  require 'fileutils'
6
+ require 'logger'
6
7
 
7
8
  class LeakProfiler
8
9
  def initialize(output_dir: './leak_profiler')
data/lib/leak_profiler/memory_usage.rb CHANGED
@@ -8,6 +8,8 @@ class LeakProfiler
8
8
  end
9
9
 
10
10
  def report
11
+ raise('Not supported Windows platform because this uses `ps` command for measurement.') if /mingw/.match?(RUBY_PLATFORM)
12
+
11
13
  pid = Process.pid
12
14
 
13
15
  Thread.new do
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: leak_profiler
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Watson
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2025-04-01 00:00:00.000000000 Z
10
+ date: 2025-04-05 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: logger
@@ -32,6 +32,7 @@ extra_rdoc_files: []
32
32
  files:
33
33
  - ".rubocop.yml"
34
34
  - ".rubocop_todo.yml"
35
+ - LICENSE
35
36
  - README.md
36
37
  - Rakefile
37
38
  - lib/leak_profiler.rb
@@ -39,7 +40,8 @@ files:
39
40
  - lib/leak_profiler/leak_profiler.rb
40
41
  - lib/leak_profiler/memory_usage.rb
41
42
  homepage: https://github.com/Watson1978/leak_profiler
42
- licenses: []
43
+ licenses:
44
+ - MIT
43
45
  metadata:
44
46
  homepage_uri: https://github.com/Watson1978/leak_profiler
45
47
  source_code_uri: https://github.com/Watson1978/leak_profiler
@@ -58,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
58
60
  - !ruby/object:Gem::Version
59
61
  version: '0'
60
62
  requirements: []
61
- rubygems_version: 3.6.6
63
+ rubygems_version: 3.6.2
62
64
  specification_version: 4
63
65
  summary: A simple profiler for Ruby to detect memory leak.
64
66
  test_files: []