commit 2309ea14204fc2e74084eefde16135b61f0d5c17 Author: Ștefan Talpalaru Date: Wed Mar 6 15:24:39 2019 +0100 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..92b39dc --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# ignore generated files +*.rrd +*.sh +!/process-stats.sh +*.svg + diff --git a/LICENSE-APACHEv2 b/LICENSE-APACHEv2 new file mode 100644 index 0000000..782d1bf --- /dev/null +++ b/LICENSE-APACHEv2 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 Status Research & Development GmbH + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..8766e65 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Status Research & Development GmbH + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5b8dff --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# process-stats.sh + +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) +[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg) + +Collect and visualise resource usage for a single Linux process. + +This script is a wrapper around `pidstat` (from the [sysstat][http://sebastien.godard.pagesperso-orange.fr/index.html] package), [NetHogs][https://github.com/raboof/nethogs] (which usually requires root access to capture network packages with libpcap) and [RRDtool][https://oss.oetiker.ch/rrdtool/]. + +Other requirements: Bash, gawk, getopt from "util-linux". + +## How to use + +```bash +process-stats.sh --pid [--out base_filename] [--rows ] [--verbose] +``` + +For example +```bash +process-stats.sh --pid 12345 --out bla # produces bla.rrd, bla.sh and bla.svg +``` + +### Real-life example + +(Taken from here: https://github.com/status-im/nimbus/issues/262) + +```bash +# in one terminal: +rm -rf ~/.cache/nimbus/db; time ./build/nimbus --prune:archive --port:30304 &>output3.log +# in another terminal, logged in as root, knowing that there is only one "nimbus" process running, +# collecting a maximum of 100000 rows (the default), once per second, showing the raw data on stdout: +./process-stats.sh -v -p $(pidof nimbus) -o nimbus3 +``` + +The data collection ends when the target process exits or when Ctrl+C is +pressed. After this, you'll find three new files in your current directory: + +- "nimbus3.rrd" - collected data +- "nimbus3.sh" - graphing script that can you edit and run again to process "nimbus3.rrd" and regenerate "nimbus3.svg" +- "nimbus3.svg" - resulting graph, with a minimum width of 1000 and a maximum width equal to the number of collected rows (that is to say, the duration in seconds) + +As you can see, in this case the duration was almost five hours and a half, making it hard to see the big picture: + +![nimbus3-long.svg](https://gist.githubusercontent.com/stefantalpalaru/8a676e9ba726b4d5b73107fc9ba23f58/raw/a89f2b9f022df2f7ed6fd31667d421a96a98349a/nimbus3-long.svg?sanitize=true) + +I modified "nimbus3.sh" to divide the graph width by five, in order to show five seconds per pixel and ran it again: + +![nimbus3-short.svg](https://gist.githubusercontent.com/stefantalpalaru/04e3bdf9630cf19b65fb2878daa107b5/raw/a2291a0e7705e780f7cd0d21b85786a13b8fc3dc/nimbus3-short.svg?sanitize=true) + +Now the memory leak is clear, while maintaining enough info about the serial nature of the program. + +## TODO + +- improve the colour scheme +- show voluntary context switches + +## License + +Licensed and distributed under either of + +* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT + +or + +* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0) + +at your option. These files may not be copied, modified, or distributed except according to those terms. + diff --git a/process-stats.sh b/process-stats.sh new file mode 100755 index 0000000..7a28991 --- /dev/null +++ b/process-stats.sh @@ -0,0 +1,254 @@ +#!/bin/bash + +# Copyright (c) 2019 Status Research & Development GmbH. Licensed under +# either of: +# - Apache License, version 2.0 +# - MIT license +# at your option. This file may not be copied, modified, or distributed except +# according to those terms. + +set -u + +#################### +# argument parsing # +#################### +! getopt --test > /dev/null +if [ ${PIPESTATUS[0]} != 4 ]; then + echo '`getopt --test` failed in this environment.' + exit 1 +fi + +OPTS="hvp:o:r:" +LONGOPTS="help,verbose,pid:,output:,rows:" +print_help() { + echo "Usage: $(basename $0) --pid [--out base_filename] [--rows 100000] [--verbose]" + echo "E.g.: $(basename $0) --pid 12345 --out bla # produces bla.rrd, bla.sh and bla.svg" +} +! PARSED=$(getopt --options=${OPTS} --longoptions=${LONGOPTS} --name "$0" -- "$@") +if [ ${PIPESTATUS[0]} != 0 ]; then + # getopt has complained about wrong arguments to stdout + exit 1 +fi +# read getopt's output this way to handle the quoting right +eval set -- "$PARSED" +VERBOSE="0" +PID="" +OUT="out" +ROWS="100000" +while true; do + case "$1" in + -h|--help) + print_help + exit + ;; + -v|--verbose) + VERBOSE=1 + shift + ;; + -p|--pid) + PID="$2" + shift 2 + ;; + -o|--output) + OUT="$2" + shift 2 + ;; + -r|--rows) + ROWS="$2" + shift 2 + ;; + --) + shift + break + ;; + *) + echo "argument parsing error" + exit 1 + esac +done + +[ -z "${PID}" ] && { echo "Error: missing PID!"; print_help; exit 1; } +PROCESS_NAME="$(ps -p ${PID} -o comm --no-headers)" +[ "$(basename $0)" = "${OUT}.sh" ] && { echo "Choose another output filename."; print_help; exit 1; } + +############################### +# check for required programs # +############################### +for PROGRAM in pidstat rrdtool gawk nethogs; do + type "$PROGRAM" &>/dev/null || { echo "Error: '${PROGRAM}' missing"; exit 1; } +done +# nethogs usually needs root access or some capabilities +ERROR=$(nethogs -c 2 -t 2>&1 >/dev/null) +[ $? != 0 ] && { echo "$ERROR"; exit 1; } + +######################## +# network traffic info # +######################## +net_data() { + DATA="$(nethogs -c 2 -t 2>/dev/null | grep "/${PID}/" | tail -n 1 | gawk '{print $2":"$3}')" + [ -z "${DATA}" ] && DATA="0:0" + echo -n "${DATA}" +} + +################### +# data collection # +################### +rrdtool create "${OUT}.rrd" --step 1 \ + DS:cpu:GAUGE:5:U:U \ + DS:rss:GAUGE:5:U:U \ + DS:stack:GAUGE:5:U:U \ + DS:disk_read:GAUGE:5:U:U \ + DS:disk_write:GAUGE:5:U:U \ + DS:net_tx:GAUGE:5:U:U \ + DS:net_rx:GAUGE:5:U:U \ + RRA:AVERAGE:0.5:1:${ROWS} + +# don't interrupt the script on Ctrl+C (used to interrupt pidstat) +trap '' INT +echo -e "Press Ctrl+C to interrupt data collection, or wait until the target process ends.\n" + +START_TIME="$(date +%s)" +LINE_NO_MAX=40 +LINE_NO=${LINE_NO_MAX} + +# TODO: add voluntary context switches +# we don't rely on pidstat column order, in case it varies between sysstat/kernel versions +pidstat -p ${PID} -h -H -u -d -r -s -w 1 | gawk ' +/^#/ { + for(i = 1; i <= NF; i++) { + if($i == "%CPU") { + cpu = i - 1 + continue + } + if($i == "RSS") { + rss = i - 1 + continue + } + if($i == "StkRef") { + stack = i - 1 + continue + } + if($i == "kB_rd/s") { + disk_read = i - 1 + continue + } + if($i == "kB_wr/s") { + disk_write = i - 1 + continue + } + } +} +/^[0-9]/ { + print $1, $cpu, $rss, $stack, $disk_read, $disk_write + fflush(stdout) +} +' | while read LINE; do + [ "${LINE_NO}" = "${LINE_NO_MAX}" ] && LINE_NO=0 && { + [ "${VERBOSE}" = "1" ] && echo "timestamp %CPU RSS stack disk_read disk_write net_TX:net_RX"; + } + # arithmetic expansion looks weird, doesn't it? + (( LINE_NO += 1 )) + NET_DATA="$(net_data)" + [ "${VERBOSE}" = "1" ] && echo "${LINE} ${NET_DATA}" + rrdtool update "${OUT}.rrd" "$(echo -n ${LINE} | tr ' ' ':'):${NET_DATA}" +done + +END_TIME="$(date +%s)" +TOTAL_SECONDS="$[${END_TIME} - ${START_TIME} + 1]" +# arithmetic expansion again +(( i = TOTAL_SECONDS, SECONDS = i % 60, i /= 60, MINUTES = i % 60, HOURS = i / 60 )) +DURATION_FORMATTED="$(printf "%d\\:%02d\\:%02d" ${HOURS} ${MINUTES} ${SECONDS})" +MIN_WIDTH=1000 +WIDTH=${TOTAL_SECONDS} +[ ${WIDTH} -lt ${MIN_WIDTH} ] && WIDTH=${MIN_WIDTH} + +######################## +# SVG graph generation # +######################## + +# We want a script here in order to easily modify the graph without collecting the data again. +cat > "${OUT}.sh" </dev/null + +EOF + +chmod 755 "${OUT}.sh" +./"${OUT}.sh" +echo -e "\nYou can modify and run '${OUT}.sh' to generate a new '${OUT}.svg'." +