├── .gitignore ├── LICENSE ├── README.md ├── logger ├── __init__.py └── raven_logger.py ├── raven-bash └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | venv/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | 47 | # Translations 48 | *.mo 49 | *.pot 50 | 51 | # Django stuff: 52 | *.log 53 | 54 | # Sphinx documentation 55 | docs/_build/ 56 | 57 | # PyBuilder 58 | target/ 59 | 60 | # PyCharm 61 | .idea/ 62 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # raven-bash 2 | [![PyPi package version](https://badge.fury.io/py/raven-bash.png?v)](https://badge.fury.io/py/raven-bash) 3 | 4 | Raven Sentry client for Bash. 5 | 6 | Logs error if one of your commands exits with non-zero return code and produces simple traceback for easier debugging. It also tries to extract last values of the variables visible in the traceback. Environment variables and stderr output are also included. 7 | 8 | Bash does not provide much of the debugging capabilities known from the higher level languages so the capabilities are somewhat limited. However it works just fine for simple bash scripts used for deployment, monitoring, starting/stopping services, etc. 9 | 10 | This script is currently in working beta. Use at your own risk. Any contributions are highly appreciated. 11 | 12 | ![Sentry screenshot](https://upx.cz/yll8sbt7jsm991cssgoieb0akdpkl799lk3cea55) 13 | 14 | ## Installation 15 | ```shell 16 | pip install raven-bash 17 | ``` 18 | 19 | ## Usage 20 | 1. Create the file `/etc/raven-bash.conf` with the following content: 21 | ```ini 22 | [DEFAULT] 23 | 24 | # replace with your DSN 25 | SENTRY_DSN = https://key:secret@your_sentry_domain/project_id 26 | ``` 27 | Additionally you can use `SENTRY_DSN` environment variable which will override any settings defined in configuration file. 28 | 29 | 2. Add `source raven-bash` to the beginning of your bash scripts, e.g.: 30 | ```bash 31 | #!/bin/bash 32 | source raven-bash # sentry reporting 33 | 34 | echo "Hello world!" 35 | echo "This will produce an error" | grep "success" 36 | ``` 37 | Scripts you include using `source` or `.` will be monitored automatically. Any other scripts you execute won't be monitored unless you add `source raven-bash` to them. 38 | 39 | ## Caveats 40 | This script works only with `set -e` (enabled automatically) bash option which means that any command returning non-zero return code will produce an error and stop the execution. If some of your commands is returning non-zero return code and it is not an error you can prevent this from happening for example by piping it's output to `| true`. 41 | 42 | When running your scripts as cron jobs please be aware of possibly different `PATH` settings. `source raven-bash` will not work with incorrect `PATH`. This can be fixed by specifying environment variable in crontab, eg.: 43 | 44 | ```bash 45 | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin 46 | 47 | # m h dom mon dow command 48 | # your commands 49 | ``` 50 | 51 | ## Known bugs 52 | Will be hopefully fixed in one of the future releases. 53 | 54 | * **stderr output is discarded when your program exits correctly** 55 | * "traceback" works only for the last included file 56 | * Unrelated package versions are added to the request (this is due to `raven-python` which collects additional data from Python interpreter) 57 | -------------------------------------------------------------------------------- /logger/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ViktorStiskala/raven-bash/af523952d90c4838afa8c7536e6d1c4975c9eaa7/logger/__init__.py -------------------------------------------------------------------------------- /logger/raven_logger.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import re 3 | from collections import namedtuple 4 | import configparser 5 | import sys 6 | import os 7 | from raven import Client 8 | 9 | 10 | CONFIG_FILE = '/etc/raven-bash.conf' 11 | 12 | 13 | class RavenBashException(Exception): 14 | pass 15 | 16 | 17 | class LoggerClient: 18 | def __init__(self, dsn): 19 | self._client = Client(dsn=dsn, context={}) 20 | 21 | def _process_sourcefile(self, file_path, line_number, context_lines=10): 22 | FileContext = namedtuple('FileContext', ['pre_context', 'context', 'post_context', 'local_vars']) 23 | 24 | start = max(line_number - context_lines, 0) 25 | stop = line_number + context_lines 26 | 27 | pre_context = [] 28 | post_context = [] 29 | local_vars = [] 30 | context = None 31 | 32 | with open(file_path, 'r') as f: 33 | for i, line in enumerate(f): 34 | current_line = i + 1 35 | if current_line < start: 36 | continue 37 | elif current_line > stop: 38 | break 39 | 40 | # search for variable declaration 41 | var = re.match(r'^(?P[a-z]{1}\w*)=\S', line, re.IGNORECASE) 42 | if var: 43 | local_vars.append(var.group('name')) 44 | 45 | if current_line < line_number: 46 | pre_context.append(line.rstrip('\n')) 47 | elif current_line == line_number: 48 | context = line.rstrip('\n') 49 | else: 50 | post_context.append(line.rstrip('\n')) 51 | 52 | return FileContext(pre_context, context, post_context, local_vars) 53 | 54 | def _get_declares(self, declare_output, local_vars): 55 | """Parse `declare -p` output and get values from local variables""" 56 | out = {} 57 | for var in local_vars: 58 | m = re.search(r'^(?P' + re.escape(var) + r')=(?P\S.*)', declare_output, re.MULTILINE) 59 | if m: 60 | out[m.group('name')] = m.group('value') 61 | 62 | return out 63 | 64 | def capture(self, shell_args): 65 | frame = { 66 | 'filename': shell_args.script, 67 | 'function': shell_args.function or 'main', 68 | 'lineno': shell_args.lineno, 69 | 'module': shell_args.command, 70 | 'vars': {}, 71 | } 72 | 73 | if shell_args.pwd: 74 | abspath = os.path.abspath(os.path.join(shell_args.pwd, shell_args.script)) 75 | filename = os.path.basename(abspath) 76 | 77 | try: 78 | srcfile = self._process_sourcefile(abspath, shell_args.lineno) 79 | if shell_args.declares: 80 | frame['vars'] = self._get_declares(shell_args.declares, srcfile.local_vars) 81 | 82 | frame.update( 83 | filename=filename, 84 | abs_path=abspath, 85 | pre_context=srcfile.pre_context, 86 | context_line=srcfile.context, 87 | post_context=srcfile.post_context 88 | ) 89 | except FileNotFoundError: 90 | sys.stderr.write('Could not process file "{}"\n'.format(abspath)) 91 | 92 | exc_text = 'error on line {}'.format(shell_args.lineno) if not shell_args.function else "error in '{}' on line {}".format(shell_args.function, shell_args.lineno) 93 | data = { 94 | 'exception': { 95 | 'values': [{ 96 | 'module': 'builtins', 97 | 'stacktrace': { 98 | 'frames': [frame] 99 | }, 100 | 'type': shell_args.script, 101 | 'value': exc_text 102 | }] 103 | }, 104 | } 105 | 106 | # add ENV vars and stderr if provided 107 | extra = {} 108 | if shell_args.env: 109 | extra['environment'] = dict([item.split('=', 1) for item in shell_args.env.split('\n')]) 110 | 111 | if shell_args.stderr: 112 | extra['stderr'] = shell_args.stderr 113 | 114 | # Create dummy exc_info to satisfy newer versions of raven 115 | exc_info = (RavenBashException, RavenBashException(exc_text), None) 116 | self._client.capture('raven.events.Exception', data=data, extra=extra, exc_info=exc_info) 117 | 118 | 119 | def main(): 120 | try: 121 | dsn = os.environ['SENTRY_DSN'] 122 | except KeyError: 123 | config = configparser.ConfigParser() 124 | config.sections() 125 | config.read(CONFIG_FILE) 126 | 127 | dsn = config['DEFAULT'].get('SENTRY_DSN') 128 | 129 | if not dsn: 130 | sys.stderr.write('Missing SENTRY_DSN config from {}\n'.format(CONFIG_FILE)) 131 | sys.exit(1) 132 | 133 | parser = argparse.ArgumentParser(description='Send error to Sentry') 134 | 135 | parser.add_argument('--env', help='Script environment') 136 | parser.add_argument('--cmdline-args', help='Command line arguments') 137 | parser.add_argument('--stderr', help='Standard error output') 138 | parser.add_argument('--pwd', help='Working directory') 139 | parser.add_argument('--function', help='Error function') 140 | parser.add_argument('--declares', help='declare -p output') 141 | 142 | parser.add_argument('script', help='Source script') 143 | parser.add_argument('command', help='Error command') 144 | parser.add_argument('lineno', type=int, help='Error line number') 145 | 146 | args = parser.parse_args() 147 | 148 | client = LoggerClient(dsn) 149 | client.capture(args) 150 | 151 | 152 | if __name__ == '__main__': 153 | main() 154 | -------------------------------------------------------------------------------- /raven-bash: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | set -o errtrace 4 | 5 | STDERR_TEMPFILE=`mktemp -t "stderr.XXXXXX"` 6 | exec 4>&2 7 | exec 2>"$STDERR_TEMPFILE" 8 | 9 | logger_trap() { 10 | raven-logger "$1" "$3" "$2" --env "`env`" --stderr "`cat $STDERR_TEMPFILE`" --pwd "`pwd`" --function "$5" --declares "`declare -p`" > /dev/null 11 | cat "$STDERR_TEMPFILE" 1>&2 12 | rm -f "$STDERR_TEMPFILE" 13 | } 14 | 15 | trap 'exec 2>&4; logger_trap "$BASH_SOURCE" "$LINENO" "$BASH_COMMAND" "$*" "${FUNCNAME[0]}"' ERR 16 | trap 'rm -f "$STDERR_TEMPFILE"' EXIT SIGINT SIGQUIT SIGABRT SIGTERM 17 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from setuptools import setup 3 | 4 | long_description = '''\ 5 | Raven Sentry client for Bash. 6 | 7 | Logs error if one of your commands exits with non-zero return code and produces simple traceback for 8 | easier debugging. It also tries to extract last values of the variables visible in the traceback. 9 | Environment variables and stderr output are also included. 10 | 11 | For more information please visit project repo on GitHub: https://github.com/hareevs/raven-bash 12 | ''' 13 | 14 | install_requires = ['raven>=5.1.1'] 15 | if sys.version_info[:2] < (3, 0): 16 | install_requires.append('configparser') 17 | 18 | setup( 19 | name='raven-bash', 20 | version='1.0', 21 | description='Raven Sentry client for Bash.', 22 | long_description=long_description, 23 | classifiers=[ 24 | 'Development Status :: 4 - Beta', 25 | 'Intended Audience :: Developers', 26 | 'License :: OSI Approved :: Apache Software License', 27 | 'Programming Language :: Python :: 3 :: Only', 28 | 'Programming Language :: Python :: 3.4', 29 | ], 30 | keywords='raven sentry bash', 31 | author='Viktor Stiskala', 32 | author_email='viktor@stiskala.cz', 33 | url='https://github.com/hareevs/raven-bash', 34 | license='Apache License 2.0', 35 | install_requires=install_requires, 36 | packages=['logger'], 37 | package_data={'logger': ['raven-bash', 'logger/*.py']}, 38 | entry_points={ 39 | 'console_scripts': [ 40 | 'raven-logger=logger.raven_logger:main', 41 | ], 42 | }, 43 | scripts=['raven-bash'], 44 | zip_safe=False 45 | ) 46 | --------------------------------------------------------------------------------