diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..14aa7e6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# python caching/object code files +__pycache__/* +*.pyo +*.pyc + +#test input file +test.input + +# Connvitals libs +ping.py +traceroute.py +connvitals.py +connvitals +connvitals/* + +# Setuptools directories +build +dist +*.egg-info* + +# Sublime text files +*.sublime-* + +# Vim files +*.swp + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 [yyyy] [name of copyright owner] + + 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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..5a948ca --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,10 @@ +# License information +include LICENSE +include NOTICE + +# README in reStructuredText format +include README.rst + +# systemd Service file +include connmonitor.service + diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..09c5385 --- /dev/null +++ b/NOTICE @@ -0,0 +1,16 @@ +connvitals-monitor +Copyright 2018 Comcast Cable Communications Management, LLC + +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. + +This product includes software developed at Comcast (http://www.comcast.com/). diff --git a/README.md b/README.md new file mode 100644 index 0000000..37d1b70 --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ +# connvitals-monitor + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +Persistently monitors network conditions with respect to a set of specific hosts. + +## Dependencies +The executable for the connvitals-monitor package (`connmonitor`) runs on python3 (tested CPython 3.6.3) and requires a python3 interpreter. It also requires [connvitals](https://github.com/comcast/connvitals) to exist as a subdirectory in its directory (or your `import` path) as it uses that as a library. + +*Note: Because this package is not in a standard repository (nor is its dependency), dependencies cannot be automatically resolved; you must first install connvitals for this package to work.* + +## Installation +> *Note: Versions 1.2+ **only** support Linux systems that run systemd. It's possible that it may install on your system even if you do not run systemd, but it will attempt to install the Unit File under `/usr/lib/systemd/system`.* +### From This Repository with `pip` +The easiest way to install is to simply use `pip`. You can install directly from this repository without needing to manually download it by running +```bash +user@hostname ~ $ pip install git+https://github.com/comcast/connvitals-monitor.git#egg=connmonitor +``` +Note that you may need to run this command as root/with `sudo` or with `--user`, depending on your `pip` installation. Also ensure that `pip` is installing packages for Python 3.x. Typically, if both Python2 and Python3 exist on a system with `pip` installed for both, the `pip` to use for Python3 packages is accessible as `pip3`. + +### Manually +To install manually, first download or clone this repository. Then, in the directory you downloaded/cloned it into, run the command +```bash +user@hostname ~/connvitals-monitor $ python setup.py install +``` +Note that it's highly likely that you will need to run this command as root/with `sudo`. Also ensure that the `python` command points to a valid Python3 interpreter (you can check with `python --version`). On many systems, it is common for `python` to point to a Python2 interpreter. If you have both Python3 and Python2 installed, it's common that they be accessible as `python3` and `python2`, respectively. +Finally, if you are choosing this option because you do not have a Python3 `pip` installation, you may not have `setuptools` installed. On most 'nix distros, this can be installed without installing `pip` by running `sudo apt-get install python3-setuptools` (Debian/Ubuntu), `sudo pacman -S python3-setuptools` (Arch), `sudo yum install python3-setuptools` (RedHat/Fedora/CentOS), or `brew install python3-setuptools` (macOS with `brew` installed). + +## Usage +```bash +$ connmonitor [input file] +$ connmonitor [ -v --version ] +``` +`input file` is a file containing a set of options and hosts to check. If not specified, `connmonitor` will read input of the same format from `stdin`. If instead `-v` or `--version` is passed as the first argument, the program's version is printed to stdout, and the program exits successfully. +Upon receiving `SIGHUP` (e.g. when the terminal used to run it is closed), `connmonitor` will attempt to re-read its configuration file, then continue execution. If the configuration file cannot be read, the program will log an error, clean up its resources and exit with error code `1`. If input was given on `stdin`, the program will log an error and resume execution. +`connmonitor` handles `SIGTERM` by neatly cleaning up resources (finishing any running tasks and printing their output to `stdout`, still logging any errors) and exiting. + +### As a `systemd` daemon +Starting with version 1.2.1, connvitals-monitor (unfortunately) comes packaged with a systemd Unit File, and will attempt to install it. To run the daemon, simply run `systemctl start connmonitor` (as root), and to stop it run `systemctl stop connmonitor` (also as root). By default, the monitor will log its `stdout` in JSON format to `/var/log/connmonitor.log`, and its `stderr` to `/var/log/connmonitor.err`. Whenever the monitor is started, it looks for a configuration file at `/var/run/connmonitor.conf`, and creates it if it does not exist with the following default contents (see 'Input Format'): +``` +1 1 1 10 41 40 1 500 +localhost +``` +The monitor service does **not** check for filesystem updates to that config file; if you wish to edit it you may safely do so, but should run `systemctl reload connmonitor` to read in the new configuration. + +### Input Format +connmonitor expects input formatted like this: +``` +DOPINGS DOTRACE DOPSCAN NUMPINGS PAYLOAD HOPS JSON SLEEP +host1 +host2 +host3 +... +``` +where the fields have the following meanings +* `DOPINGS` is either `0` to indicate that pings should not be sent, or any other integer (typically `1`) to indicate that they should be sent. +* `DOTRACE` is either `0` to indicate that route tracing should not be done, or any other integer (typically `1`) to indicate they should be done. +* `DOPSCAN` is either `0` to indicate that port scanning should not be done, or any other integer (typically `1`) to indicate they should be done. +* `NUMPINGS` is a positive integer indicating the number of pings to be sent. If `DOPINGS` is `0`, this is not used, but **must still be specified**. Note that - in general - setting `NUMPINGS` to `0` is less efficient than setting `DOPINGS` to `0`. +* `PAYLOAD` is a positive integer indicating the size of each *ping* payload. If `DOPINGS` is `0`, this is not used, but **must still be specified**. It is recommended that this be at least 14. +* `HOPS` is a positive integer that sets the maximum number of network hops to be considered in route tracing. If `DOTRACE` is `0`, this is not used, but **must still be specified**. It is recommended that this be at least 15 for testing hosts that are not on LAN. Note that - in general - setting `HOPS` to `0` is less efficient than setting `DOTRACE` to `0`. +* `JSON` is either `0` to indicate that output should not be formatted as JSON, or any other integer (typically `1`) to indicate that output *should* be formatted as JSON. +* `SLEEP` is the amount of time for the process to "sleep" between queries of its hosts (in milliseconds). + + +### Output Format +`connmonitor` outputs results to `stdout` and logs errors to `stderr`. Output (including JSON output) takes the same form as connvitals, and you can read about that format on [that project](https://github.com/comcast/connvitals)'s README. + +Starting with version 3.0, `connmonitor` will no longer output traces if they are determined to be the same as the most recent route previously recorded for a given host. This is as a result of changes made to connvitals (but only the Python version) which are discussed in greater detail on [that project's page](https://github.com/comcast/connvitals). + + +### Example +Here's an example of a configuration file that will gather port scans and ping statistics for 10 pings per run each having a payload of 1337B - but not route traces - from google.com, github.com and the address 127.0.0.1 (localhost) every half-second and outputs in connvitals's standard, plain-text format: +``` +1 0 1 10 1337 100 0 500 +google.com +github.com +127.0.0.1 +``` diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..cacbf78 --- /dev/null +++ b/README.rst @@ -0,0 +1,194 @@ +connvitals-monitor +================== + +|License| + +Persistently monitors network conditions with respect to a set of +specific hosts. + +Dependencies +------------ + +The executable for the connvitals-monitor package (``connmonitor``) runs +on python3 (tested CPython 3.6.3) and requires a python3 interpreter. It +also requires `connvitals `__ to +exist as a subdirectory in its directory (or your ``import`` path) as it +uses that as a library. + +*Note: Because this package is not in a standard repository (nor is its +dependency), dependencies cannot be automatically resolved; you must +first install connvitals for this package to work.* + +Installation +------------ + + *Note: Versions 1.2+ **only** support Linux systems that run + systemd. It's possible that it may install on your system even if + you do not run systemd, but it will attempt to install the Unit File + under ``/usr/lib/systemd/system``.* + +From This Repository with ``pip`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The easiest way to install is to simply use ``pip``. You can install +directly from this repository without needing to manually download it by +running + +.. code:: bash + + user@hostname ~ $ pip install git+https://github.com/comcast/connvitals-monitor.git#egg=connmonitor + +Note that you may need to run this command as root/with ``sudo`` or with +``--user``, depending on your ``pip`` installation. Also ensure that +``pip`` is installing packages for Python 3.x. Typically, if both +Python2 and Python3 exist on a system with ``pip`` installed for both, +the ``pip`` to use for Python3 packages is accessible as ``pip3``. + +Manually +~~~~~~~~ + +To install manually, first download or clone this repository. Then, in +the directory you downloaded/cloned it into, run the command + +.. code:: bash + + user@hostname ~/connvitals-monitor $ python setup.py install + +| Note that it's highly likely that you will need to run this command as + root/with ``sudo``. Also ensure that the ``python`` command points to + a valid Python3 interpreter (you can check with ``python --version``). + On many systems, it is common for ``python`` to point to a Python2 + interpreter. If you have both Python3 and Python2 installed, it's + common that they be accessible as ``python3`` and ``python2``, + respectively. +| Finally, if you are choosing this option because you do not have a + Python3 ``pip`` installation, you may not have ``setuptools`` + installed. On most 'nix distros, this can be installed without + installing ``pip`` by running + ``sudo apt-get install python3-setuptools`` (Debian/Ubuntu), + ``sudo pacman -S python3-setuptools`` (Arch), + ``sudo yum install python3-setuptools`` (RedHat/Fedora/CentOS), or + ``brew install python3-setuptools`` (macOS with ``brew`` installed). + +Usage +----- + +.. code:: bash + + $ connmonitor [input file] + $ connmonitor [ -v --version ] + +| ``input file`` is a file containing a set of options and hosts to + check. If not specified, ``connmonitor`` will read input of the same + format from ``stdin``. If instead ``-v`` or ``--version`` is passed as + the first argument, the program's version is printed to stdout, and + the program exits successfully. +| Upon receiving ``SIGHUP`` (e.g. when the terminal used to run it is + closed), ``connmonitor`` will attempt to re-read its configuration + file, then continue execution. If the configuration file cannot be + read, the program will log an error, clean up its resources and exit + with error code ``1``. If input was given on ``stdin``, the program + will log an error and resume execution. +| ``connmonitor`` handles ``SIGTERM`` by neatly cleaning up resources + (finishing any running tasks and printing their output to ``stdout``, + still logging any errors) and exiting. + +As a ``systemd`` daemon +~~~~~~~~~~~~~~~~~~~~~~~ + +Starting with version 1.2.1, connvitals-monitor (unfortunately) comes +packaged with a systemd Unit File, and will attempt to install it. To +run the daemon, simply run ``systemctl start connmonitor`` (as root), +and to stop it run ``systemctl stop connmonitor`` (also as root). By +default, the monitor will log its ``stdout`` in JSON format to +``/var/log/connmonitor.log``, and its ``stderr`` to +``/var/log/connmonitor.err``. Whenever the monitor is started, it looks +for a configuration file at ``/var/run/connmonitor.conf``, and creates +it if it does not exist with the following default contents (see 'Input +Format'): + +:: + + 1 1 1 10 41 40 1 500 + localhost + +The monitor service does **not** check for filesystem updates to that +config file; if you wish to edit it you may safely do so, but should run +``systemctl reload connmonitor`` to read in the new configuration. + +Input Format +~~~~~~~~~~~~ + +connmonitor expects input formatted like this: + +:: + + DOPINGS DOTRACE DOPSCAN NUMPINGS PAYLOAD HOPS JSON SLEEP + host1 + host2 + host3 + ... + +where the fields have the following meanings + +- ``DOPINGS`` is either ``0`` to indicate that pings should not be + sent, or any other integer (typically ``1``) to indicate that they + should be sent. +- ``DOTRACE`` is either ``0`` to indicate that route tracing should not + be done, or any other integer (typically ``1``) to indicate they + should be done. +- ``DOPSCAN`` is either ``0`` to indicate that port scanning should not + be done, or any other integer (typically ``1``) to indicate they + should be done. +- ``NUMPINGS`` is a positive integer indicating the number of pings to + be sent. If ``DOPINGS`` is ``0``, this is not used, but **must still + be specified**. Note that - in general - setting ``NUMPINGS`` to + ``0`` is less efficient than setting ``DOPINGS`` to ``0``. +- ``PAYLOAD`` is a positive integer indicating the size of each *ping* + payload. If ``DOPINGS`` is ``0``, this is not used, but **must still + be specified**. It is recommended that this be at least 14. +- ``HOPS`` is a positive integer that sets the maximum number of + network hops to be considered in route tracing. If ``DOTRACE`` is + ``0``, this is not used, but **must still be specified**. It is + recommended that this be at least 15 for testing hosts that are not + on LAN. Note that - in general - setting ``HOPS`` to ``0`` is less + efficient than setting ``DOTRACE`` to ``0``. +- ``JSON`` is either ``0`` to indicate that output should not be + formatted as JSON, or any other integer (typically ``1``) to indicate + that output *should* be formatted as JSON. +- ``SLEEP`` is the amount of time for the process to "sleep" between + queries of its hosts (in milliseconds). + +Output Format +~~~~~~~~~~~~~ + +``connmonitor`` outputs results to ``stdout`` and logs errors to +``stderr``. Output (including JSON output) takes the same form as +connvitals, and you can read about that format on `that +project `__'s README. + +Starting with version 3.0, ``connmonitor`` will no longer output traces +if they are determined to be the same as the most recent route +previously recorded for a given host. This is as a result of changes +made to connvitals (but only the Python version) which are discussed in +greater detail on `that project's +page `__. + +Example +~~~~~~~ + +Here's an example of a configuration file that will gather port scans +and ping statistics for 10 pings per run each having a payload of 1337B +- but not route traces - from google.com, github.com and the address +127.0.0.1 (localhost) every half-second and outputs in connvitals's +standard, plain-text format: + +:: + + 1 0 1 10 1337 100 0 500 + google.com + github.com + 127.0.0.1 + +.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg + :target: https://opensource.org/licenses/Apache-2.0 diff --git a/connmonitor.service b/connmonitor.service new file mode 100644 index 0000000..ae583f8 --- /dev/null +++ b/connmonitor.service @@ -0,0 +1,38 @@ +# Copyright 2018 Comcast Cable Communications Management, LLC + +# 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. + +[Unit] +Description=A presistent monitor that logs network connectivity statistics. +Documentation=https://github.com/comcast/connvitals-monitor +AssertCapability=CAP_NET_BIND_SERVICE +AssertFileIsExecutable=|/bin/connmonitor +AssertFileIsExecutable=|/usr/bin/connmonitor +AssertPathIsDirectory=/var/run +AssertPathIsDirectory=/var/log + +[Service] +Type=simple + +# Before Starting, sets up a configuration file if none exists +ExecStartPre=/bin/bash -c 'if [[ ! -f /var/run/connmonitor.conf ]]; then /usr/bin/printf "1 1 1 10 41 40 1 500\nlocalhost\n" > /var/run/connmonitor.conf; fi' + +# Logs the output +ExecStart=/bin/bash -c 'exec /usr/bin/connmonitor /var/run/connmonitor.conf 1>/var/log/connmonitor.log 2>/var/log/connmonitor.err' + +# This should be all it takes to reload configuration files +ExecReload=/bin/kill -s SIGHUP $MAINPID + +# Safely terminates the process, explicitly sending SIGTERM +KillSignal=SIGTERM +SendSigKill=no diff --git a/connmonitor/__init__.py b/connmonitor/__init__.py new file mode 100755 index 0000000..f932d6e --- /dev/null +++ b/connmonitor/__init__.py @@ -0,0 +1,39 @@ +# Copyright 2018 Comcast Cable Communications Management, LLC + +# 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. + + +""" +A tool that persistently monitors network conditions with respect to a set of specific hosts +""" + +__author__ = "Brennan W. Fieck" + +__version__ = "3.0.3" + +import sys + +def main(): + """ + Runs the main connmonitor script + """ + if len(sys.argv) > 1 and sys.argv[1] in {'-V', '--version'}: + print("python3-connmonitor Version %s" % __version__) + exit() + + import connvitals.config + from .connmonitor import main as main_func + try: + return main_func() + except KeyboardInterrupt: + return 1 diff --git a/connmonitor/connmonitor.py b/connmonitor/connmonitor.py new file mode 100755 index 0000000..c3521cb --- /dev/null +++ b/connmonitor/connmonitor.py @@ -0,0 +1,215 @@ +# Copyright 2018 Comcast Cable Communications Management, LLC + +# 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. + +""" +A monitor for connection vitals, based on the connvitals program. +""" +import sys +import signal +import time +import multiprocessing +from connvitals import utils, config, collector, ports, traceroute + +collectors, confFile, SLEEP, printFunc = [], None, -1, lambda x: print(x, flush=True) + +def hangup(unused_sig: int, unused_frame: object): + """ + Handles the SIGHUP signal by re-reading conf files (if available) and resuming execution + """ + global confFile, collectors + + # Signal to the threads to stop + for collector in collectors: + collector.pipe[0].send(True) + + # Wait for the threads to exit + for collector in collectors: + collector.join() + + # Re-read the input file if exists + # If it doesn't, print an error and go about your business + if not confFile: + utils.error(IOError("No input file to read! (input given on stdin)")) + else: + readConf() + + for collector in collectors: + collector.start() + + raise ContinueException() + +def terminate(unused_sig: int, unused_frame: object): + """ + Handles the SIGTERM signal by cleaning up resources and flushing output pipes. + """ + global collectors + + # signal to the threads to stop + for c in collectors: + if c is not None: + c.terminate() + + # wait for the threads to exit + for c in collectors: + if c is not None: + c.join() + + raise KeyboardInterrupt + +def main() -> int: + """ + Runs the main routine, returning an exit status indicating successful termination + """ + global confFile, collectors + + signal.signal(signal.SIGHUP, hangup) + signal.signal(signal.SIGTERM, terminate) + + # Construct a persistent monitor based on argv + if len(sys.argv) > 1: + confFile = sys.argv[1] + + readConf() + + + def loopedRun(self: 'collector.Collector'): + """ + This function replaces `Collector.run`, by simply calling the old `.run` repeatedly + """ + global printFunc, SLEEP, collector + + + with multiprocessing.pool.ThreadPool() as pool: + try: + while True: + time.sleep(SLEEP / 1000) + + if config.PORTSCAN: + pscanResult = pool.apply_async(ports.portScan, + (self.host, pool), + error_callback = utils.error) + if config.TRACE: + traceResult = pool.apply_async(traceroute.trace, + (self.host,), + error_callback = utils.error) + + if not config.NOPING: + try: + self.ping(pool) + except (multiprocessing.TimeoutError, ValueError): + self.result[0] = type(self).result[0] + if config.TRACE: + try: + self.result[1] = traceResult.get(config.HOPS) + except multiprocessing.TimeoutError: + self.result[1] = type(self).result[1] + if config.PORTSCAN: + try: + self.result[2] = pscanResult.get(0.5) + except multiprocessing.TimeoutError: + self.result[2] = type(self).result[2] + + printFunc(self) + except KeyboardInterrupt: + pass + except Exception as e: + utils.error(e, 1) + + # Replace Collector.run + collector.Collector.run = loopedRun + + # Start the collectors + for c in collectors: + c.start() + + # The main thread just checks to see that all of the sub-threads are still going, and handles + # exceptions. + try: + while True: + try: + time.sleep(0.5) + if not collectors or not any(c.is_alive() for c in collectors): + return 1 + except ContinueException: + pass + + except KeyboardInterrupt: + for c in collectors: + c.pipe[0].send(True) + for c in collectors: + c.join() + except Exception as e: + utils.error(e) + return 1 + return 0 + +def readConf(): + """ + Reads a configuration file. Expects a file object, which can be a true + file or a pipe such as stdin + """ + global collectors, confFile, SLEEP, printFunc + + # Try to open config file if exists, fatal error if file pointed to + # Does not/no longer exist(s) + if confFile: + try: + file = open(confFile) + except OSError as e: + utils.error(FileNotFoundError("Couldn't read input file '%s'"%e), fatal=True) + hosts = file.read().strip().split("\n") + file.close() + + # Closing stdin can cause huge problems, esp. for e.g. debuggers + else: + hosts = sys.stdin.read().strip().split("\n") + + # You need to clear this, or the monitor will keep querying old hosts. + collectors = [] + + #parse args + try: + args = [int(arg) for arg in hosts.pop(0).strip().split(" ")] + config.NOPING = args[0] == 0 + config.TRACE = args[1] != 0 + config.PORTSCAN = args[2] != 0 + config.NUMPINGS = args[3] + config.PAYLOAD = args[4] + config.HOPS = args[5] + config.JSON = args[6] != 0 + SLEEP = args[7] + except (IndexError, ValueError) as e: + utils.error(IOError("Bad configuration file format, caused error: (%s)" % e), True) + + if config.JSON: + printFunc = lambda x: print(repr(x), flush=True) + + #collect host names and valid ip addresses + for host in hosts: + addrinfo = utils.getaddr(host) + if not addrinfo: + utils.error(Exception("Unable to resolve host ( %s )" % host)) + sys.stderr.flush() + else: + config.HOSTS[host] = addrinfo + collectors.append(collector.Collector(host)) + + if not config.HOSTS: + utils.error(Exception("No hosts could be parsed!"), fatal=True) + +class ContinueException(Exception): + """ + An exception whose only purpose is to tell the main thread to continue execution + """ + pass diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..006945d --- /dev/null +++ b/setup.py @@ -0,0 +1,229 @@ +#!/usr/bin/env python3 + +# Copyright 2018 Comcast Cable Communications Management, LLC + +# 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. + + +"""A setuptools based setup module. +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +# To use a consistent encoding +import codecs +import os + +# RPMs generated for fedora/rhel/centos need to have a different name +# (debian/ubuntu automatically prepends python3-, but those do not) +import platform + +# Always prefer setuptools over distutils +from setuptools import setup, find_packages + +pkgname = "connmonitor" +depname = "connvitals" + +# I know this is deprecated, but it's the only way to get this information afaik +distname = platform.linux_distribution(full_distribution_name=False)[0] +if distname in {'centos', 'fedora', 'redhat'}: + pkgname = "python3-"+pkgname + depname = "python3-"+depname +elif not distname: + from sys import stderr + print("\033[38;2;255;0;0mconnvitals-monitor ONLY works on compatible *nix \ +distributions - '%s' is not supported.\033[38;2;255;255;255m" % platform.system(), file=stderr) + exit(1) + +here = os.path.abspath(os.path.dirname(__file__)) + +# Get the long description from the README file +with codecs.open(os.path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +# Arguments marked as "Required" below must be included for upload to PyPI. +# Fields marked as "Optional" may be commented out. + +setup( + # This is the name of your project. The first time you publish this + # package, this name will be registered for you. It will determine how + # users can install this project, e.g.: + # + # $ pip install sampleproject + # + # And where it will live on PyPI: https://pypi.org/project/sampleproject/ + # + # There are some restrictions on what makes a valid project name + # specification here: + # https://packaging.python.org/specifications/core-metadata/#name + name=pkgname, # Required + + # Versions should comply with PEP 440: + # https://www.python.org/dev/peps/pep-0440/ + # + # For a discussion on single-sourcing the version across setup.py and the + # project code, see + # https://packaging.python.org/en/latest/single_source_version.html + version='3.0.3', # Required + + # This is a one-line description or tagline of what your project does. This + # corresponds to the "Summary" metadata field: + # https://packaging.python.org/specifications/core-metadata/#summary + description=\ + 'Uses the connvitals library to continuously poll and record network connectivity statistics.', + + # This is an optional longer description of your project that represents + # the body of text which users will see when they visit PyPI. + # + # Often, this is the same as your README, so you can just read it in from + # that file directly (as we have already done above) + # + # This field corresponds to the "Description" metadata field: + # https://packaging.python.org/specifications/core-metadata/#description-optional + long_description=long_description, # Optional + + # This should be a valid link to your project's main homepage. + # + # This field corresponds to the "Home-Page" metadata field: + # https://packaging.python.org/specifications/core-metadata/#home-page-optional + url='https://github.com/comcast/connvitals-monitor', # Optional + + # This should be your name or the name of the organization which owns the + # project. + author='Brennan Fieck', # Optional + + # This should be a valid email address corresponding to the author listed + # above. + author_email='Brennan_WilliamFieck@comcast.com', # Optional + + # Classifiers help users find your project by categorizing it. + # + # For a list of valid classifiers, see + # https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ # Optional + # How mature is this project? Common values are + # 3 - Alpha + # 4 - Beta + # 5 - Production/Stable + 'Development Status :: 5 - Production/Stable', + + # Indicate who your project is intended for + 'Intended Audience :: Telecommunications Industry', + 'Intended Audience :: Developers', + 'Intended Audience :: Information Technology', + + # Topic of the project + 'Topic :: Internet', + 'Topic :: Internet :: Log Analysis', + 'Topic :: Internet :: WWW/HTTP', + 'Topic :: Scientific/Engineering :: Information Analysis', + 'Topic :: System :: Logging', + 'Topic :: System :: Monitoring', + 'Topic :: System :: Networking :: Monitoring', + 'Topic :: System :: Networking :: Monitoring :: Hardware Watchdog', + 'Topic :: Utilities', + + # Pick your license as you wish + 'License :: OSI Approved :: Apache Software License', + + # Environment in which this program is designed to run + 'Environment :: No Input/Output (Daemon)', + 'Environment :: Console', + + # Supported Operating Systems + 'Operating Systems :: POSIX :: Linux', + + # Specify the Python versions you support here. In particular, ensure + # that you indicate whether you support Python 2, Python 3 or both. + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy' + 'Programming Language :: Python :: 3 :: Only' + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7' + ], + + # This field adds keywords for your project which will appear on the + # project page. What does your project relate to? + # + # Note that this is a string of words separated by whitespace, not a list. + keywords='network statistics connection ping traceroute port ip', # Optional + + # You can just specify package directories manually here if your project is + # simple. Or you can use find_packages(). + # + # Alternatively, if you just want to distribute a single Python file, use + # the `py_modules` argument instead as follows, which will expect a file + # called `my_module.py` to exist: + # + # + packages=find_packages(exclude=['contrib', 'docs', 'tests']), # Required + + # This field lists other packages that your project depends on to run. + # Any package you put here will be installed by pip when your project is + # installed, so they must be valid existing projects. + # + # For an analysis of "install_requires" vs pip's requirements files see: + # https://packaging.python.org/en/latest/requirements.html + install_requires=[depname, 'setuptools', 'typing'], # Optional + + # List additional groups of dependencies here (e.g. development + # dependencies). Users will be able to install these using the "extras" + # syntax, for example: + # + # $ pip install sampleproject[dev] + # + # Similar to `install_requires` above, these must be valid existing + # projects. + # extras_require={ # Optional + # 'dev': ['check-manifest'], + # 'test': ['coverage'], + # }, + + # If there are data files included in your packages that need to be + # installed, specify them here. + # + # If using Python 2.6 or earlier, then these have to be included in + # MANIFEST.in as well. + # package_data={ # Optional + # 'connmonitor': ['package_data.dat'], + # }, + + # Although 'package_data' is the preferred approach, in some case you may + # need to place data files outside of your packages. See: + # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files + # + # In this case, 'data_file' will be installed into '/my_data' + data_files=[('/usr/lib/systemd/system', ['connmonitor.service'])], # Optional + + # To provide executable scripts, use entry points in preference to the + # "scripts" keyword. Entry points provide cross-platform support and allow + # `pip` to create the appropriate form of executable for the target + # platform. + # + # For example, the following would provide a command called `sample` which + # executes the function `main` from this package when invoked: + entry_points={ # Optional + 'console_scripts': [ + 'connmonitor=connmonitor:main', + ], + }, + + # Runs our post-installation script to install the service + # cmdclass={'install': installService}, + + # Requires python version >= 3.4, but doesn't support python 4 + python_requires='~=3.4' +)