sigdump 0.2.3 → 0.2.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +5 -5
  2. data/ChangeLog +9 -0
  3. data/LICENSE +201 -19
  4. data/README.md +14 -9
  5. data/lib/sigdump.rb +54 -35
  6. metadata +3 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 20e16e2f6471680f7163393c866dce385f1f1d3f
4
- data.tar.gz: 61638fe8baf560c431eb59751f072e1c992d0614
2
+ SHA256:
3
+ metadata.gz: abe2f7482171061b4c45ddbea7dec4e0cd4aad82f87a6ef16810cb5f642c7d00
4
+ data.tar.gz: 9a57dbccf02b0d06311aa6d4c50887a27b2c125436700c5c2697700c5ba4d704
5
5
  SHA512:
6
- metadata.gz: c49d03384c0dd3410e38abb7b08f621689419adee7c365e01ef683ff94cdede5bb6f2fa87b5810da811db4282a57b79c54a71c56adf71b2ad05284fb76ffd0d2
7
- data.tar.gz: d1eb8bd6df734dd9c24617ad01c192243c614c2b5cb9ed882eb64cf8363a1817962dee78420a23d6c0f98597891435db5eeee2f4236e1b2a447eb19bd1012f83
6
+ metadata.gz: b1515966db377eb5fba33ca86ba7c18e0bf54ec201151cca211c6f1e96391b4de7353d5f612d1258fca4959b46804a4cc723407ba88731bfc69fe94505eb4703
7
+ data.tar.gz: 3cf7341a8f26ebe2ad3e5011c9f4663c42c518ffa3b9c9c7a000e330355438ae12540a52f76802da0e58f50ecd7391706224070e40497cb90f42636c130ef25a
data/ChangeLog CHANGED
@@ -1,3 +1,12 @@
1
+ 2023-07-03 version 0.2.5:
2
+
3
+ * Added nil guard for thread.backtrace (by @yui-knk)
4
+ * Fixed wrong calculation for array_size and hash_size (by @fatkodima)
5
+ * Improved dumping speed (by @fatkodima)
6
+
7
+ 2016-02-04 version 0.2.4:
8
+
9
+ * In JRuby, signal handler shows Java stacktrace in addition to Ruby stacktrace
1
10
 
2
11
  2015-05-21 version 0.2.3:
3
12
 
data/LICENSE CHANGED
@@ -1,20 +1,202 @@
1
- Copyright (c) 2013 Sadayuki Furuhashi
2
-
3
- Permission is hereby granted, free of charge, to any person obtaining a copy
4
- of this software and associated documentation files (the "Software"), to deal
5
- in the Software without restriction, including without limitation the rights
6
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
- copies of the Software, and to permit persons to whom the Software is
8
- furnished to do so, subject to the following conditions:
9
-
10
- The above copyright notice and this permission notice shall be included in
11
- all copies or substantial portions of the Software.
12
-
13
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19
- THE SOFTWARE.
20
1
 
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2011-2018 Fluentd Authors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md CHANGED
@@ -2,24 +2,28 @@
2
2
 
3
3
  In short: *SIGQUIT of Java VM for Ruby.*
4
4
 
5
- Server applications (like Rails app) cause performance problems, deadlock or memory swapping from time to time. But it's painful to reproduce such kind of problems. If we can get information from a running process without restarting it, it's really helpful.
5
+ Server applications (like Rails apps) cause performance problems, deadlock or memory swapping from time to time. But it's difficult to reproduce such kind of problems. `sigdump` makes it possible to get information from a running process without restarting. Just sending `SIGCONT` signal will dump backtrace and memory profile to `/tmp/sigdump-<pid>.log` file.
6
6
 
