├── README ├── bin └── jvm-gc-stats.rb └── LICENSE /README: -------------------------------------------------------------------------------- 1 | JVM-GC-STATS 2 | ============ 3 | 4 | SUMMARY 5 | ------- 6 | A Ruby script to parse Java Virtual Machine (JVM) garbage collection 7 | trace output, push the data into Ganglia and alert on anomolies. 8 | The data and graphs produced are intended to support operational 9 | monitoring and inform GC tuning decisions. 10 | 11 | The JVM is assumed to be Java6 and invoked with the following flags: 12 | -XX:+UseConcMarkSweepGC 13 | -verbosegc 14 | -XX:+PrintGCDetails 15 | -XX:+PrintGCTimeStamps 16 | -XX:+PrintGCDateStamps 17 | 18 | Currently this script is a rough prototype written by a Ruby neophyte 19 | in a rush to get data. Be gentle. 20 | 21 | LICENSE 22 | ------- 23 | Apache 2.0 License. See included license file. 24 | -------------------------------------------------------------------------------- /bin/jvm-gc-stats.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/ruby 2 | # jvm-gc-stats: gather stats from jvm garbage collection trace and publish ganglia graphs 3 | 4 | require 'getoptlong' 5 | 6 | 7 | # If you wish to change the report method, simply open this class, make your changes, and 8 | # instantiate it. You may also extend it if that's your jam. 9 | # 10 | class JvmGcStats 11 | def usage 12 | puts "jvm-gc-stats.rb: Tails a jvm logfile and reports its entries " 13 | puts 14 | puts "usage: jvm-gc-stats.rb [options]" 15 | puts "options:" 16 | puts " -n say what I would report, but don't report it" 17 | puts " -P optional prefix for ganglia names" 18 | puts " -f gc logfile to use. defaults to a file named stdout" 19 | puts " -s seconds sleep time in seconds waiting for new log lines" 20 | puts " -d turn on verbose debug output" 21 | puts " -w read the whole file from the beginning rather than tail" 22 | puts 23 | end 24 | 25 | # Initializing the class will process stdin for command-line args and start processing. 26 | def initialize(filename="stdout", report=true, prefix='', report_timeout=86400, tail_sleep_secs=60, tail=true, debug=false) 27 | @filename = filename 28 | @report = report 29 | @prefix = prefix 30 | @report_timeout = report_timeout 31 | @tail_sleep_secs = tail_sleep_secs 32 | @debug = debug 33 | @tail = tail 34 | 35 | opts = GetoptLong.new( 36 | [ '--help', GetoptLong::NO_ARGUMENT ], 37 | [ '-h', GetoptLong::NO_ARGUMENT ], 38 | [ '-n', GetoptLong::NO_ARGUMENT ], 39 | [ '-P', GetoptLong::OPTIONAL_ARGUMENT ], 40 | [ '-f', GetoptLong::OPTIONAL_ARGUMENT ], 41 | [ '-s', GetoptLong::OPTIONAL_ARGUMENT ], 42 | [ '-d', GetoptLong::OPTIONAL_ARGUMENT ], 43 | [ '-w', GetoptLong::OPTIONAL_ARGUMENT ] 44 | ) 45 | 46 | opts.each do |opt, arg| 47 | case opt 48 | when '--help' 49 | usage 50 | exit 0 51 | when '-h' 52 | usage 53 | exit 0 54 | when '-n' 55 | @report = false 56 | when '-P' 57 | @prefix = arg 58 | when '-f' 59 | @filename = arg 60 | when '-s' 61 | @tail_sleep_secs = arg.to_i 62 | when '-d' 63 | @debug = true 64 | when '-w' 65 | @tail = false 66 | end 67 | end 68 | 69 | end 70 | 71 | 72 | 73 | def report(name, value, units="items") 74 | key = "#{@prefix}jvm.gc.#{name}" 75 | 76 | if @report 77 | system("gmetric -t float -n \"#{key}\" -v \"#{value}\" -u \"#{units}\" -d #{@report_timeout}") 78 | else 79 | puts "#{key}=#{value} #{units}" 80 | end 81 | end 82 | 83 | 84 | TAIL_BLOCK_SIZE = 2048 85 | ALL_MEASUREMENTS = %w[promoFail.realSec major.concur.userSec major.concur.realSec major.block.userSec] + 86 | %w[%s.survivalRatio %s.kbytesPerSec %s.userSec %s.realSec].collect{|m| %w[minor full].collect{|s| m % s}}.flatten 87 | 88 | def open_file(file=@filename) 89 | File.new(file, "r") 90 | end 91 | 92 | def tail(file=@filename) 93 | f = open_file(file) 94 | f.seek(0, IO::SEEK_END) if @tail 95 | current_inode = f.stat.ino 96 | lines = "" 97 | 98 | loop do 99 | begin 100 | # Limit reads to prevent loading entire file into memory if not seeking to end 101 | part = f.read_nonblock(TAIL_BLOCK_SIZE) rescue nil 102 | 103 | if part == nil 104 | # End of file reached, wait for more data. 105 | # Also report all the metrics as zero as a sentinel to your reporting system. 106 | ALL_MEASUREMENTS.each{|m| report(m, 0)} 107 | sleep @tail_sleep_secs 108 | 109 | f = open(file) unless File.stat(file).ino == current_inode 110 | current_inode = f.stat.ino 111 | else 112 | lines += part 113 | end 114 | end until lines.include?("\n") 115 | 116 | # If there isn't a null trailing field, last string isn't newline terminated 117 | split = lines.split("\n", TAIL_BLOCK_SIZE) 118 | 119 | if split[-1] == "" 120 | # Remove null trailing field 121 | split.pop 122 | lines = "" # reset lines 123 | else 124 | # Save partial line for next round 125 | lines = split.pop 126 | end 127 | 128 | split.each do |line| 129 | ingest(line) 130 | end 131 | end 132 | end 133 | 134 | USER_REAL = '.*?user=(\d+.\d+).*?real=(\d+.\d+)' 135 | MINOR = Regexp.new('ParNew: (\d+)K->(\d+)' + USER_REAL) 136 | FULL = Regexp.new('Full GC \[CMS: (\d+)K->(\d+)' + USER_REAL) 137 | PROMOTION_FAILED = Regexp.new('promotion failed' + USER_REAL) 138 | SCAVANGE = Regexp.new('Trying a full collection because scavenge failed') 139 | CMS_START = Regexp.new('\[CMS-concurrent.*start\]') 140 | CMS_CONCURRENT = Regexp.new('CMS-concurrent' + USER_REAL) 141 | CMS_BLOCK = Regexp.new('CMS-(initial-|re)mark' + USER_REAL) 142 | STARTUP = Regexp.new('^Heap$|^ par new generation|^ eden space|^ from space|^ to space|^ concurrent mark-sweep generation|^ concurrent-mark-sweep perm') 143 | 144 | def denominator(val) 145 | rv = val.to_f 146 | # Assume that collections under a millisecond took half a millisecond 147 | rv = 0.05 if rv == 0 148 | rv 149 | end 150 | 151 | def minorAndFull(match, collection, str) 152 | fromK = match[1].to_i 153 | toK = match[2].to_i 154 | deltaK = fromK - toK 155 | ratio = toK.to_f / fromK.to_f 156 | userSec = denominator(match[3]) 157 | realSec = denominator(match[4]) 158 | kPerRealSec = deltaK / realSec 159 | kPerUserSec = deltaK / userSec 160 | 161 | if @debug 162 | printf("%-15s user %5.2f real %5.2f ratio %1.3f kPerUserSec %10d kPerRealSec %10d \n", 163 | collection, userSec, realSec, ratio, kPerUserSec, kPerRealSec) 164 | end 165 | 166 | report("#{collection}.survivalRatio", ratio) 167 | report("#{collection}.kbytesPerSec", kPerRealSec) 168 | report("#{collection}.userSec", userSec) 169 | report("#{collection}.realSec", realSec) 170 | end 171 | 172 | def ingest(str) 173 | case str 174 | when MINOR 175 | minorAndFull($~, "minor", str) 176 | when FULL 177 | minorAndFull($~, "full", str) 178 | when PROMOTION_FAILED 179 | userSec = $~[1].to_f 180 | realSec = $~[2].to_f 181 | printf "%-15s user %5.2f real %5.2f\n", "promoFail", userSec, realSec if @debug 182 | # Reporting userSec for promotion failures is redundant 183 | report("promoFail.realSec", realSec) 184 | when CMS_CONCURRENT 185 | userSec = $~[1].to_f 186 | realSec = $~[2].to_f 187 | printf "%-15s user %5.2f real %5.2f\n", "major concur", userSec, realSec if @debug 188 | report("major.concur.userSec", userSec) 189 | report("major.concur.realSec", realSec) 190 | when CMS_BLOCK 191 | userSec = $~[2].to_f 192 | realSec = $~[3].to_f 193 | printf "%-15s user %5.2f real %5.2f\n", "major block", userSec, realSec if @debug 194 | report("major.block.userSec", userSec) 195 | report("major.block.realSec", realSec) 196 | when CMS_START 197 | puts "ignore cms start #{str}" if @debug 198 | when STARTUP 199 | puts "ignore startup #{str}" if @debug 200 | when SCAVANGE 201 | puts "ignore scavange #{str}" if @debug 202 | else 203 | puts "UNMATCHED #{str}" 204 | end 205 | end 206 | end 207 | 208 | 209 | # If we're being run from the command-line, treat as a script. 210 | if __FILE__ == $0 211 | gcstats = JvmGcStats.new 212 | gcstats.tail 213 | end 214 | 215 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 2009 Twitter, Inc. 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. 203 | --------------------------------------------------------------------------------