├── .gitignore ├── COPYING ├── README.md └── graphping /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | # C extensions 4 | *.so 5 | 6 | # Packages 7 | *.egg 8 | *.egg-info 9 | dist 10 | build 11 | eggs 12 | parts 13 | bin 14 | var 15 | sdist 16 | develop-eggs 17 | .installed.cfg 18 | lib 19 | lib64 20 | 21 | # Installer logs 22 | pip-log.txt 23 | 24 | # Unit test / coverage reports 25 | .coverage 26 | .tox 27 | nosetests.xml 28 | 29 | # Translations 30 | *.mo 31 | 32 | # Mr Developer 33 | .mr.developer.cfg 34 | .project 35 | .pydevproject 36 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | Copyright (C) 2013 Martijn Grendelman 2 | 3 | Apache License 4 | Version 2.0, January 2004 5 | http://www.apache.org/licenses/ 6 | 7 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 8 | 9 | 1. Definitions. 10 | 11 | "License" shall mean the terms and conditions for use, reproduction, 12 | and distribution as defined by Sections 1 through 9 of this document. 13 | 14 | "Licensor" shall mean the copyright owner or entity authorized by 15 | the copyright owner that is granting the License. 16 | 17 | "Legal Entity" shall mean the union of the acting entity and all 18 | other entities that control, are controlled by, or are under common 19 | control with that entity. For the purposes of this definition, 20 | "control" means (i) the power, direct or indirect, to cause the 21 | direction or management of such entity, whether by contract or 22 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 23 | outstanding shares, or (iii) beneficial ownership of such entity. 24 | 25 | "You" (or "Your") shall mean an individual or Legal Entity 26 | exercising permissions granted by this License. 27 | 28 | "Source" form shall mean the preferred form for making modifications, 29 | including but not limited to software source code, documentation 30 | source, and configuration files. 31 | 32 | "Object" form shall mean any form resulting from mechanical 33 | transformation or translation of a Source form, including but 34 | not limited to compiled object code, generated documentation, 35 | and conversions to other media types. 36 | 37 | "Work" shall mean the work of authorship, whether in Source or 38 | Object form, made available under the License, as indicated by a 39 | copyright notice that is included in or attached to the work 40 | (an example is provided in the Appendix below). 41 | 42 | "Derivative Works" shall mean any work, whether in Source or Object 43 | form, that is based on (or derived from) the Work and for which the 44 | editorial revisions, annotations, elaborations, or other modifications 45 | represent, as a whole, an original work of authorship. For the purposes 46 | of this License, Derivative Works shall not include works that remain 47 | separable from, or merely link (or bind by name) to the interfaces of, 48 | the Work and Derivative Works thereof. 49 | 50 | "Contribution" shall mean any work of authorship, including 51 | the original version of the Work and any modifications or additions 52 | to that Work or Derivative Works thereof, that is intentionally 53 | submitted to Licensor for inclusion in the Work by the copyright owner 54 | or by an individual or Legal Entity authorized to submit on behalf of 55 | the copyright owner. For the purposes of this definition, "submitted" 56 | means any form of electronic, verbal, or written communication sent 57 | to the Licensor or its representatives, including but not limited to 58 | communication on electronic mailing lists, source code control systems, 59 | and issue tracking systems that are managed by, or on behalf of, the 60 | Licensor for the purpose of discussing and improving the Work, but 61 | excluding communication that is conspicuously marked or otherwise 62 | designated in writing by the copyright owner as "Not a Contribution." 63 | 64 | "Contributor" shall mean Licensor and any individual or Legal Entity 65 | on behalf of whom a Contribution has been received by Licensor and 66 | subsequently incorporated within the Work. 67 | 68 | 2. Grant of Copyright License. Subject to the terms and conditions of 69 | this License, each Contributor hereby grants to You a perpetual, 70 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 71 | copyright license to reproduce, prepare Derivative Works of, 72 | publicly display, publicly perform, sublicense, and distribute the 73 | Work and such Derivative Works in Source or Object form. 74 | 75 | 3. Grant of Patent License. Subject to the terms and conditions of 76 | this License, each Contributor hereby grants to You a perpetual, 77 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 78 | (except as stated in this section) patent license to make, have made, 79 | use, offer to sell, sell, import, and otherwise transfer the Work, 80 | where such license applies only to those patent claims licensable 81 | by such Contributor that are necessarily infringed by their 82 | Contribution(s) alone or by combination of their Contribution(s) 83 | with the Work to which such Contribution(s) was submitted. If You 84 | institute patent litigation against any entity (including a 85 | cross-claim or counterclaim in a lawsuit) alleging that the Work 86 | or a Contribution incorporated within the Work constitutes direct 87 | or contributory patent infringement, then any patent licenses 88 | granted to You under this License for that Work shall terminate 89 | as of the date such litigation is filed. 90 | 91 | 4. Redistribution. You may reproduce and distribute copies of the 92 | Work or Derivative Works thereof in any medium, with or without 93 | modifications, and in Source or Object form, provided that You 94 | meet the following conditions: 95 | 96 | (a) You must give any other recipients of the Work or 97 | Derivative Works a copy of this License; and 98 | 99 | (b) You must cause any modified files to carry prominent notices 100 | stating that You changed the files; and 101 | 102 | (c) You must retain, in the Source form of any Derivative Works 103 | that You distribute, all copyright, patent, trademark, and 104 | attribution notices from the Source form of the Work, 105 | excluding those notices that do not pertain to any part of 106 | the Derivative Works; and 107 | 108 | (d) If the Work includes a "NOTICE" text file as part of its 109 | distribution, then any Derivative Works that You distribute must 110 | include a readable copy of the attribution notices contained 111 | within such NOTICE file, excluding those notices that do not 112 | pertain to any part of the Derivative Works, in at least one 113 | of the following places: within a NOTICE text file distributed 114 | as part of the Derivative Works; within the Source form or 115 | documentation, if provided along with the Derivative Works; or, 116 | within a display generated by the Derivative Works, if and 117 | wherever such third-party notices normally appear. The contents 118 | of the NOTICE file are for informational purposes only and 119 | do not modify the License. You may add Your own attribution 120 | notices within Derivative Works that You distribute, alongside 121 | or as an addendum to the NOTICE text from the Work, provided 122 | that such additional attribution notices cannot be construed 123 | as modifying the License. 124 | 125 | You may add Your own copyright statement to Your modifications and 126 | may provide additional or different license terms and conditions 127 | for use, reproduction, or distribution of Your modifications, or 128 | for any such Derivative Works as a whole, provided Your use, 129 | reproduction, and distribution of the Work otherwise complies with 130 | the conditions stated in this License. 131 | 132 | 5. Submission of Contributions. Unless You explicitly state otherwise, 133 | any Contribution intentionally submitted for inclusion in the Work 134 | by You to the Licensor shall be under the terms and conditions of 135 | this License, without any additional terms or conditions. 136 | Notwithstanding the above, nothing herein shall supersede or modify 137 | the terms of any separate license agreement you may have executed 138 | with Licensor regarding such Contributions. 139 | 140 | 6. Trademarks. This License does not grant permission to use the trade 141 | names, trademarks, service marks, or product names of the Licensor, 142 | except as required for reasonable and customary use in describing the 143 | origin of the Work and reproducing the content of the NOTICE file. 144 | 145 | 7. Disclaimer of Warranty. Unless required by applicable law or 146 | agreed to in writing, Licensor provides the Work (and each 147 | Contributor provides its Contributions) on an "AS IS" BASIS, 148 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 149 | implied, including, without limitation, any warranties or conditions 150 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 151 | PARTICULAR PURPOSE. You are solely responsible for determining the 152 | appropriateness of using or redistributing the Work and assume any 153 | risks associated with Your exercise of permissions under this License. 154 | 155 | 8. Limitation of Liability. In no event and under no legal theory, 156 | whether in tort (including negligence), contract, or otherwise, 157 | unless required by applicable law (such as deliberate and grossly 158 | negligent acts) or agreed to in writing, shall any Contributor be 159 | liable to You for damages, including any direct, indirect, special, 160 | incidental, or consequential damages of any character arising as a 161 | result of this License or out of the use or inability to use the 162 | Work (including but not limited to damages for loss of goodwill, 163 | work stoppage, computer failure or malfunction, or any and all 164 | other commercial damages or losses), even if such Contributor 165 | has been advised of the possibility of such damages. 166 | 167 | 9. Accepting Warranty or Additional Liability. While redistributing 168 | the Work or Derivative Works thereof, You may choose to offer, 169 | and charge a fee for, acceptance of support, warranty, indemnity, 170 | or other liability obligations and/or rights consistent with this 171 | License. However, in accepting such obligations, You may act only 172 | on Your own behalf and on Your sole responsibility, not on behalf 173 | of any other Contributor, and only if You agree to indemnify, 174 | defend, and hold each Contributor harmless for any liability 175 | incurred by, or claims asserted against, such Contributor by reason 176 | of your accepting any such warranty or additional liability. 177 | 178 | END OF TERMS AND CONDITIONS 179 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | graphping 2 | ========= 3 | 4 | Send ping statistics for multiple hosts to Graphite 5 | 6 | Description 7 | ----------- 8 | 9 | This Python program takes a list of hostnames to collect ping statistics for. 10 | It uses the 'fping' program to do the real work, and send the results to 11 | Graphite. By default, it detaches itself from the console and continues to run 12 | in the background. 13 | 14 | Until stopped, the program starts an 'fping' for all the given targets and sends 15 | 30 ICMP ping packets. The results (min, max, average and mean ping round-trip 16 | times, as well as packet loss percentage) are sent to a Graphite server, which 17 | by default should be running on localhost:2003. It then sleeps until the next 18 | minute on the system clock before it starts another 'fping'. This way, you get 19 | one measurement per minute. This is not configurable at this time. 20 | 21 | By default, it uses 'ping' as a prefix for the metric name in Graphite, 22 | followed by the hostname, with dots replaced by underscores. So for a host 23 | named 'host.domain.tld', you would get the following metrics in Graphite, all 24 | of which are gauges: 25 | 26 | * ping.host_domain_tld.avgrtt 27 | * ping.host_domain_tld.minrtt 28 | * ping.host_domain_tld.medianrtt 29 | * ping.host_domain_tld.maxrtt 30 | * ping.host_domain_tld.packetloss 31 | 32 | Requirements 33 | ------------ 34 | 35 | * [fping](http://www.fping.org/) ([Debian](http://packages.debian.org/wheezy/fping)) 36 | * [python-daemon](https://pypi.python.org/pypi/python-daemon/) ([Debian](http://packages.debian.org/wheezy/python-daemon)) 37 | * A [Graphite](http://graphite.wikidot.com/) server 38 | 39 | The program uses regular expressions to get useful numbers from the fping ouput, so 40 | it depends on specific formatting of the output. The following fping programs are 41 | known to be compatible: 42 | 43 | * version 3.4 on RHEL 6.4 44 | * version 3.2 on Debian Wheezy 45 | 46 | The output should look like this (for 2 hosts, 3 packets per host): 47 | 48 | ``` 49 | www.github.io : [0], 84 bytes, 4.26 ms (4.26 avg, 0% loss) 50 | www.google.com : [0], 84 bytes, 8.35 ms (8.35 avg, 0% loss) 51 | www.github.io : [1], 84 bytes, 3.25 ms (3.75 avg, 0% loss) 52 | www.google.com : [1], 84 bytes, 7.84 ms (8.09 avg, 0% loss) 53 | www.github.io : [2], 84 bytes, 3.32 ms (3.61 avg, 0% loss) 54 | www.google.com : [2], 84 bytes, 7.86 ms (8.01 avg, 0% loss) 55 | 56 | www.github.io : xmt/rcv/%loss = 3/3/0%, min/avg/max = 3.25/3.61/4.26 57 | www.google.com : xmt/rcv/%loss = 3/3/0%, min/avg/max = 7.84/8.01/8.35 58 | ``` 59 | 60 | Configuration 61 | ------------- 62 | 63 | Set up a [Carbon/Whisper retention schema](http://graphite.readthedocs.org/en/latest/config-carbon.html) 64 | for the ping statistics, keeping one sample per minute for some time, and 65 | optionally some aggregations: 66 | 67 | ``` 68 | [ping] 69 | pattern = ^ping\. 70 | retentions = 1m:1d,5m:31d,60m:366d 71 | ``` 72 | 73 | At the top of the script, there are some configurable items: 74 | 75 | ``` 76 | # number of ping packets to send 77 | packets = 30 78 | 79 | # Graphite 80 | g_host = 'localhost' 81 | g_port = 2003 82 | g_prefix = 'ping' 83 | 84 | # System 85 | fping = '/usr/sbin/fping' 86 | logfile = '/tmp/ping-graphite.log' 87 | ``` 88 | 89 | If you want to run the program in the foreground instead of daemonized, search 90 | the program for a line that says 91 | 92 | ``` 93 | self.daemonize = True 94 | ``` 95 | 96 | and change the value to `False`. 97 | 98 | Usage 99 | ----- 100 | 101 | `./graphping [ ...]` 102 | 103 | License 104 | ------- 105 | 106 | Graphping is licensed under the Apache License, version 2.0. A copy of the 107 | license can be found in the 'COPYING' file and 108 | [on the web](http://www.apache.org/licenses/LICENSE-2.0). 109 | -------------------------------------------------------------------------------- /graphping: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # 3 | # Copyright 2013 Martijn Grendelman 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | 17 | """ 18 | Ping-graphite - send ping statistics for multiple hosts to Graphite 19 | 20 | Requires: fping, python-daemon 21 | """ 22 | 23 | import sys 24 | import os 25 | import signal 26 | import daemon 27 | import subprocess 28 | import re 29 | import logging 30 | import logging.handlers 31 | import errno 32 | import time 33 | import socket 34 | import datetime 35 | from pprint import pprint, pformat 36 | 37 | # number of ping packets to send 38 | packets = 30 39 | 40 | # Graphite 41 | g_host = 'localhost' 42 | g_port = 2003 43 | g_prefix = 'ping' 44 | 45 | # System 46 | fping = '/usr/sbin/fping' 47 | logfile = '/tmp/graphping.log' 48 | 49 | def handle_signal (sig, _frame): 50 | signals = dict((k, v) for v, k in signal.__dict__.iteritems() if v.startswith('SIG')) 51 | app.logger.info ("Received signal (%s)" % signals[sig]) 52 | 53 | if sig == signal.SIGUSR1: 54 | app.logger.warning("Setting log level to 'DEBUG'") 55 | app.logger.setLevel(logging.DEBUG) 56 | else: 57 | app.logger.warning ("Going to exit.") 58 | if app.ping: 59 | app.logger.warning("Terminating ping...") 60 | app.ping.terminate() 61 | app.ping.communicate() 62 | else: 63 | app.logger.warning("No ping running.") 64 | app.ping = False 65 | app.stop = True 66 | 67 | class StreamToLogger(object): 68 | """ 69 | Fake file-like stream object that redirects writes to a logger instance. 70 | """ 71 | def __init__(self, logger, log_level=logging.ERROR): 72 | self.logger = logger 73 | self.log_level = log_level 74 | self.linebuf = '' 75 | 76 | def write(self, buf): 77 | for line in buf.rstrip().splitlines(): 78 | self.logger.log(self.log_level, line.rstrip()) 79 | 80 | class App: 81 | 82 | def __init__(self): 83 | self.g_host = g_host 84 | self.g_port = g_port 85 | self.g_prefix = g_prefix 86 | self.logfile = logfile 87 | self.daemonize = True 88 | self.stop = False 89 | self.level = logging.INFO 90 | 91 | def setup_logging(self): 92 | os.umask(022) 93 | self.logger = logging.getLogger() 94 | self.logger.setLevel(self.level) 95 | formatter = logging.Formatter('%(asctime)s [%(process)d] %(levelname)s: %(message)s','%Y-%m-%d %H:%M:%S') 96 | try: 97 | loghandler = logging.handlers.WatchedFileHandler(self.logfile) 98 | except IOError: 99 | print "Could not open logfile (%s)" % self.logfile 100 | return False 101 | 102 | loghandler.setFormatter(formatter) 103 | self.logger.addHandler(loghandler) 104 | 105 | if self.daemonize == True: 106 | # Redirect stdout and stderr to logger, using StreamToLogger object that handles writes 107 | sys.stdout = StreamToLogger(self.logger, logging.INFO) 108 | sys.stderr = StreamToLogger(self.logger, logging.ERROR) 109 | 110 | else: 111 | # Set up a second loghandler, that writes to stderr 112 | loghandler2 = logging.StreamHandler(sys.stderr) 113 | loghandler2.setFormatter(formatter) 114 | self.logger.addHandler(loghandler2) 115 | 116 | return True 117 | 118 | def median(self, alist): 119 | srtd = sorted(alist) # returns a sorted copy 120 | mid = len(alist)/2 # remember that integer division truncates 121 | if len(alist) % 2 == 0: # take the avg of middle two 122 | return (srtd[mid-1] + srtd[mid]) / 2.0 123 | else: 124 | return srtd[mid] 125 | 126 | def process_options(self): 127 | self.targets = sys.argv[1:] 128 | if not self.targets: 129 | self.usage() 130 | 131 | def usage(self): 132 | print "Usage: ping-graphite [ ...]" 133 | sys.exit(2) 134 | 135 | def main(self): 136 | 137 | if self.setup_logging(): 138 | cmd = [ fping, '-c', str(packets) ] + self.targets 139 | 140 | while not self.stop: 141 | 142 | rtt = {} 143 | sry = {} 144 | for t in self.targets: 145 | rtt[t] = [] 146 | sry[t] = {} 147 | 148 | self.logger.info("Fpinging %d targets x %d packets" % (len(self.targets), packets)) 149 | self.ping = subprocess.Popen(cmd, bufsize=256, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) 150 | while not self.stop: 151 | # A USR1 signal causes an 'Interrupted system call' that we should 152 | # handle gracefully 153 | try: 154 | raw_line = self.ping.stdout.readline() 155 | except IOError, e: 156 | if e.errno == errno.EINTR: 157 | continue 158 | 159 | # If 'fping' is done/gone, terminate. This also catches a SIGINT. 160 | if raw_line == '': 161 | break 162 | 163 | l = raw_line.rstrip() 164 | 165 | # latinum : [0], 84 bytes, 6.46 ms (6.46 avg, 0% loss) 166 | m = re.match('([^ ]*)\s* : \[\d+\]+, \d+ bytes, (.*) ms', l) 167 | if m: 168 | #sys.stderr.write('.') 169 | #sys.stderr.flush() 170 | rtt[m.group(1)].append(float(m.group(2))) 171 | continue 172 | 173 | # latinum.isaac.local : xmt/rcv/%loss = 30/30/0%, min/avg/max = 5.99/6.30/6.67 174 | m = re.match('([^ ]*)\s* : xmt/rcv/%loss = \d+/\d+/(\d+)%, min/avg/max = (.*)/(.*)/(.*)', l) 175 | if m: 176 | #sys.stderr.write('*') 177 | #sys.stderr.flush() 178 | t = m.group(1) 179 | sry[t]['loss'] = int(m.group(2)) 180 | sry[t]['min'] = float(m.group(3)) 181 | sry[t]['avg'] = float(m.group(4)) 182 | sry[t]['max'] = float(m.group(5)) 183 | 184 | if self.ping: 185 | ret = self.ping.poll() 186 | if not ret is None: 187 | self.logger.info("Subprocess exited with status %d" % ret) 188 | self.ping.communicate() 189 | self.ping = False 190 | 191 | # Escape 192 | if self.stop: 193 | return 194 | 195 | # Process and send the results 196 | ts = time.time() 197 | s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 198 | s.connect((g_host, g_port)) 199 | 200 | for target,summary in sry.items(): 201 | safe_target = target.replace('.', '_') 202 | m_loss = self.g_prefix + '.' + safe_target + '.packetloss' 203 | m_median = self.g_prefix + '.' + safe_target + '.medianrtt' 204 | m_min = self.g_prefix + '.' + safe_target + '.minrtt' 205 | m_avg = self.g_prefix + '.' + safe_target + '.avgrtt' 206 | m_max = self.g_prefix + '.' + safe_target + '.maxrtt' 207 | 208 | try: 209 | self.logger.info("Sending data for %s. ts=%d => %s" % (safe_target, ts, 210 | datetime.datetime.fromtimestamp(ts).strftime('%Y-%m-%d %H:%M:%S'))) 211 | s.send("%s %d %d\n" % (m_loss, summary['loss'], ts)) 212 | s.send("%s %.2f %d\n" % (m_median, self.median(rtt[target]), ts)) 213 | s.send("%s %.2f %d\n" % (m_min, summary['min'], ts)) 214 | s.send("%s %.2f %d\n" % (m_avg, summary['avg'], ts)) 215 | s.send("%s %.2f %d\n" % (m_max, summary['max'], ts)) 216 | except Exception: 217 | self.logger.info("Could not send! Summary:") 218 | self.logger.info(pformat(summary)) 219 | 220 | s.close() 221 | 222 | # Wait for the next minute 223 | self.logger.info("Sleeping") 224 | m0 = time.strftime('%M') 225 | while time.strftime('%M') == m0 and not self.stop: 226 | time.sleep(3) 227 | 228 | return 229 | 230 | if __name__ == "__main__": 231 | 232 | app = App() 233 | app.process_options() 234 | 235 | if app.daemonize == True: 236 | context = daemon.DaemonContext() 237 | context.signal_map = { 238 | signal.SIGTERM: handle_signal, 239 | signal.SIGINT: handle_signal, 240 | signal.SIGUSR1: handle_signal 241 | } 242 | 243 | with context: 244 | app.main() 245 | app.logger.warning ("Done.") 246 | 247 | else: 248 | signal.signal (signal.SIGTERM, handle_signal) 249 | signal.signal (signal.SIGINT, handle_signal) 250 | signal.signal (signal.SIGUSR1, handle_signal) 251 | app.main() 252 | app.logger.warning ("Done.") 253 | --------------------------------------------------------------------------------