7
- `sigdump` gem installs a signal handler which dumps backtrace of running threads, number of allocated objects per class, and GC statistics.
7
+ `sigdump` dumps following information (see also [Sample output](#sample-outout)):
8
8
 
9
- If GC profiler is enabled (`GC::Profiler.enable` is called), it also dumps GC profiler reports.
9
+ * Backtrace of all threads
10
+ * Number of allocated objects per class
11
+ * GC profiler reports if GC profiler is enabled (`GC::Profiler.enable` is called)
12
+ * Stacktrace of Java threads for each Ruby threads if the runtime is JRuby
10
13
 
11
14
  ## Install
12
15
 
13
- Just install one gem `sigdump` and require `sigdump/setup`:
16
+ Just install `sigdump` gem and add `require 'sigdump/setup'` line to your code. Or you can use Bundler as following:
14
17
 
15
18
  ```ruby
16
- gem 'sigdump', :require => 'sigdump/setup'
19
+ # Gemfile
20
+ gem 'sigdump', require: 'sigdump/setup'
17
21
  ```
18
22
 
19
- ### Resque
23
+ Note for [Resque](https://github.com/resque/resque):
20
24
 
21
- Because Resque traps `SIGCONT`, you need to change the signal to another signal such as TSTP.
22
- In environment.rb:
25
+ You need to change the default signal (`SIGCONT`) because Rescue traps `SIGCONT` and it conflicts with sigdump.
26
+ To change the signal, set name of a signal to `SIGDUMP_SIGNAL` environment variable. For Rails, you can add following lines to `environment.rb` file:
23
27
 
24
28
  ```ruby
25
29
  # setup sigdump: https://github.com/frsyuki/sigdump
@@ -29,10 +33,11 @@ require 'sigdump/setup'
29
33
 
30
34
  ## Usage
31
35
 
32
- Send `SIGCONT` signal to dump backtrace and heap status to `/tmp/sigdump-<pid>.log`:
36
+ Send `SIGCONT` signal to the Ruby process. It dumps backtrace and memory profile to `/tmp/sigdump-<pid>.log` file.
33
37
 
34
38
  ```shell
35
39
  $ kill -CONT <pid>
40
+ $ cat /tmp/sigdump-<pid>.log
36
41
  ```
37
42
 
38
43
  Set `SIGDUMP_SIGNAL` environment variable to change the signal (default: SIGCONT).
data/lib/sigdump.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Sigdump
2
- VERSION = "0.2.3"
2
+ VERSION = "0.2.5"
3
3
 
4
4
  def self.setup(signal=ENV['SIGDUMP_SIGNAL'] || 'SIGCONT', path=ENV['SIGDUMP_PATH'])
5
5
  Kernel.trap(signal) do
@@ -21,8 +21,21 @@ module Sigdump
21
21
  end
22
22
 
23
23
  def self.dump_all_thread_backtrace(io)
24
+ use_java_bean = defined?(Thread.current.to_java.getNativeThread.getId)
25
+ if use_java_bean
26
+ begin
27
+ bean = java.lang.management.ManagementFactory.getThreadMXBean
28
+ java_stacktrace_map = Hash[bean.getThreadInfo(bean.getAllThreadIds, true, true).map {|t| [t.getThreadId, t.toString] }]
29
+ rescue
30
+ # security error may happen
31
+ end
32
+ end
24
33
  Thread.list.each do |thread|
25
34
  dump_backtrace(thread, io)
35
+ if java_stacktrace_map
36
+ io.write " In Java " + java_stacktrace_map[thread.to_java.getNativeThread.getId]
37
+ io.flush
38
+ end
26
39
  end
27
40
  nil
28
41
  end
@@ -36,46 +49,52 @@ module Sigdump
36
49
  end
37
50
 
38
51
  io.write " Thread #{thread} status=#{status} priority=#{thread.priority}\n"
39
- thread.backtrace.each {|bt|
40
- io.write " #{bt}\n"
41
- }
52
+ if thread.backtrace
53
+ thread.backtrace.each {|bt|
54
+ io.write " #{bt}\n"
55
+ }
56
+ end
42
57
 
43
58
  io.flush
44
59
  nil
45
60
  end
46
61
 
47
62
  def self.dump_object_count(io)
48
- io.write " Built-in objects:\n"
49
- ObjectSpace.count_objects.sort_by {|k,v| -v }.each {|k,v|
50
- io.write "%10s: %s\n" % [_fn(v), k]
51
- }
52
-
53
- string_size = 0
54
- array_size = 0
55
- hash_size = 0
56
- cmap = {}
57
- ObjectSpace.each_object {|o|
58
- c = o.class
59
- cmap[c] = (cmap[c] || 0) + 1
60
- if c == String
61
- string_size += o.bytesize
62
- elsif c == Array
63
- array_size = o.size
64
- elsif c == Hash
65
- hash_size = o.size
66
- end
67
- }
68
-
69
- io.write " All objects:\n"
70
- cmap.sort_by {|k,v| -v }.each {|k,v|
71
- io.write "%10s: %s\n" % [_fn(v), k]
72
- }
73
-
74
- io.write " String #{_fn(string_size)} bytes\n"
75
- io.write " Array #{_fn(array_size)} elements\n"
76
- io.write " Hash #{_fn(hash_size)} pairs\n"
77
-
78
- io.flush
63
+ if defined?(ObjectSpace.count_objects)
64
+ # ObjectSpace doesn't work in JRuby
65
+
66
+ io.write " Built-in objects:\n"
67
+ ObjectSpace.count_objects.sort_by {|k,v| -v }.each {|k,v|
68
+ io.write "%10s: %s\n" % [_fn(v), k]
69
+ }
70
+
71
+ string_size = 0
72
+ array_size = 0
73
+ hash_size = 0
74
+ cmap = Hash.new(0).compare_by_identity
75
+ ObjectSpace.each_object {|o|
76
+ c = o.class rescue nil
77
+ cmap[c] += 1
78
+ if c == String
79
+ string_size += o.bytesize
80
+ elsif c == Array
81
+ array_size += o.size
82
+ elsif c == Hash
83
+ hash_size += o.size
84
+ end
85
+ }
86
+
87
+ io.write " All objects:\n"
88
+ cmap.sort_by {|k,v| -v }.each {|k,v|
89
+ io.write "%10s: %s\n" % [_fn(v), k]
90
+ }
91
+
92
+ io.write " String #{_fn(string_size)} bytes\n"
93
+ io.write " Array #{_fn(array_size)} elements\n"
94
+ io.write " Hash #{_fn(hash_size)} pairs\n"
95
+
96
+ io.flush
97
+ end
79
98
  nil
80
99
  end
81
100
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sigdump
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.3
4
+ version: 0.2.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sadayuki Furuhashi
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-05-22 00:00:00.000000000 Z
11
+ date: 2023-07-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -60,8 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
60
60
  - !ruby/object:Gem::Version
61
61
  version: '0'
62
62
  requirements: []
63
- rubyforge_project:
64
- rubygems_version: 2.4.5
63
+ rubygems_version: 3.4.13
65
64
  signing_key:
66
65
  specification_version: 4
67
66
  summary: Setup signal handler which dumps backtrace of running threads and number